You are here

class PageTopEvent in Hook Event Dispatcher 3.x

Same name and namespace in other branches
  1. 8.2 modules/core_event_dispatcher/src/Event/Theme/PageTopEvent.php \Drupal\core_event_dispatcher\Event\Theme\PageTopEvent

Class PageTopEvent.

Hierarchy

  • class \Drupal\core_event_dispatcher\Event\Theme\PageTopEvent extends \Symfony\Component\EventDispatcher\Event implements EventInterface

Expanded class hierarchy of PageTopEvent

2 files declare their use of PageTopEvent
core_event_dispatcher.module in modules/core_event_dispatcher/core_event_dispatcher.module
Core event dispatcher submodule.
PageEventTest.php in modules/core_event_dispatcher/tests/src/Unit/Theme/PageEventTest.php

File

modules/core_event_dispatcher/src/Event/Theme/PageTopEvent.php, line 12

Namespace

Drupal\core_event_dispatcher\Event\Theme
View source
class PageTopEvent extends Event implements EventInterface {

  /**
   * The build array.
   *
   * @var array
   */
  private $build;

  /**
   * PageTopEvent constructor.
   *
   * @param array $build
   *   The build array.
   */
  public function __construct(array &$build) {
    $this->build =& $build;
  }

  /**
   * Get the build array.
   *
   * @return array
   *   The build array.
   */
  public function &getBuild() : array {
    return $this->build;
  }

  /**
   * {@inheritdoc}
   */
  public function getDispatcherType() : string {
    return HookEventDispatcherInterface::PAGE_TOP;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PageTopEvent::$build private property The build array.
PageTopEvent::getBuild public function Get the build array.
PageTopEvent::getDispatcherType public function Get the dispatcher type. Overrides EventInterface::getDispatcherType
PageTopEvent::__construct public function PageTopEvent constructor.