The base plugin to handle access control.
Expanded class hierarchy of AccessPluginBase
abstract class AccessPluginBase extends PluginBase {
/**
* Initialize the plugin.
*
* @param $view
* The view object.
* @param $display
* The display handler.
*/
public function init(ViewExecutable $view, &$display, $options = NULL) {
$this
->setOptionDefaults($this->options, $this
->defineOptions());
$this->view =& $view;
$this->displayHandler =& $display;
$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) {
}
/**
* Return a string to display as the clickable title for the
* access control.
*/
public function summaryTitle() {
return t('Unknown');
}
/**
* Determine if the current user has access or not.
*
* @param Drupal\user\User $account
* The user who wants to access this view.
*
* @return TRUE
* Returns whether the user has access to the view.
*/
public abstract function access($account);
/**
* Determine the access callback and arguments.
*
* This information will be embedded in the menu in order to reduce
* performance hits during menu item access testing, which happens
* a lot.
*
* @return array
* The first item of the array should be the function to call,and the
* second item should be an array of arguments. The first item may also be
* TRUE (bool only) which will indicate no access control.
*/
abstract function get_access_callback();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessPluginBase:: |
abstract public | function | Determine if the current user has access or not. | 5 |
AccessPluginBase:: |
public | function |
Provide the default form for setting options. Overrides PluginBase:: |
2 |
AccessPluginBase:: |
protected | function |
Retrieve the options when this is a new access
control plugin Overrides PluginBase:: |
4 |
AccessPluginBase:: |
abstract | function | Determine the access callback and arguments. | 5 |
AccessPluginBase:: |
public | function | Initialize the plugin. | |
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 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
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_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 | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). 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 | 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 | ||
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:: |