class DisplayExtenderTest

Same name in this branch

Defines a display extender test plugin.

Plugin annotation


@Plugin(
  id = "display_extender_test",
  title = @Translation("Display extender test")
)

Hierarchy

Expanded class hierarchy of DisplayExtenderTest

File

drupal/core/modules/views/tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/display_extender/DisplayExtenderTest.php, line 22
Definition of Drupal\views_test_data\Plugin\views\display_extender\DisplayExtenderTest.

Namespace

Drupal\views_test_data\Plugin\views\display_extender
View source
class DisplayExtenderTest extends DisplayExtenderPluginBase {

  /**
   * Stores some state booleans to be sure a certain method got called.
   *
   * @var array
   */
  public $testState;

  /**
   * Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::defineOptionsAlter().
   */
  public function defineOptionsAlter(&$options) {
    $options['test_extender_test_option'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary().
   */
  public function optionsSummary(&$categories, &$options) {
    parent::optionsSummary($categories, $options);
    $categories['display_extender_test'] = array(
      'title' => t('Display extender test settings'),
      'column' => 'second',
      'build' => array(
        '#weight' => -100,
      ),
    );
    $test_option = $this->displayHandler
      ->getOption('test_extender_test_option') ?: t('Empty');
    $options['test_extender_test_option'] = array(
      'category' => 'display_extender_test',
      'title' => t('Test option'),
      'value' => views_ui_truncate($test_option, 24),
    );
  }

  /**
   * Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, &$form_state) {
    switch ($form_state['section']) {
      case 'test_extender_test_option':
        $form['#title'] .= t('Test option');
        $form['test_extender_test_option'] = array(
          '#type' => 'textfield',
          '#description' => t('This is a textfield for test_option.'),
          '#default_value' => $this->displayHandler
            ->getOption('test_extender_test_option'),
        );
    }
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::submitOptionsForm().
   */
  public function submitOptionsForm(&$form, &$form_state) {
    parent::submitOptionsForm($form, $form_state);
    switch ($form_state['section']) {
      case 'test_extender_test_option':
        $this->displayHandler
          ->setOption('test_extender_test_option', $form_state['values']['test_extender_test_option']);
        break;
    }
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::defaultableSections().
   */
  public function defaultableSections(&$sections, $section = NULL) {
    $sections['test_extender_test_option'] = array(
      'test_extender_test_option',
    );
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::query().
   */
  public function query() {
    $this->testState['query'] = TRUE;
  }

  /**
   * Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::pre_execute().
   */
  public function pre_execute() {
    $this->testState['pre_execute'] = TRUE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DisplayExtenderPluginBase::init public function
DisplayExtenderPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
DisplayExtenderTest::$testState public property Stores some state booleans to be sure a certain method got called.
DisplayExtenderTest::buildOptionsForm public function Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::buildOptionsForm(). Overrides DisplayExtenderPluginBase::buildOptionsForm
DisplayExtenderTest::defaultableSections public function Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::defaultableSections(). Overrides DisplayExtenderPluginBase::defaultableSections
DisplayExtenderTest::defineOptionsAlter public function Overrides Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase::defineOptionsAlter(). Overrides DisplayExtenderPluginBase::defineOptionsAlter
DisplayExtenderTest::optionsSummary public function Overrides Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary(). Overrides DisplayExtenderPluginBase::optionsSummary
DisplayExtenderTest::pre_execute public function Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::pre_execute(). Overrides DisplayExtenderPluginBase::pre_execute
DisplayExtenderTest::query public function Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::query(). Overrides DisplayExtenderPluginBase::query
DisplayExtenderTest::submitOptionsForm public function Overrides Drupal\views\Plugin\views\display\DisplayExtenderPluginBase::submitOptionsForm(). Overrides DisplayExtenderPluginBase::submitOptionsForm
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( 14
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct