class EdgeEntityFieldConfigListAlterEvent in Apigee Edge 8

Triggered when an Apigee Edge entity's field config UI gets built.

Hierarchy

• class \Drupal\apigee_edge\Event\EdgeEntityFieldConfigListAlterEvent extends \Symfony\Component\EventDispatcher\Event

See also

\Drupal\apigee_edge\Controller\EdgeEntityFieldConfigListController

\Drupal\apigee_edge\Routing\EdgeEntityFieldConfigListRouteSubscriber

3 files declare their use of EdgeEntityFieldConfigListAlterEvent

DeveloperAppFieldConfigListAlterEventSubscriber.php in src/EventSubscriber/DeveloperAppFieldConfigListAlterEventSubscriber.php

EdgeEntityFieldConfigListController.php in src/Controller/EdgeEntityFieldConfigListController.php

TeamAppFieldConfigListAlterEventSubscriber.php in modules/apigee_edge_teams/src/EventSubscriber/TeamAppFieldConfigListAlterEventSubscriber.php

File

src/Event/EdgeEntityFieldConfigListAlterEvent.php, line 31

Namespace

Drupal\apigee_edge\Event

class EdgeEntityFieldConfigListAlterEvent extends Event {

  /**
   * Event id.
   *
   * @var string
   */
  public const EVENT_NAME = 'apigee_edge.field_config_list_alter';

  /**
   * The entity type id.
   *
   * @var string
   */
  private $entityType;

  /**
   * Page render array.
   *
   * @var array
   */
  private $page;

  /**
   * AppFieldConfigListAlterEvent constructor.
   *
   * @param string $entity_type
   *   The entity type id.
   * @param array $page
   *   The page render array.
   */
  public function __construct(string $entity_type, array &$page) {
    $this->entityType = $entity_type;
    $this->page = $page;
  }

  /**
   * Returns the entity type.
   *
   * @return string
   *   The entity type.
   */
  public function getEntityType() : string {
    return $this->entityType;
  }

  /**
   * Returns the page render array by reference.
   *
   * @return array
   *   The page render array.
   */
  public function &getPage() : array {
    return $this->page;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EdgeEntityFieldConfigListAlterEvent::$entityType	private	property	The entity type id.
EdgeEntityFieldConfigListAlterEvent::$page	private	property	Page render array.
EdgeEntityFieldConfigListAlterEvent::EVENT_NAME	public	constant	Event id.
EdgeEntityFieldConfigListAlterEvent::getEntityType	public	function	Returns the entity type.
EdgeEntityFieldConfigListAlterEvent::getPage	public	function	Returns the page render array by reference.
EdgeEntityFieldConfigListAlterEvent::__construct	public	function	AppFieldConfigListAlterEvent constructor.