The fixed argument default handler; also used as the base.
Expanded class hierarchy of ArgumentDefaultPluginBase
abstract class ArgumentDefaultPluginBase extends PluginBase {
/**
* Return the default argument.
*
* This needs to be overridden by every default argument handler to properly do what is needed.
*/
function get_argument() {
}
/**
* Initialize this plugin with the view and the argument
* it is linked to.
*/
public function init(ViewExecutable $view, &$argument, $options) {
$this
->setOptionDefaults($this->options, $this
->defineOptions());
$this->view =& $view;
$this->argument =& $argument;
$this
->unpackOptions($this->options, $options);
}
/**
* 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, &$form_state) {
}
/**
* Provide the default form form for validating options
*/
public function validateOptionsForm(&$form, &$form_state) {
}
/**
* Provide the default form form for submitting options
*/
public function submitOptionsForm(&$form, &$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.
*/
function check_access(&$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>' . 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>';
}
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ArgumentDefaultPluginBase:: |
function | Return the default argument. | 8 | |
ArgumentDefaultPluginBase:: |
public | function | Initialize this plugin with the view and the argument it is linked to. | 1 |
ArgumentDefaultPluginBase:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides PluginBase:: |
6 |
ArgumentDefaultPluginBase:: |
public | function |
Provide the default form for setting options. Overrides PluginBase:: |
5 |
ArgumentDefaultPluginBase:: |
public | function |
Provide the default form form for validating options Overrides PluginBase:: |
|
ArgumentDefaultPluginBase:: |
public | function |
Provide the default form form for submitting options Overrides PluginBase:: |
1 |
ArgumentDefaultPluginBase:: |
public | function | Determine if the administrator has the privileges to use this plugin | 1 |
ArgumentDefaultPluginBase:: |
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. | ||
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Add anything to the query that we might need to. | 13 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |