Tests a static access plugin.
@Plugin(
id = "test_static",
title = @Translation("Static test access plugin"),
help = @Translation("Provides a static test access plugin.")
)
Expanded class hierarchy of StaticTest
class StaticTest extends AccessPluginBase {
protected function defineOptions() {
$options = parent::defineOptions();
$options['access'] = array(
'default' => FALSE,
'bool' => TRUE,
);
return $options;
}
public function access(AccountInterface $account) {
return !empty($this->options['access']);
}
/**
* {@inheritdoc}
*/
public function alterRouteDefinition(Route $route) {
if (!empty($this->options['access'])) {
$route
->setRequirement('_access', 'TRUE');
}
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessPluginBase:: |
public | function |
Provide the default form for setting options. Overrides PluginBase:: |
2 |
AccessPluginBase:: |
public | function |
Provide the default form form for submitting options Overrides PluginBase:: |
1 |
AccessPluginBase:: |
public | function |
Return a string to display as the clickable title for the
access control. Overrides PluginBase:: |
3 |
AccessPluginBase:: |
public | function |
Provide the default form form for validating options Overrides PluginBase:: |
1 |
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
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 | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Initialize the plugin. | 8 |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Add anything to the query that we might need to. | 13 |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
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 | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
StaticTest:: |
public | function |
Determine if the current user has access or not. Overrides AccessPluginBase:: |
|
StaticTest:: |
public | function |
Allows access plugins to alter the route definition of a view. Overrides AccessPluginBase:: |
|
StaticTest:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides AccessPluginBase:: |