class CiviCrmEntityRouteProvider in CiviCRM Entity 8.3

Provides routing for CiviCRM entities.

Hierarchy

• class \Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider implements EntityHandlerInterface, EntityRouteProviderInterface
  • class \Drupal\Core\Entity\Routing\AdminHtmlRouteProvider
    • class \Drupal\civicrm_entity\Routing\CiviCrmEntityRouteProvider

1 file declares its use of CiviCrmEntityRouteProvider

civicrm_entity.module in ./civicrm_entity.module

Module file for the CiviCRM Entity module.

File

src/Routing/CiviCrmEntityRouteProvider.php, line 12

Namespace

Drupal\civicrm_entity\Routing

class CiviCrmEntityRouteProvider extends AdminHtmlRouteProvider {

  /**
   * {@inheritdoc}
   */
  public function getRoutes(EntityTypeInterface $entity_type) {
    if ($entity_type
      ->get('civicrm_entity_ui_exposed')) {
      return parent::getRoutes($entity_type);
    }
    return new RouteCollection();
  }

  /**
   * {@inheritdoc}
   */
  protected function getAddFormRoute(EntityTypeInterface $entity_type) {
    $has_bundles = $entity_type
      ->hasKey('bundle');
    $entity_add_form_route = parent::getAddFormRoute($entity_type);
    if ($has_bundles) {

      // This ensures the form receives a default bundle from the
      // CivicrmEntity::preCreate method, avoiding the need for the `add_page`
      // route for selecting a bundle.
      assert($entity_add_form_route !== NULL);
      $entity_add_form_route
        ->setDefault('bundle', $entity_type
        ->id());
    }
    return $entity_add_form_route;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
CiviCrmEntityRouteProvider::getAddFormRoute	protected	function	Gets the add-form route. Overrides AdminHtmlRouteProvider::getAddFormRoute
CiviCrmEntityRouteProvider::getRoutes	public	function	Provides routes for entities. Overrides DefaultHtmlRouteProvider::getRoutes
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