abstract class AccessPluginBase

DisplayUnitTest.php in drupal/core/modules/views/lib/Drupal/views/Tests/Plugin/DisplayUnitTest.php

Contains \Drupal\views\Tests\Plugin\DisplayUnitTest.

Permission.php in drupal/core/modules/user/lib/Drupal/user/Plugin/views/access/Permission.php

Definition of Drupal\user\Plugin\views\access\Permission.

Role.php in drupal/core/modules/user/lib/Drupal/user/Plugin/views/access/Role.php

Definition of Drupal\user\Plugin\views\access\Role.

StaticTest.php in drupal/core/modules/views/tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/access/StaticTest.php

Definition of Drupal\views_test_data\Plugin\views\access\StaticTest.

abstract class AccessPluginBase extends PluginBase {

  /**
   * 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\Core\Session\AccountInterface $account
   *   The user who wants to access this view.
   *
   * @return TRUE
   *   Returns whether the user has access to the view.
   */
  public abstract function access(AccountInterface $account);

  /**
   * Allows access plugins to alter the route definition of a view.
   *
   * Likely the access plugin will add new requirements, so its custom access
   * checker can be applied.
   *
   * @param \Symfony\Component\Routing\Route $route
   *   The route to change.
   */
  public abstract function alterRouteDefinition(Route $route);

}