You are here

abstract class AccessPluginBase in Views (for Drupal 7) 8.3

The base plugin to handle access control.

Hierarchy

Expanded class hierarchy of AccessPluginBase

Related topics

4 files declare their use of AccessPluginBase
DynamicTest.php in tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/access/DynamicTest.php
Definition of Drupal\views_test_data\Plugin\views\access\DynamicTest.
Permission.php in lib/Views/user/Plugin/views/access/Permission.php
Definition of Views\user\Plugin\views\access\Permission.
Role.php in lib/Views/user/Plugin/views/access/Role.php
Definition of Views\user\Plugin\views\access\Role.
StaticTest.php in tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/access/StaticTest.php
Definition of Drupal\views_test_data\Plugin\views\access\StaticTest.

File

lib/Drupal/views/Plugin/views/access/AccessPluginBase.php, line 25
Definition of Drupal\views\Plugin\views\access\AccessPluginBase.

Namespace

Drupal\views\Plugin\views\access
View source
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();

}

Members

Namesort descending Modifiers Type Description Overrides
AccessPluginBase::access abstract public function Determine if the current user has access or not. 5
AccessPluginBase::buildOptionsForm public function Provide the default form for setting options. Overrides PluginBase::buildOptionsForm 2
AccessPluginBase::defineOptions protected function Retrieve the options when this is a new access control plugin Overrides PluginBase::defineOptions 4
AccessPluginBase::get_access_callback abstract function Determine the access callback and arguments. 5
AccessPluginBase::init public function Initialize the plugin.
AccessPluginBase::submitOptionsForm public function Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm 1
AccessPluginBase::summaryTitle public function Return a string to display as the clickable title for the access control. Overrides PluginBase::summaryTitle 3
AccessPluginBase::validateOptionsForm public function Provide the default form form for validating options Overrides PluginBase::validateOptionsForm 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::query public function Add anything to the query that we might need to. 13
PluginBase::setOptionDefaults protected function
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2