class views_plugin_display_extender
@todo .
Hierarchy
- class \views_object
- class \views_plugin extends \views_object
- class \views_plugin_display_extender extends \views_plugin
- class \views_plugin extends \views_object
Expanded class hierarchy of views_plugin_display_extender
Related topics
2 string references to 'views_plugin_display_extender'
- views_plugin_display::init in plugins/
views_plugin_display.inc - views_views_plugins in includes/
plugins.inc - Implements hook_views_plugins().
File
-
plugins/
views_plugin_display_extender.inc, line 13
View source
class views_plugin_display_extender extends views_plugin {
/**
* {@inheritdoc}
*/
public function init(&$view, &$display) {
$this->view = $view;
$this->display = $display;
}
/**
* Provide a form to edit options for this plugin.
*/
public function options_definition_alter(&$options) {
}
/**
* Provide a form to edit options for this plugin.
*/
public function options_form(&$form, &$form_state) {
}
/**
* Validate the options form.
*/
public function options_validate(&$form, &$form_state) {
}
/**
* Handle any special handling on the validate form.
*/
public function options_submit(&$form, &$form_state) {
}
/**
* Set up any variables on the view prior to execution.
*/
public function pre_execute() {
}
/**
* Inject anything into the query that the display_extender handler needs.
*/
public function query() {
}
/**
* Provide the default summary for options in the views UI.
*
* This output is returned as an array.
*/
public function options_summary(&$categories, &$options) {
}
/**
* Static member function to list which sections are defaultable
* and what items each section contains.
*/
public function defaultable_sections(&$sections, $section = NULL) {
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
views_object::$definition | public | property | Handler's definition. | |||
views_object::$options | public | property | Except for displays, options for the object will be held here. | 1 | ||
views_object::altered_option_definition | public | function | Collect this handler's option definition and alter them, ready for use. | |||
views_object::construct | public | function | Views handlers use a special construct function. | 4 | ||
views_object::destroy | public | function | Destructor. | 2 | ||
views_object::export_option | public | function | 1 | |||
views_object::export_options | public | function | ||||
views_object::export_option_always | public | function | Always exports the option, regardless of the default value. | |||
views_object::options | Deprecated | public | function | Set default options on this object. | 1 | |
views_object::option_definition | public | function | Information about options for all kinds of purposes will be held here. | 13 | ||
views_object::set_default_options | public | function | Set default options. | |||
views_object::set_definition | public | function | Let the handler know what its full definition is. | |||
views_object::unpack_options | public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. |
|||
views_object::unpack_translatable | public | function | Unpack a single option definition. | |||
views_object::unpack_translatables | public | function | Unpacks each handler to store translatable texts. | |||
views_object::_set_option_defaults | public | function | ||||
views_plugin::$display | public | property | The current used views display. | |||
views_plugin::$plugin_name | public | property | The plugin name of this plugin, for example table or full. | |||
views_plugin::$plugin_type | public | property | The plugin type of this plugin, for example style or query. | |||
views_plugin::$view | public | property | The top object of a view. | Overrides views_object::$view | 1 | |
views_plugin::additional_theme_functions | public | function | Provide a list of additional theme functions for the theme info page. | |||
views_plugin::plugin_title | public | function | Return the human readable name of the display. | |||
views_plugin::summary_title | public | function | Returns the summary of the settings in the display. | 8 | ||
views_plugin::theme_functions | public | function | Provide a full list of possible theme templates used by this style. | |||
views_plugin::validate | public | function | Validate that the plugin is correct and can be saved. | 3 | ||
views_plugin_display_extender::defaultable_sections | public | function | Static member function to list which sections are defaultable and what items each section contains. |
|||
views_plugin_display_extender::init | public | function | ||||
views_plugin_display_extender::options_definition_alter | public | function | Provide a form to edit options for this plugin. | |||
views_plugin_display_extender::options_form | public | function | Provide a form to edit options for this plugin. | Overrides views_plugin::options_form | ||
views_plugin_display_extender::options_submit | public | function | Handle any special handling on the validate form. | Overrides views_plugin::options_submit | ||
views_plugin_display_extender::options_summary | public | function | Provide the default summary for options in the views UI. | |||
views_plugin_display_extender::options_validate | public | function | Validate the options form. | Overrides views_plugin::options_validate | ||
views_plugin_display_extender::pre_execute | public | function | Set up any variables on the view prior to execution. | |||
views_plugin_display_extender::query | public | function | Inject anything into the query that the display_extender handler needs. | Overrides views_plugin::query |