class ViewModeAccessCheck
Same name in other branches
- 8.9.x core/modules/field_ui/src/Access/ViewModeAccessCheck.php \Drupal\field_ui\Access\ViewModeAccessCheck
- 10 core/modules/field_ui/src/Access/ViewModeAccessCheck.php \Drupal\field_ui\Access\ViewModeAccessCheck
- 11.x core/modules/field_ui/src/Access/ViewModeAccessCheck.php \Drupal\field_ui\Access\ViewModeAccessCheck
Defines an access check for entity view mode routes.
Hierarchy
- class \Drupal\field_ui\Access\ViewModeAccessCheck implements \Drupal\Core\Routing\Access\AccessInterface
Expanded class hierarchy of ViewModeAccessCheck
See also
\Drupal\Core\Entity\Entity\EntityViewMode
1 string reference to 'ViewModeAccessCheck'
- field_ui.services.yml in core/
modules/ field_ui/ field_ui.services.yml - core/modules/field_ui/field_ui.services.yml
1 service uses ViewModeAccessCheck
- access_check.field_ui.view_mode in core/
modules/ field_ui/ field_ui.services.yml - Drupal\field_ui\Access\ViewModeAccessCheck
File
-
core/
modules/ field_ui/ src/ Access/ ViewModeAccessCheck.php, line 17
Namespace
Drupal\field_ui\AccessView source
class ViewModeAccessCheck implements AccessInterface {
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* Creates a new ViewModeAccessCheck.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
*/
public function __construct(EntityTypeManagerInterface $entity_type_manager) {
$this->entityTypeManager = $entity_type_manager;
}
/**
* Checks access to the view mode.
*
* @param \Symfony\Component\Routing\Route $route
* The route to check against.
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The parametrized route.
* @param \Drupal\Core\Session\AccountInterface $account
* The currently logged in account.
* @param string $view_mode_name
* (optional) The view mode. Defaults to 'default'.
* @param 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 \Drupal\Core\Access\AccessResultInterface
* The access result.
*/
public function access(Route $route, RouteMatchInterface $route_match, AccountInterface $account, $view_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 ($view_mode_name == 'default') {
$visibility = TRUE;
}
elseif ($entity_display = $this->entityTypeManager
->getStorage('entity_view_display')
->load($entity_type_id . '.' . $bundle . '.' . $view_mode_name)) {
$visibility = $entity_display->status();
}
if ($view_mode_name != 'default' && $entity_display) {
$access->addCacheableDependency($entity_display);
}
if ($visibility) {
$permission = $route->getRequirement('_field_ui_view_mode_access');
$access = $access->orIf(AccessResult::allowedIfHasPermission($account, $permission));
}
}
return $access;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
ViewModeAccessCheck::$entityTypeManager | protected | property | The entity type manager. |
ViewModeAccessCheck::access | public | function | Checks access to the view mode. |
ViewModeAccessCheck::__construct | public | function | Creates a new ViewModeAccessCheck. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.