class ComponentRouteProvider in Module Builder 8.3

Route provider for component entity types.

This expands data from the component_sections handler into routes for the component entity form sections.

Hierarchy

• class \Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider implements EntityHandlerInterface, EntityRouteProviderInterface
  • class \Drupal\Core\Entity\Routing\AdminHtmlRouteProvider
    • class \Drupal\module_builder\Routing\ComponentRouteProvider

File

src/Routing/ComponentRouteProvider.php, line 15

Namespace

Drupal\module_builder\Routing

class ComponentRouteProvider extends AdminHtmlRouteProvider {

  /**
   * {@inheritdoc}
   */
  public function getRoutes(EntityTypeInterface $entity_type) {
    $collection = parent::getRoutes($entity_type);
    $entity_type_id = $entity_type
      ->id();
    $admin_permission = $entity_type
      ->getAdminPermission();
    $component_sections_handler = $this->entityTypeManager
      ->getHandler($entity_type_id, 'component_sections');
    $section_route_data = $component_sections_handler
      ->getFormTabRoutePaths();
    foreach ($section_route_data as $form_op => $title) {
      $route = new Route($entity_type
        ->getLinkTemplate("{$form_op}-form"));
      $route
        ->setDefaults([
        '_entity_form' => "{$entity_type_id}.{$form_op}",
        '_title_callback' => '\\Drupal\\module_builder\\Form\\ComponentSectionForm::title',
        // We can't use an entity type parameter in the callback, as we want
        // it to work with different entity types. So we specify the entity
        // type as a parameter here, so the controller can use that to get the
        // entity.
        'entity_type' => $entity_type_id,
        'title' => $title,
        'op' => $form_op,
      ])
        ->setRequirement('_permission', $admin_permission)
        ->setOption('parameters', [
        $entity_type_id => [
          'type' => 'entity:' . $entity_type_id,
        ],
      ]);
      $collection
        ->add("entity.{$entity_type_id}.{$form_op}_form", $route);
    }
    return $collection;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdminHtmlRouteProvider::getAddFormRoute	protected	function	Gets the add-form route. Overrides DefaultHtmlRouteProvider::getAddFormRoute
AdminHtmlRouteProvider::getAddPageRoute	protected	function	Gets the add page route. Overrides DefaultHtmlRouteProvider::getAddPageRoute
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
ComponentRouteProvider::getRoutes	public	function	Provides routes for entities. Overrides DefaultHtmlRouteProvider::getRoutes
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::getCollectionRoute	protected	function	Gets the collection route.	2
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