function FormModeAccessCheck::access
Same name in other branches
- 8.9.x core/modules/field_ui/src/Access/FormModeAccessCheck.php \Drupal\field_ui\Access\FormModeAccessCheck::access()
- 10 core/modules/field_ui/src/Access/FormModeAccessCheck.php \Drupal\field_ui\Access\FormModeAccessCheck::access()
- 11.x core/modules/field_ui/src/Access/FormModeAccessCheck.php \Drupal\field_ui\Access\FormModeAccessCheck::access()
Checks access to the form mode.
Parameters
\Symfony\Component\Routing\Route $route: The route to check against.
\Drupal\Core\Routing\RouteMatchInterface $route_match: The parametrized route.
\Drupal\Core\Session\AccountInterface $account: The currently logged in account.
string $form_mode_name: (optional) The form mode. Defaults to 'default'.
string $bundle: (optional) The bundle. Different entity types can have different names for their bundle key, so if not specified on the route via a {bundle} parameter, the access checker determines the appropriate key name, and gets the value from the corresponding request attribute. For example, for nodes, the bundle key is "node_type", so the value would be available via the {node_type} parameter rather than a {bundle} parameter.
Return value
\Drupal\Core\Access\AccessResultInterface The access result.
File
-
core/
modules/ field_ui/ src/ Access/ FormModeAccessCheck.php, line 59
Class
- FormModeAccessCheck
- Defines an access check for entity form mode routes.
Namespace
Drupal\field_ui\AccessCode
public function access(Route $route, RouteMatchInterface $route_match, AccountInterface $account, $form_mode_name = 'default', $bundle = NULL) {
$access = AccessResult::neutral();
if ($entity_type_id = $route->getDefault('entity_type_id')) {
if (empty($bundle)) {
$entity_type = $this->entityTypeManager
->getDefinition($entity_type_id);
$bundle = $route_match->getRawParameter($entity_type->getBundleEntityType());
}
$visibility = FALSE;
if ($form_mode_name == 'default') {
$visibility = TRUE;
}
elseif ($entity_display = $this->entityTypeManager
->getStorage('entity_form_display')
->load($entity_type_id . '.' . $bundle . '.' . $form_mode_name)) {
$visibility = $entity_display->status();
}
if ($form_mode_name != 'default' && $entity_display) {
$access->addCacheableDependency($entity_display);
}
if ($visibility) {
$permission = $route->getRequirement('_field_ui_form_mode_access');
$access = $access->orIf(AccessResult::allowedIfHasPermission($account, $permission));
}
}
return $access;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.