class SiteSettingEntityHtmlRouteProvider in Site Settings and Labels 8

Provides routes for Site Setting entities.

Hierarchy

• class \Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider implements EntityHandlerInterface, EntityRouteProviderInterface
  • class \Drupal\Core\Entity\Routing\AdminHtmlRouteProvider
    • class \Drupal\site_settings\SiteSettingEntityHtmlRouteProvider

See also

Drupal\Core\Entity\Routing\AdminHtmlRouteProvider

Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider

File

src/SiteSettingEntityHtmlRouteProvider.php, line 15

Namespace

Drupal\site_settings

class SiteSettingEntityHtmlRouteProvider extends AdminHtmlRouteProvider {

  /**
   * {@inheritdoc}
   */
  public function getRoutes(EntityTypeInterface $entity_type) {
    $collection = parent::getRoutes($entity_type);
    $entity_type_id = $entity_type
      ->id();
    if ($collection_route = $this
      ->getCollectionRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.collection", $collection_route);
    }
    if ($add_form_route = $this
      ->getAddFormRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.add_form", $add_form_route);
    }
    $add_page_route = $this
      ->getAddPageRoute($entity_type);
    $collection
      ->add("{$entity_type_id}.add_page", $add_page_route);
    if ($settings_form_route = $this
      ->getSettingsFormRoute($entity_type)) {
      $collection
        ->add("{$entity_type_id}.settings", $settings_form_route);
    }
    return $collection;
  }

  /**
   * Gets the collection route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getCollectionRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('collection') && $entity_type
      ->hasListBuilderClass()) {
      $entity_type_id = $entity_type
        ->id();
      $route = new Route($entity_type
        ->getLinkTemplate('collection'));
      $route
        ->setDefaults([
        '_entity_list' => $entity_type_id,
        '_title' => "{$entity_type->getLabel()} list",
      ])
        ->setRequirement('_permission', 'view site setting entities')
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

  /**
   * Gets the add-form route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getAddFormRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('add-form')) {
      $entity_type_id = $entity_type
        ->id();
      $parameters = [
        $entity_type_id => [
          'type' => 'entity:' . $entity_type_id,
        ],
      ];
      $route = new Route($entity_type
        ->getLinkTemplate('add-form'));
      $bundle_entity_type_id = $entity_type
        ->getBundleEntityType();

      // Content entities with bundles are added via a dedicated controller.
      $route
        ->setDefaults([
        '_controller' => 'Drupal\\site_settings\\Controller\\SiteSettingEntityAddController::addForm',
        '_title_callback' => 'Drupal\\site_settings\\Controller\\SiteSettingEntityAddController::getAddFormTitle',
      ])
        ->setRequirement('_entity_create_access', $entity_type_id . ':{' . $bundle_entity_type_id . '}');
      $parameters[$bundle_entity_type_id] = [
        'type' => 'entity:' . $bundle_entity_type_id,
      ];
      $route
        ->setOption('parameters', $parameters)
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

  /**
   * Gets the add page route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getAddPageRoute(EntityTypeInterface $entity_type) {
    $route = new Route("/admin/structure/{$entity_type->id()}/add");
    $route
      ->setDefaults([
      '_controller' => 'Drupal\\site_settings\\Controller\\SiteSettingEntityAddController::add',
      '_title' => "Update {$entity_type->getLabel()}",
    ])
      ->setRequirement('_entity_create_access', $entity_type
      ->id())
      ->setOption('_admin_route', TRUE);
    return $route;
  }

  /**
   * Gets the settings form route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getSettingsFormRoute(EntityTypeInterface $entity_type) {
    if (!$entity_type
      ->getBundleEntityType()) {
      $route = new Route("/admin/structure/{$entity_type->id()}/settings");
      $route
        ->setDefaults([
        '_form' => 'Drupal\\site_settings\\Form\\SiteSettingEntitySettingsForm',
        '_title' => "{$entity_type->getLabel()} settings",
      ])
        ->setRequirement('_permission', $entity_type
        ->getAdminPermission())
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdminHtmlRouteProvider::getDeleteFormRoute	protected	function	Gets the delete-form route. Overrides DefaultHtmlRouteProvider::getDeleteFormRoute
AdminHtmlRouteProvider::getDeleteMultipleFormRoute	protected	function	Returns the delete multiple form route. Overrides DefaultHtmlRouteProvider::getDeleteMultipleFormRoute
AdminHtmlRouteProvider::getEditFormRoute	protected	function	Gets the edit-form route. Overrides DefaultHtmlRouteProvider::getEditFormRoute	1
DefaultHtmlRouteProvider::$entityFieldManager	protected	property	The entity field manager.
DefaultHtmlRouteProvider::$entityTypeManager	protected	property	The entity type manager.
DefaultHtmlRouteProvider::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	1
DefaultHtmlRouteProvider::getCanonicalRoute	protected	function	Gets the canonical route.	3
DefaultHtmlRouteProvider::getEntityTypeIdKeyType	protected	function	Gets the type of the ID key for a given entity type.	1
DefaultHtmlRouteProvider::__construct	public	function	Constructs a new DefaultHtmlRouteProvider.	1
SiteSettingEntityHtmlRouteProvider::getAddFormRoute	protected	function	Gets the add-form route. Overrides AdminHtmlRouteProvider::getAddFormRoute
SiteSettingEntityHtmlRouteProvider::getAddPageRoute	protected	function	Gets the add page route. Overrides AdminHtmlRouteProvider::getAddPageRoute
SiteSettingEntityHtmlRouteProvider::getCollectionRoute	protected	function	Gets the collection route. Overrides DefaultHtmlRouteProvider::getCollectionRoute
SiteSettingEntityHtmlRouteProvider::getRoutes	public	function	Provides routes for entities. Overrides DefaultHtmlRouteProvider::getRoutes
SiteSettingEntityHtmlRouteProvider::getSettingsFormRoute	protected	function	Gets the settings form route.