interface AccessibleInterface in Zircon Profile 8

Interface for checking access.

Hierarchy

• interface \Drupal\Core\Access\AccessibleInterface

Related topics

Entity API

Describes how to define and manipulate content and configuration entities.

6 files declare their use of AccessibleInterface

EntityAccessControlHandlerTest.php in core/modules/system/src/Tests/Entity/EntityAccessControlHandlerTest.php

Contains \Drupal\system\Tests\Entity\EntityAccessControlHandlerTest.

EntityInterface.php in core/lib/Drupal/Core/Entity/EntityInterface.php

Contains \Drupal\Core\Entity\EntityInterface.

FieldItemListInterface.php in core/lib/Drupal/Core/Field/FieldItemListInterface.php

Contains \Drupal\Core\Field\FieldItemListInterface.

NodeSearch.php in core/modules/node/src/Plugin/Search/NodeSearch.php

Contains \Drupal\node\Plugin\Search\NodeSearch.

SearchPageAccessControlHandler.php in core/modules/search/src/SearchPageAccessControlHandler.php

Contains \Drupal\search\SearchPageAccessControlHandler.

... See full list

File

core/lib/Drupal/Core/Access/AccessibleInterface.php, line 17

Contains \Drupal\Core\Access\AccessibleInterface.

Namespace

Drupal\Core\Access

interface AccessibleInterface {

  /**
   * Checks data value access.
   *
   * @param string $operation
   *   The operation to be performed.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   (optional) The user for which to check access, or NULL to check access
   *   for the current user. Defaults to NULL.
   * @param bool $return_as_object
   *   (optional) Defaults to FALSE.
   *
   * @return bool|\Drupal\Core\Access\AccessResultInterface
   *   The access result. Returns a boolean if $return_as_object is FALSE (this
   *   is the default) and otherwise an AccessResultInterface object.
   *   When a boolean is returned, the result of AccessInterface::isAllowed() is
   *   returned, i.e. TRUE means access is explicitly allowed, FALSE means
   *   access is either explicitly forbidden or "no opinion".
   */
  public function access($operation, AccountInterface $account = NULL, $return_as_object = FALSE);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	5