Version 1
[yaffs-website] / vendor / drupal / console / templates / module / src / entity-content-route-provider.php.twig
diff --git a/vendor/drupal/console/templates/module/src/entity-content-route-provider.php.twig b/vendor/drupal/console/templates/module/src/entity-content-route-provider.php.twig
new file mode 100644 (file)
index 0000000..1772beb
--- /dev/null
@@ -0,0 +1,241 @@
+{% extends "base/class.php.twig" %}
+
+{% block file_path %}
+\Drupal\{{ module }}\{{ entity_class }}HtmlRouteProvider.
+{% endblock %}
+
+{% block namespace_class %}
+namespace Drupal\{{ module }};
+{% endblock %}
+
+{% block use_class %}
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Entity\Routing\AdminHtmlRouteProvider;
+use Symfony\Component\Routing\Route;
+{% endblock %}
+
+{% block class_declaration %}
+/**
+ * Provides routes for {{ label }} entities.
+ *
+ * @see Drupal\Core\Entity\Routing\AdminHtmlRouteProvider
+ * @see Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider
+ */
+class {{ entity_class }}HtmlRouteProvider extends AdminHtmlRouteProvider {% endblock %}
+{% block class_methods %}
+  /**
+   * {@inheritdoc}
+   */
+  public function getRoutes(EntityTypeInterface $entity_type) {
+    $collection = parent::getRoutes($entity_type);
+
+    $entity_type_id = $entity_type->id();
+
+    if ($collection_route = $this->getCollectionRoute($entity_type)) {
+      $collection->add("entity.{$entity_type_id}.collection", $collection_route);
+    }
+{% if revisionable %}
+
+    if ($history_route = $this->getHistoryRoute($entity_type)) {
+      $collection->add("entity.{$entity_type_id}.version_history", $history_route);
+    }
+
+    if ($revision_route = $this->getRevisionRoute($entity_type)) {
+      $collection->add("entity.{$entity_type_id}.revision", $revision_route);
+    }
+
+    if ($revert_route = $this->getRevisionRevertRoute($entity_type)) {
+      $collection->add("entity.{$entity_type_id}.revision_revert", $revert_route);
+    }
+
+    if ($delete_route = $this->getRevisionDeleteRoute($entity_type)) {
+      $collection->add("entity.{$entity_type_id}.revision_delete", $delete_route);
+    }
+{% if is_translatable %}
+
+    if ($translation_route = $this->getRevisionTranslationRevertRoute($entity_type)) {
+      $collection->add("{$entity_type_id}.revision_revert_translation_confirm", $translation_route);
+    }
+{%  endif %}
+{%  endif %}
+
+    if ($settings_form_route = $this->getSettingsFormRoute($entity_type)) {
+      $collection->add("$entity_type_id.settings", $settings_form_route);
+    }
+
+    return $collection;
+  }
+
+  /**
+   * Gets the collection route.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
+   *   The entity type.
+   *
+   * @return \Symfony\Component\Routing\Route|null
+   *   The generated route, if available.
+   */
+  protected function getCollectionRoute(EntityTypeInterface $entity_type) {
+    if ($entity_type->hasLinkTemplate('collection') && $entity_type->hasListBuilderClass()) {
+      $entity_type_id = $entity_type->id();
+      $route = new Route($entity_type->getLinkTemplate('collection'));
+      $route
+        ->setDefaults([
+          '_entity_list' => $entity_type_id,
+          '_title' => "{$entity_type->getLabel()} list",
+        ])
+        ->setRequirement('_permission', 'access {{ label|lower }} overview')
+        ->setOption('_admin_route', TRUE);
+
+      return $route;
+    }
+  }
+{% if revisionable %}
+
+  /**
+   * 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\{{ module }}\Controller\{{ entity_class }}Controller::revisionOverview',
+        ])
+        ->setRequirement('_permission', 'access {{ label|lower }} revisions')
+        ->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\{{ module }}\Controller\{{ entity_class }}Controller::revisionShow',
+          '_title_callback' => '\Drupal\{{ module }}\Controller\{{ entity_class }}Controller::revisionPageTitle',
+        ])
+        ->setRequirement('_permission', 'access {{ label|lower }} 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\{{ module }}\Form\{{ entity_class }}RevisionRevertForm',
+          '_title' => 'Revert to earlier revision',
+        ])
+        ->setRequirement('_permission', 'revert all {{ label|lower }} 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\{{ module }}\Form\{{ entity_class }}RevisionDeleteForm',
+          '_title' => 'Delete earlier revision',
+        ])
+        ->setRequirement('_permission', 'delete all {{ label|lower }} revisions')
+        ->setOption('_admin_route', TRUE);
+
+      return $route;
+    }
+  }
+{% if is_translatable %}
+
+  /**
+   * 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\{{ module }}\Form\{{ entity_class }}RevisionRevertTranslationForm',
+          '_title' => 'Revert to earlier revision of a translation',
+        ])
+        ->setRequirement('_permission', 'revert all {{ label|lower }} revisions')
+        ->setOption('_admin_route', TRUE);
+
+      return $route;
+    }
+  }
+{%  endif %}
+{%  endif %}
+
+  /**
+   * 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/structure/{$entity_type->id()}/settings");
+      $route
+        ->setDefaults([
+          '_form' => 'Drupal\{{ module }}\Form\{{ entity_class }}SettingsForm',
+          '_title' => "{$entity_type->getLabel()} settings",
+        ])
+        ->setRequirement('_permission', $entity_type->getAdminPermission())
+        ->setOption('_admin_route', TRUE);
+
+      return $route;
+    }
+  }
+{% endblock %}