interface OgAdminRoutesEventInterface in Organic groups 8

Interface for OgAdminRoutesEvent classes.

This event allows implementing modules to provide their own OG Admin routes or alter existing definitions that are provided by other modules.

Hierarchy

• interface \Drupal\og\Event\OgAdminRoutesEventInterface

4 files declare their use of OgAdminRoutesEventInterface

OgAdminRoutesController.php in src/Controller/OgAdminRoutesController.php

OgAdminRoutesControllerTest.php in tests/src/Unit/OgAdminRoutesControllerTest.php

OgEventSubscriber.php in src/EventSubscriber/OgEventSubscriber.php

RouteSubscriber.php in src/Routing/RouteSubscriber.php

File

src/Event/OgAdminRoutesEventInterface.php, line 13

Namespace

Drupal\og\Event

interface OgAdminRoutesEventInterface {

  /**
   * The event name.
   */
  const EVENT_NAME = 'og.og_admin_routes';

  /**
   * Set routes info.
   *
   * Array with the routes to create with the following keys:
   *   - title
   *   - controller.
   *
   * @param array $routes_info
   *   The routes info array.
   */
  public function setRoutesInfo(array $routes_info);

  /**
   * Get routes info.
   *
   * @return array
   *   The routes info array.
   */
  public function getRoutesInfo();

  /**
   * Get routes.
   *
   * @param string $entity_type_id
   *   The entity type ID.
   *
   * @return array
   *   Array with the routes info.
   */
  public function getRoutes($entity_type_id);

}

Members

Name	Modifiers	Type	Description	Overrides
OgAdminRoutesEventInterface::EVENT_NAME		constant	The event name.
OgAdminRoutesEventInterface::getRoutes	public	function	Get routes.	1
OgAdminRoutesEventInterface::getRoutesInfo	public	function	Get routes info.	1
OgAdminRoutesEventInterface::setRoutesInfo	public	function	Set routes info.	1