class InvoiceRouteProvider in Commerce Invoice 8.2

Provides routes for the Invoice entity.

Hierarchy

• class \Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider implements EntityHandlerInterface, EntityRouteProviderInterface
  • class \Drupal\entity\Routing\DefaultHtmlRouteProvider
    • class \Drupal\entity\Routing\AdminHtmlRouteProvider
      • class \Drupal\commerce_invoice\InvoiceRouteProvider

File

src/InvoiceRouteProvider.php, line 12

Namespace

Drupal\commerce_invoice

class InvoiceRouteProvider extends AdminHtmlRouteProvider {

  /**
   * {@inheritdoc}
   */
  public function getRoutes(EntityTypeInterface $entity_type) {
    $collection = parent::getRoutes($entity_type);
    $entity_type_id = $entity_type
      ->id();
    if ($download_route = $this
      ->getDownloadRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.download", $download_route);
    }
    if ($invoice_payment_route = $this
      ->getInvoicePaymentFormRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.payment_form", $invoice_payment_route);
    }
    return $collection;
  }

  /**
   * {@inheritdoc}
   */
  protected function getCanonicalRoute(EntityTypeInterface $entity_type) {
    $route = parent::getCanonicalRoute($entity_type);

    // Replace the 'full' view mode with the 'admin' view mode.
    $route
      ->setDefault('_entity_view', 'commerce_invoice.admin');
    return $route;
  }

  /**
   * Gets the download route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getDownloadRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('download')) {
      $entity_type_id = $entity_type
        ->id();
      $route = new Route($entity_type
        ->getLinkTemplate('download'));
      $route
        ->addDefaults([
        '_controller' => '\\Drupal\\commerce_invoice\\Controller\\InvoiceController::download',
      ])
        ->setRequirement('_entity_access', "{$entity_type_id}.view")
        ->setOption('parameters', [
        $entity_type_id => [
          'type' => 'entity:' . $entity_type_id,
        ],
      ]);

      // Entity types with serial IDs can specify this in their route
      // requirements, improving the matching process.
      if ($this
        ->getEntityTypeIdKeyType($entity_type) === 'integer') {
        $route
          ->setRequirement($entity_type_id, '\\d+');
      }
      return $route;
    }
  }

  /**
   * Gets the invoice payment-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 getInvoicePaymentFormRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('payment-form')) {
      $route = new Route($entity_type
        ->getLinkTemplate('payment-form'));
      $entity_type_id = $entity_type
        ->id();
      $route
        ->setDefaults([
        '_form' => '\\Drupal\\commerce_invoice\\Form\\InvoicePaymentForm',
      ])
        ->setRequirement('_entity_access', "{$entity_type_id}.update")
        ->setOption('parameters', [
        $entity_type_id => [
          'type' => 'entity:' . $entity_type_id,
        ],
      ]);

      // Entity types with serial IDs can specify this in their route
      // requirements, improving the matching process.
      if ($this
        ->getEntityTypeIdKeyType($entity_type) === 'integer') {
        $route
          ->setRequirement($entity_type_id, '\\d+');
      }
      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::getAddFormRoute	protected	function	Gets the add-form route.	2
DefaultHtmlRouteProvider::getAddPageRoute	protected	function	Gets the add page route.	2
DefaultHtmlRouteProvider::getCollectionRoute	protected	function	Gets the collection route. Overrides DefaultHtmlRouteProvider::getCollectionRoute
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::getEditFormRoute	protected	function	Gets the edit-form route.	1
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
InvoiceRouteProvider::getCanonicalRoute	protected	function	Gets the canonical route. Overrides DefaultHtmlRouteProvider::getCanonicalRoute
InvoiceRouteProvider::getDownloadRoute	protected	function	Gets the download route.
InvoiceRouteProvider::getInvoicePaymentFormRoute	protected	function	Gets the invoice payment-form route.
InvoiceRouteProvider::getRoutes	public	function	Provides routes for entities. Overrides AdminHtmlRouteProvider::getRoutes