summaryrefslogtreecommitdiff
path: root/kolab.org/www/drupal-7.15/sites/all/modules/views/plugins/views_plugin_display_extender.inc
blob: c2cc488b261d172b5bf51e691edc084aa5aa1f0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<?php
/**
 * @todo
 */
class views_plugin_display_extender extends views_plugin {
  function __construct(&$view, &$display) {
    $this->view = $view;
    $this->display = $display;
  }


  /**
   * Provide a form to edit options for this plugin.
   */
  function options_definition(&$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) { }
}