You are here

class views_plugin in Views (for Drupal 7) 6.2

Same name and namespace in other branches
  1. 6.3 includes/plugins.inc \views_plugin
  2. 7.3 includes/plugins.inc \views_plugin

Abstract base class to provide interface common to all plugins.

Hierarchy

Expanded class hierarchy of views_plugin

File

includes/plugins.inc, line 348
plugins.inc Built in plugins for Views output handling.

View source
class views_plugin extends views_object {

  /**
   * Init will be called after construct, when the plugin is attached to a
   * view and a display.
   */
  function init(&$view, &$display) {
    $this->view =& $view;
    $this->display =& $display;
  }

  /**
   * 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) {
  }

  /**
   * Add anything to the query that we might need to.
   */
  function query() {
  }

  /**
   * Provide a full list of possible theme templates used by this style.
   */
  function theme_functions() {
    return views_theme_functions($this->definition['theme'], $this->view, $this->display);
  }

  /**
   * Provide a list of additional theme functions for the theme information page
   */
  function additional_theme_functions() {
    $funcs = array();
    if (!empty($this->definition['additional themes'])) {
      foreach ($this->definition['additional themes'] as $theme => $type) {
        $funcs[] = views_theme_functions($theme, $this->view, $this->display);
      }
    }
    return $funcs;
  }

  /**
   * Validate that the plugin is correct and can be saved.
   *
   * @return
   *   An array of error strings to tell the user what is wrong with this
   *   plugin.
   */
  function validate() {
    return array();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_object::$options property Except for displays, options for the object will be held here. 1
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments. 5
views_object::destroy function 2
views_object::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. 1
views_object::option_definition function Information about options for all kinds of purposes will be held here. 9
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::_set_option_defaults function 1
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::init function Init will be called after construct, when the plugin is attached to a view and a display. 7
views_plugin::options_form function Provide a form to edit options for this plugin. 5
views_plugin::options_submit function Handle any special handling on the validate form. 3
views_plugin::options_validate function Validate the options form. 3
views_plugin::query function Add anything to the query that we might need to. 3
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. 2