class WishlistItemRouteProvider in Commerce Wishlist 8.3

Provides routes for the wishlist item entity.

Hierarchy

• class \Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider implements EntityHandlerInterface, EntityRouteProviderInterface
  • class \Drupal\entity\Routing\DefaultHtmlRouteProvider
    • class \Drupal\entity\Routing\AdminHtmlRouteProvider
      • class \Drupal\commerce_wishlist\WishlistItemRouteProvider

File

src/WishlistItemRouteProvider.php, line 13

Namespace

Drupal\commerce_wishlist

class WishlistItemRouteProvider extends AdminHtmlRouteProvider {

  /**
   * {@inheritdoc}
   */
  public function getRoutes(EntityTypeInterface $entity_type) {
    $collection = parent::getRoutes($entity_type);
    if ($details_form_route = $this
      ->getDetailsFormRoute($entity_type)) {
      $collection
        ->add('entity.commerce_wishlist_item.details_form', $details_form_route);
    }
    return $collection;
  }

  /**
   * Gets the details-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 getDetailsFormRoute(EntityTypeInterface $entity_type) {
    $route = new Route($entity_type
      ->getLinkTemplate('details-form'));
    $route
      ->addDefaults([
      '_controller' => WishlistItemController::class . '::detailsForm',
      '_title' => 'Edit details',
    ])
      ->setRequirement('_wishlist_item_details_access_check', 'TRUE')
      ->setOption('parameters', [
      'commerce_wishlist_item' => [
        'type' => 'entity:commerce_wishlist_item',
      ],
    ]);
    return $route;
  }

  /**
   * {@inheritdoc}
   */
  protected function getAddFormRoute(EntityTypeInterface $entity_type) {
    $route = parent::getAddFormRoute($entity_type);
    $route
      ->setOption('parameters', [
      'commerce_wishlist' => [
        'type' => 'entity:commerce_wishlist',
      ],
    ]);
    return $route;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditFormRoute(EntityTypeInterface $entity_type) {
    $route = parent::getEditFormRoute($entity_type);
    $route
      ->setOption('parameters', [
      'commerce_wishlist' => [
        'type' => 'entity:commerce_wishlist',
      ],
      'commerce_wishlist_item' => [
        'type' => 'entity:commerce_wishlist_item',
      ],
    ]);
    return $route;
  }

  /**
   * {@inheritdoc}
   */
  protected function getDeleteFormRoute(EntityTypeInterface $entity_type) {
    $route = parent::getDeleteFormRoute($entity_type);
    $route
      ->setOption('parameters', [
      'commerce_wishlist' => [
        'type' => 'entity:commerce_wishlist',
      ],
      'commerce_wishlist_item' => [
        'type' => 'entity:commerce_wishlist_item',
      ],
    ]);
    return $route;
  }

  /**
   * {@inheritdoc}
   */
  protected function getCollectionRoute(EntityTypeInterface $entity_type) {
    $route = parent::getCollectionRoute($entity_type);
    $route
      ->setDefault('_title_callback', WishlistItemController::class . '::collectionTitle')
      ->setOption('parameters', [
      'commerce_wishlist' => [
        'type' => 'entity:commerce_wishlist',
      ],
    ]);
    return $route;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::getAddPageRoute	protected	function	Gets the add page route.	2
DefaultHtmlRouteProvider::getCanonicalRoute	protected	function	Gets the canonical route.	3
DefaultHtmlRouteProvider::getDeleteMultipleFormRoute	protected	function	Returns the delete multiple form route.	1
DefaultHtmlRouteProvider::getDuplicateFormRoute	protected	function	Gets the duplicate-form route.
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
WishlistItemRouteProvider::getAddFormRoute	protected	function	Gets the add-form route. Overrides DefaultHtmlRouteProvider::getAddFormRoute
WishlistItemRouteProvider::getCollectionRoute	protected	function	Gets the collection route. Overrides DefaultHtmlRouteProvider::getCollectionRoute
WishlistItemRouteProvider::getDeleteFormRoute	protected	function	Gets the delete-form route. Overrides DefaultHtmlRouteProvider::getDeleteFormRoute
WishlistItemRouteProvider::getDetailsFormRoute	protected	function	Gets the details-form route.
WishlistItemRouteProvider::getEditFormRoute	protected	function	Gets the edit-form route. Overrides DefaultHtmlRouteProvider::getEditFormRoute
WishlistItemRouteProvider::getRoutes	public	function	Provides routes for entities. Overrides AdminHtmlRouteProvider::getRoutes