AccessibleInterface.php
Same filename in other branches
Namespace
Drupal\Core\AccessFile
-
core/
lib/ Drupal/ Core/ Access/ AccessibleInterface.php
View source
<?php
namespace Drupal\Core\Access;
use Drupal\Core\Session\AccountInterface;
/**
* Interface for checking access.
*
* @ingroup entity_api
*/
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);
}
Interfaces
Title | Deprecated | Summary |
---|---|---|
AccessibleInterface | Interface for checking access. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.