class views_plugin_display_extender

@todo.

Hierarchy

Expanded class hierarchy of views_plugin_display_extender

Related topics

2 string references to 'views_plugin_display_extender'

File

plugins/views_plugin_display_extender.inc, line 13
Definition of views_plugin_display_extender.

View source
class views_plugin_display_extender extends views_plugin {
  function init(&$view, &$display) {
    $this->view = $view;
    $this->display = $display;
  }


  /**
   * Provide a form to edit options for this plugin.
   */
  function options_definition_alter(&$options) {
  }

  /**
   * Provide a form to edit options for this plugin.
   */
  function options_form(&$form, &$form_state) {
  }

  /**
   * Validate the options form.
   */
  function options_validate(&$form, &$form_state) {
  }

  /**
   * Handle any special handling on the validate form.
   */
  function options_submit(&$form, &$form_state) {
  }

  /**
   * Set up any variables on the view prior to execution.
   */
  function pre_execute() {
  }

  /**
   * Inject anything into the query that the display_extender handler needs.
   */
  function query() {
  }

  /**
   * Provide the default summary for options in the views UI.
   *
   * This output is returned as an array.
   */
  function options_summary(&$categories, &$options) {
  }

  /**
   * Static member function to list which sections are defaultable
   * and what items each section contains.
   */
  function defaultable_sections(&$sections, $section = NULL) {
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::destroy function
views_object::export_option function
views_object::export_options function
views_object::export_option_always function Always exports the option, regardless of the default value.
views_object::options Deprecated function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::option_definition function Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::plugin_title function Return the human readable name of the display.
views_plugin::summary_title function Returns the summary of the settings in the display.
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin::validate function Validate that the plugin is correct and can be saved.
views_plugin_display_extender::defaultable_sections function Static member function to list which sections are defaultable and what items each section contains.
views_plugin_display_extender::init function
views_plugin_display_extender::options_definition_alter function Provide a form to edit options for this plugin.
views_plugin_display_extender::options_form function Provide a form to edit options for this plugin. Overrides views_plugin::options_form
views_plugin_display_extender::options_submit function Handle any special handling on the validate form. Overrides views_plugin::options_submit
views_plugin_display_extender::options_summary function Provide the default summary for options in the views UI.
views_plugin_display_extender::options_validate function Validate the options form. Overrides views_plugin::options_validate
views_plugin_display_extender::pre_execute function Set up any variables on the view prior to execution.
views_plugin_display_extender::query function Inject anything into the query that the display_extender handler needs. Overrides views_plugin::query