class AgreementRouteProvider in Agreement 3.0.x

Provide routes for each agreement entity.

Hierarchy

• class \Drupal\agreement\Entity\Routing\AgreementRouteProvider implements EntityHandlerInterface, EntityRouteProviderInterface

File

src/Entity/Routing/AgreementRouteProvider.php, line 17

Namespace

Drupal\agreement\Entity\Routing

class AgreementRouteProvider implements EntityRouteProviderInterface, EntityHandlerInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Initialize method.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public function getRoutes(EntityTypeInterface $entity_type) {
    $collection = new RouteCollection();

    // Find every agreement and ensure that routes are created for each path.
    $agreements = $this->entityTypeManager
      ->getStorage('agreement')
      ->loadMultiple();
    if (!empty($agreements)) {
      foreach ($agreements as $id => $agreement) {
        $collection
          ->add("agreement.{$id}", $this
          ->getCanonicalRouteForEntity($agreement));
      }
    }
    return $collection;
  }

  /**
   * Get the route information from the agreement entity.
   *
   * @param \Drupal\agreement\Entity\Agreement $agreement
   *   The agreement entity.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   A route object.
   */
  protected function getCanonicalRouteForEntity(Agreement $agreement) {
    $route = new Route($agreement
      ->get('path'));
    $route
      ->addDefaults([
      '_form' => '\\Drupal\\agreement\\Form\\AgreementForm',
      '_title_callback' => '\\Drupal\\agreement\\Form\\AgreementForm::title',
      'agreement' => $agreement
        ->id(),
    ])
      ->setRequirements([
      '_permission' => 'access content',
    ])
      ->setOption('parameters', [
      'agreement' => [
        'type' => 'entity:agreement',
      ],
    ]);
    return $route;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($container
      ->get('entity_type.manager'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AgreementRouteProvider::$entityTypeManager	protected	property	The entity type manager.
AgreementRouteProvider::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
AgreementRouteProvider::getCanonicalRouteForEntity	protected	function	Get the route information from the agreement entity.
AgreementRouteProvider::getRoutes	public	function	Provides routes for entities. Overrides EntityRouteProviderInterface::getRoutes
AgreementRouteProvider::__construct	public	function	Initialize method.