class PetHtmlRouteProvider in Previewable email templates 8.3

Provides routes for pet entities.

Hierarchy

• class \Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider implements EntityHandlerInterface, EntityRouteProviderInterface
  • class \Drupal\Core\Entity\Routing\AdminHtmlRouteProvider
    • class \Drupal\pet\PetHtmlRouteProvider

See also

\Drupal\Core\Entity\Routing\AdminHtmlRouteProvider

\Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider

File

src/PetHtmlRouteProvider.php, line 15

Namespace

Drupal\pet

class PetHtmlRouteProvider extends AdminHtmlRouteProvider {

  /**
   * {@inheritdoc}
   */
  public function getRoutes(EntityTypeInterface $entity_type) {
    $collection = parent::getRoutes($entity_type);
    $entity_type_id = $entity_type
      ->id();

    // It seems that by default, you need "administer pet entities" to view
    // the collection list.
    $collection
      ->get("entity.{$entity_type_id}.collection")
      ->setRequirement('_permission', 'view pet entity');
    if ($history_route = $this
      ->getHistoryRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.version_history", $history_route);
    }
    if ($preview_route = $this
      ->getPreviewRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.preview", $preview_route);
    }
    if ($revision_route = $this
      ->getRevisionRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.revision", $revision_route);
    }
    if (\Drupal::moduleHandler()
      ->moduleExists('diff')) {
      if ($revisions_diff_route = $this
        ->getRevisionsDiffRoute($entity_type)) {
        $collection
          ->add("entity.{$entity_type_id}.revisions_diff", $revisions_diff_route);
      }
    }
    if ($revert_route = $this
      ->getRevisionRevertRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.revision_revert_confirm", $revert_route);
    }
    if ($delete_route = $this
      ->getRevisionDeleteRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.revision_delete_confirm", $delete_route);
    }
    if ($translation_route = $this
      ->getRevisionTranslationRevertRoute($entity_type)) {
      $collection
        ->add("entity.{$entity_type_id}.revision_revert_translation_confirm", $translation_route);
    }
    if ($settings_form_route = $this
      ->getSettingsFormRoute($entity_type)) {
      $collection
        ->add("{$entity_type_id}.settings", $settings_form_route);
    }
    return $collection;
  }

  /**
   * Gets the version history route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getHistoryRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('version-history')) {
      $route = new Route($entity_type
        ->getLinkTemplate('version-history'));
      $route
        ->setDefaults([
        '_title' => "{$entity_type->getLabel()} revisions",
        '_controller' => '\\Drupal\\pet\\Controller\\PetRevisionController::revisionOverview',
      ])
        ->setRequirement('_permission', 'access pet revisions')
        ->setOption('_admin_route', TRUE);
      if (\Drupal::moduleHandler()
        ->moduleExists('diff')) {
        $route
          ->addDefaults(array(
          '_controller' => '\\Drupal\\pet\\Controller\\PetDiffRevisionController::revisionOverview',
        ));
      }
      return $route;
    }
  }

  /**
   * Gets the preview route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getPreviewRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('preview-form')) {
      $route = new Route($entity_type
        ->getLinkTemplate('preview-form'));
      $route
        ->setDefaults([
        '_title' => "Preview",
        '_form' => '\\Drupal\\pet\\Form\\PetPreviewForm',
      ])
        ->setRequirement('_permission', 'view pet entity')
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

  /**
   * Gets the revision route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getRevisionRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('revision')) {
      $route = new Route($entity_type
        ->getLinkTemplate('revision'));
      $route
        ->setDefaults([
        '_controller' => '\\Drupal\\pet\\Controller\\PetRevisionController::revisionShow',
        '_title_callback' => '\\Drupal\\pet\\Controller\\PetRevisionController::revisionPageTitle',
      ])
        ->setRequirement('_permission', 'access pet revisions')
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

  /**
   * Gets the revisions diff route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getRevisionsDiffRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('revisions_diff')) {
      $route = new Route($entity_type
        ->getLinkTemplate('revisions_diff'));
      $route
        ->setDefaults([
        '_controller' => '\\Drupal\\pet\\Controller\\PetDiffRevisionController::comparePetRevisions',
        '_title' => 'Diff General Settings',
      ])
        ->setRequirement('_permission', 'access pet revisions')
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

  /**
   * Gets the revision revert route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getRevisionRevertRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('revision_revert')) {
      $route = new Route($entity_type
        ->getLinkTemplate('revision_revert'));
      $route
        ->setDefaults([
        '_form' => '\\Drupal\\pet\\Form\\PetRevisionRevertForm',
        '_title' => 'Revert to earlier revision',
      ])
        ->setRequirement('_permission', 'revert pet revisions')
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

  /**
   * Gets the revision delete route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getRevisionDeleteRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('revision_delete')) {
      $route = new Route($entity_type
        ->getLinkTemplate('revision_delete'));
      $route
        ->setDefaults([
        '_form' => '\\Drupal\\pet\\Form\\PetRevisionDeleteForm',
        '_title' => 'Delete earlier revision',
      ])
        ->setRequirement('_permission', 'delete pet revisions')
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

  /**
   * Gets the revision translation revert route.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getRevisionTranslationRevertRoute(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->hasLinkTemplate('translation_revert')) {
      $route = new Route($entity_type
        ->getLinkTemplate('translation_revert'));
      $route
        ->setDefaults([
        '_form' => '\\Drupal\\pet\\Form\\PetRevisionRevertTranslationForm',
        '_title' => 'Revert to earlier revision of a translation',
      ])
        ->setRequirement('_permission', 'revert pet revisions')
        ->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/config/system/{$entity_type->id()}/settings");
      $route
        ->setDefaults([
        '_form' => 'Drupal\\pet\\Form\\PetSettingsForm',
        '_title' => "{$entity_type->getLabel()} settings",
      ])
        ->setRequirement('_permission', $entity_type
        ->getAdminPermission())
        ->setOption('_admin_route', TRUE);
      return $route;
    }
  }

}

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
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
PetHtmlRouteProvider::getHistoryRoute	protected	function	Gets the version history route.
PetHtmlRouteProvider::getPreviewRoute	protected	function	Gets the preview route.
PetHtmlRouteProvider::getRevisionDeleteRoute	protected	function	Gets the revision delete route.
PetHtmlRouteProvider::getRevisionRevertRoute	protected	function	Gets the revision revert route.
PetHtmlRouteProvider::getRevisionRoute	protected	function	Gets the revision route.
PetHtmlRouteProvider::getRevisionsDiffRoute	protected	function	Gets the revisions diff route.
PetHtmlRouteProvider::getRevisionTranslationRevertRoute	protected	function	Gets the revision translation revert route.
PetHtmlRouteProvider::getRoutes	public	function	Provides routes for entities. Overrides DefaultHtmlRouteProvider::getRoutes
PetHtmlRouteProvider::getSettingsFormRoute	protected	function	Gets the settings form route.