abstract class ArgumentDefaultPluginBase in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php \Drupal\views\Plugin\views\argument_default\ArgumentDefaultPluginBase
The fixed argument default handler; also used as the base.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\argument_default\ArgumentDefaultPluginBase
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of ArgumentDefaultPluginBase
Related topics
5 files declare their use of ArgumentDefaultPluginBase
- ArgumentDefaultTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ argument_default/ ArgumentDefaultTest.php - Contains \Drupal\views_test_data\Plugin\views\argument_default\ArgumentDefaultTest.
- CurrentUser.php in core/
modules/ user/ src/ Plugin/ views/ argument_default/ CurrentUser.php - Contains \Drupal\user\Plugin\views\argument_default\CurrentUser.
- Node.php in core/
modules/ node/ src/ Plugin/ views/ argument_default/ Node.php - Contains \Drupal\node\Plugin\views\argument_default\Node.
- Tid.php in core/
modules/ taxonomy/ src/ Plugin/ views/ argument_default/ Tid.php - Contains \Drupal\taxonomy\Plugin\views\argument_default\Tid.
- User.php in core/
modules/ user/ src/ Plugin/ views/ argument_default/ User.php - Contains \Drupal\user\Plugin\views\argument_default\User.
File
- core/
modules/ views/ src/ Plugin/ views/ argument_default/ ArgumentDefaultPluginBase.php, line 36 - Contains \Drupal\views\Plugin\views\argument_default\ArgumentDefaultPluginBase.
Namespace
Drupal\views\Plugin\views\argument_defaultView source
abstract class ArgumentDefaultPluginBase extends PluginBase {
/**
* The argument handler instance associated with this plugin.
*
* @var \Drupal\views\Plugin\views\argument\ArgumentPluginBase
*/
protected $argument;
/**
* Return the default argument.
*
* This needs to be overridden by every default argument handler to properly do what is needed.
*/
public function getArgument() {
}
/**
* Sets the parent argument this plugin is associated with.
*
* @param \Drupal\views\Plugin\views\argument\ArgumentPluginBase $argument
* The parent argument to set.
*/
public function setArgument(ArgumentPluginBase $argument) {
$this->argument = $argument;
}
/**
* Retrieve the options when this is a new access
* control plugin
*/
protected function defineOptions() {
return array();
}
/**
* Provide the default form for setting options.
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
}
/**
* Provide the default form form for validating options
*/
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
}
/**
* Provide the default form form for submitting options
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state, &$options = array()) {
}
/**
* Determine if the administrator has the privileges to use this
* plugin
*/
public function access() {
return TRUE;
}
/**
* If we don't have access to the form but are showing it anyway, ensure that
* the form is safe and cannot be changed from user input.
*
* This is only called by child objects if specified in the buildOptionsForm(),
* so it will not always be used.
*/
protected function checkAccess(&$form, $option_name) {
if (!$this
->access()) {
$form[$option_name]['#disabled'] = TRUE;
$form[$option_name]['#value'] = $form[$this->option_name]['#default_value'];
$form[$option_name]['#description'] .= ' <strong>' . $this
->t('Note: you do not have permission to modify this. If you change the default filter type, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
}
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ArgumentDefaultPluginBase:: |
protected | property | The argument handler instance associated with this plugin. | |
ArgumentDefaultPluginBase:: |
public | function | Determine if the administrator has the privileges to use this plugin | |
ArgumentDefaultPluginBase:: |
public | function |
Provide the default form for setting options. Overrides PluginBase:: |
5 |
ArgumentDefaultPluginBase:: |
protected | function | If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input. | |
ArgumentDefaultPluginBase:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides PluginBase:: |
6 |
ArgumentDefaultPluginBase:: |
public | function | Return the default argument. | 8 |
ArgumentDefaultPluginBase:: |
public | function | ||
ArgumentDefaultPluginBase:: |
public | function | Sets the parent argument this plugin is associated with. | |
ArgumentDefaultPluginBase:: |
public | function |
Provide the default form form for submitting options Overrides PluginBase:: |
1 |
ArgumentDefaultPluginBase:: |
public | function |
Provide the default form form for validating options Overrides PluginBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
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. | 2 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
20 |
PluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
50 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function |
Initialize the plugin. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides ViewsPluginInterface:: |
8 |
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 |
Returns the summary of the settings in the display. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface:: |
5 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
PluginBase:: |
public | function |
Constructs a PluginBase object. Overrides PluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
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. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |