function FieldUpdateActionBase::access

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldUpdateActionBase.php \Drupal\Core\Field\FieldUpdateActionBase::access()
  2. 8.9.x core/lib/Drupal/Core/Field/FieldUpdateActionBase.php \Drupal\Core\Field\FieldUpdateActionBase::access()
  3. 11.x core/lib/Drupal/Core/Field/FieldUpdateActionBase.php \Drupal\Core\Field\FieldUpdateActionBase::access()

Checks object access.

Parameters

mixed $object: The object to execute the action on.

\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.

bool $return_as_object: (optional) Defaults to FALSE.

Return value

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".

Overrides ActionInterface::access

File

core/lib/Drupal/Core/Field/FieldUpdateActionBase.php, line 51

Class

FieldUpdateActionBase
Provides a base for action plugins that update one or more fields.

Namespace

Drupal\Core\Field

Code

public function access($object, ?AccountInterface $account = NULL, $return_as_object = FALSE) {
    
    /** @var \Drupal\Core\Access\AccessResultInterface $result */
    $result = $object->access('update', $account, TRUE);
    foreach ($this->getFieldsToUpdate() as $field => $value) {
        $result = $result->andIf($object->{$field}
            ->access('edit', $account, TRUE));
    }
    return $return_as_object ? $result : $result->isAllowed();
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.