public function RouteEnhancer::enhance in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/jsonapi/src/Routing/RouteEnhancer.php \Drupal\jsonapi\Routing\RouteEnhancer::enhance()
2. 10 core/modules/jsonapi/src/Routing/RouteEnhancer.php \Drupal\jsonapi\Routing\RouteEnhancer::enhance()

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

Parameters

array $defaults: The defaults, maps to '_defaults' in the route definition YAML.

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

Return value

array The modified defaults. Each enhancer MUST return the $defaults but may add or remove values.

Overrides EnhancerInterface::enhance

File

core/modules/jsonapi/src/Routing/RouteEnhancer.php, line 23

Class

RouteEnhancer

Ensures the loaded entity matches the requested resource type.

Namespace

Drupal\jsonapi\Routing

Code

public function enhance(array $defaults, Request $request) {
  if (!Routes::isJsonApiRequest($defaults)) {
    return $defaults;
  }
  $resource_type = Routes::getResourceTypeNameFromParameters($defaults);
  $entity_type_id = $resource_type
    ->getEntityTypeId();
  if (!isset($defaults[$entity_type_id]) || !($entity = $defaults[$entity_type_id])) {
    return $defaults;
  }
  $retrieved_bundle = $entity
    ->bundle();
  $configured_bundle = $resource_type
    ->getBundle();
  if ($retrieved_bundle != $configured_bundle) {

    // If the bundle in the loaded entity does not match the bundle in the
    // route (which is set based on the corresponding ResourceType), then
    // throw an exception.
    throw new NotFoundHttpException(sprintf('The loaded entity bundle (%s) does not match the configured resource (%s).', $retrieved_bundle, $configured_bundle));
  }
  return $defaults;
}