class PriceListItemRouteProvider in Commerce Pricelist 8.2

Provides routes for the price list 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_pricelist\PriceListItemRouteProvider

File

src/PriceListItemRouteProvider.php, line 15

Namespace

Drupal\commerce_pricelist

class PriceListItemRouteProvider extends AdminHtmlRouteProvider {

  /**
   * {@inheritdoc}
   */
  public function getRoutes(EntityTypeInterface $entity_type) {
    $collection = parent::getRoutes($entity_type);
    $entity_type_id = $entity_type
      ->id();
    if ($export_route = $this
      ->getExportFormRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.export_form", $export_route);
    }
    if ($import_route = $this
      ->getImportFormRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.import_form", $import_route);
    }
    return $collection;
  }

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

    // Replace the "Add price list item" title with "Add price".
    // The t() function is used to ensure the string is picked up for
    // translation, even though _title is supposed to be untranslated.
    $route
      ->setDefault('_title_callback', '');
    $route
      ->setDefault('_title', t('Add price')
      ->getUntranslatedString());
    return $route;
  }

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

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

    // AdminHtmlRouteProvider sets _admin_route for all routes except this one.
    $route
      ->setOption('_admin_route', TRUE);
    $route
      ->setDefault('_title_callback', PriceListController::class . '::priceListItemsTitle');
    return $route;
  }

  /**
   * Gets the export-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 getExportFormRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('export-form')) {
      $route = new Route($entity_type
        ->getLinkTemplate('export-form'));
      $route
        ->setDefaults([
        '_form' => PriceListItemExportForm::class,
        '_title' => 'Export prices',
      ])
        ->setRequirement('_permission', $entity_type
        ->getAdminPermission())
        ->setRequirement('commerce_pricelist', '\\d+')
        ->setOption('parameters', [
        'commerce_pricelist' => [
          'type' => 'entity:commerce_pricelist',
        ],
      ])
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

  /**
   * Gets the import-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 getImportFormRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('import-form')) {
      $route = new Route($entity_type
        ->getLinkTemplate('import-form'));
      $route
        ->setDefaults([
        '_form' => PriceListItemImportForm::class,
        '_title' => 'Import prices',
      ])
        ->setRequirement('_permission', $entity_type
        ->getAdminPermission())
        ->setRequirement('commerce_pricelist', '\\d+')
        ->setOption('parameters', [
        'commerce_pricelist' => [
          'type' => 'entity:commerce_pricelist',
        ],
      ])
        ->setOption('_admin_route', TRUE);
      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::getDeleteFormRoute	protected	function	Gets the delete-form route.	1
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
PriceListItemRouteProvider::getAddFormRoute	protected	function	Gets the add-form route. Overrides DefaultHtmlRouteProvider::getAddFormRoute
PriceListItemRouteProvider::getCollectionRoute	protected	function	Gets the collection route. Overrides DefaultHtmlRouteProvider::getCollectionRoute
PriceListItemRouteProvider::getEditFormRoute	protected	function	Gets the edit-form route. Overrides DefaultHtmlRouteProvider::getEditFormRoute
PriceListItemRouteProvider::getExportFormRoute	protected	function	Gets the export-form route.
PriceListItemRouteProvider::getImportFormRoute	protected	function	Gets the import-form route.
PriceListItemRouteProvider::getRoutes	public	function	Provides routes for entities. Overrides AdminHtmlRouteProvider::getRoutes