protected function EntityRouteEnhancer::enhanceEntityView in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php \Drupal\Core\Entity\Enhancer\EntityRouteEnhancer::enhanceEntityView()
2. 9 core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php \Drupal\Core\Entity\Enhancer\EntityRouteEnhancer::enhanceEntityView()

Update defaults for an entity view.

Parameters

array $defaults: The defaults to modify.

\Symfony\Component\HttpFoundation\Request $request: The Request instance.

Return value

array The modified defaults.

Throws

\RuntimeException Thrown when an entity of a type cannot be found in a route.

1 call to EntityRouteEnhancer::enhanceEntityView()

EntityRouteEnhancer::enhance in core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php

Updates the defaults for a route definition based on the request.

File

core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php, line 104

Class

EntityRouteEnhancer

Enhances an entity form route with the appropriate controller.

Namespace

Drupal\Core\Entity\Enhancer

Code

protected function enhanceEntityView(array $defaults, Request $request) {
  $defaults['_controller'] = '\\Drupal\\Core\\Entity\\Controller\\EntityViewController::view';
  if (strpos($defaults['_entity_view'], '.') !== FALSE) {

    // The _entity_view entry is of the form entity_type.view_mode.
    [
      $entity_type,
      $view_mode,
    ] = explode('.', $defaults['_entity_view']);
    $defaults['view_mode'] = $view_mode;
  }
  else {

    // Only the entity type is nominated, the view mode will use the
    // default.
    $entity_type = $defaults['_entity_view'];
  }

  // Set by reference so that we get the upcast value.
  if (!empty($defaults[$entity_type])) {
    $defaults['_entity'] =& $defaults[$entity_type];
  }
  else {

    // The entity is not keyed by its entity_type. Attempt to find it
    // using a converter.
    $route = $defaults[RouteObjectInterface::ROUTE_OBJECT];
    if ($route && is_object($route)) {
      $options = $route
        ->getOptions();
      if (isset($options['parameters'])) {
        foreach ($options['parameters'] as $name => $details) {
          if (!empty($details['type'])) {
            $type = $details['type'];

            // Type is of the form entity:{entity_type}.
            $parameter_entity_type = substr($type, strlen('entity:'));
            if ($entity_type == $parameter_entity_type) {

              // We have the matching entity type. Set the '_entity' key
              // to point to this named placeholder. The entity in this
              // position is the one being rendered.
              $defaults['_entity'] =& $defaults[$name];
            }
          }
        }
      }
      else {
        throw new \RuntimeException(sprintf('Failed to find entity of type %s in route named %s', $entity_type, $defaults[RouteObjectInterface::ROUTE_NAME]));
      }
    }
    else {
      throw new \RuntimeException(sprintf('Failed to find entity of type %s in route named %s', $entity_type, $defaults[RouteObjectInterface::ROUTE_NAME]));
    }
  }
  unset($defaults['_entity_view']);
  return $defaults;
}