protected function DefaultHtmlRouteProvider::getCollectionRoute

Gets the collection route.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type.

Return value

\Symfony\Component\Routing\Route|null The generated route, if available.

File

core/lib/Drupal/Core/Entity/Routing/DefaultHtmlRouteProvider.php, line 318

Class

DefaultHtmlRouteProvider

Provides HTML routes for entities.

Namespace

Code

protected function getCollectionRoute(EntityTypeInterface $entity_type) {

  // If the entity type does not provide either an admin or collection
  // permission, there is no way to control access, so we cannot provide
  // a route in a sensible way.
  $permissions = array_filter([
    $entity_type
      ->getAdminPermission(),
    $entity_type
      ->getCollectionPermission(),
  ]);
  if ($entity_type
    ->hasLinkTemplate('collection') && $entity_type
    ->hasListBuilderClass() && $permissions) {

    /** @var \Drupal\Core\StringTranslation\TranslatableMarkup $label */
    $label = $entity_type
      ->getCollectionLabel();
    $route = new Route($entity_type
      ->getLinkTemplate('collection'));
    $route
      ->addDefaults([
      '_entity_list' => $entity_type
        ->id(),
      '_title' => $label
        ->getUntranslatedString(),
      '_title_arguments' => $label
        ->getArguments(),
      '_title_context' => $label
        ->getOption('context'),
    ])
      ->setRequirement('_permission', implode('+', $permissions));
    return $route;
  }
}