class DisplayExtenderTest in Drupal 10
Same name in this branch
- 10 core/modules/views/tests/src/Kernel/Plugin/DisplayExtenderTest.php \Drupal\Tests\views\Kernel\Plugin\DisplayExtenderTest
- 10 core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest.php \Drupal\views_test_data\Plugin\views\display_extender\DisplayExtenderTest
Same name and namespace in other branches
- 8 core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest.php \Drupal\views_test_data\Plugin\views\display_extender\DisplayExtenderTest
- 9 core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest.php \Drupal\views_test_data\Plugin\views\display_extender\DisplayExtenderTest
Defines a display extender test plugin.
Plugin annotation
@ViewsDisplayExtender(
id = "display_extender_test",
title = @Translation("Display extender test")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase
- class \Drupal\views_test_data\Plugin\views\display_extender\DisplayExtenderTest
- class \Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DisplayExtenderTest
1 file declares its use of DisplayExtenderTest
- DisplayExtenderTest.php in core/
modules/ views/ tests/ src/ Kernel/ Plugin/ DisplayExtenderTest.php
File
- core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ display_extender/ DisplayExtenderTest.php, line 16
Namespace
Drupal\views_test_data\Plugin\views\display_extenderView source
class DisplayExtenderTest extends DisplayExtenderPluginBase {
/**
* Stores some state booleans to be sure a certain method got called.
*
* @var array
*/
public $testState;
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['test_extender_test_option'] = [
'default' => $this
->t('Empty'),
];
return $options;
}
/**
* {@inheritdoc}
*/
public function optionsSummary(&$categories, &$options) {
parent::optionsSummary($categories, $options);
$categories['display_extender_test'] = [
'title' => $this
->t('Display extender test settings'),
'column' => 'second',
'build' => [
'#weight' => -100,
],
];
$options['test_extender_test_option'] = [
'category' => 'display_extender_test',
'title' => $this
->t('Test option'),
'value' => views_ui_truncate($this->options['test_extender_test_option'], 24),
];
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
switch ($form_state
->get('section')) {
case 'test_extender_test_option':
$form['#title'] .= $this
->t('Test option');
$form['test_extender_test_option'] = [
'#title' => $this
->t('Test option'),
'#type' => 'textfield',
'#description' => $this
->t('This is a textfield for test_option.'),
'#default_value' => $this->options['test_extender_test_option'],
];
}
}
/**
* {@inheritdoc}
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
parent::submitOptionsForm($form, $form_state);
switch ($form_state
->get('section')) {
case 'test_extender_test_option':
$this->options['test_extender_test_option'] = $form_state
->getValue('test_extender_test_option');
break;
}
}
/**
* {@inheritdoc}
*/
public function defaultableSections(&$sections, $section = NULL) {
$sections['test_extender_test_option'] = [
'test_extender_test_option',
];
}
/**
* {@inheritdoc}
*/
public function query() {
$this->testState['query'] = TRUE;
}
/**
* {@inheritdoc}
*/
public function preExecute() {
$this->testState['preExecute'] = TRUE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
DisplayExtenderPluginBase:: |
public | function | Provide a form to edit options for this plugin. | |
DisplayExtenderPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
|
DisplayExtenderTest:: |
public | property | Stores some state booleans to be sure a certain method got called. | |
DisplayExtenderTest:: |
public | function |
Provide a form to edit options for this plugin. Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Static member function to list which sections are defaultable
and what items each section contains. Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides PluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Provide the default summary for options in the views UI. Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Set up any variables on the view prior to execution. Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Inject anything into the query that the display_extender handler needs. Overrides DisplayExtenderPluginBase:: |
|
DisplayExtenderTest:: |
public | function |
Handle any special handling on the validate form. Overrides DisplayExtenderPluginBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 6 |
PluginBase:: |
public | property | The top object of a view. | |
PluginBase:: |
public | function | 4 | |
PluginBase:: |
public static | function | 7 | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function | 1 | |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
protected | function | Returns the render API renderer. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | ||
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function | ||
PluginBase:: |
public static | function | ||
PluginBase:: |
public static | function | ||
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | 3 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public static | function | 1 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 6 | |
PluginBase:: |
public | function | 2 | |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
PluginBase:: |
public | function | Constructs a PluginBase object. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. |