hn-8.x-1.x-dev/src/Event/HnResponseEvent.php

<?php

namespace Drupal\hn\Event;

use Drupal\hn\HnResponseService;
use Symfony\Component\EventDispatcher\Event;

/**
 * This event is invoked whenever something happens with the response event.
 *
 * It can be used to alter the response.
 */
class HnResponseEvent extends Event {

  /**
   * This event is triggered as soon as the HN response is created.
   * The responseData array will always be empty, except when another
   * eventListener added data.
   */
  const CREATED = 'hn.response.created';

  /**
   * This event is triggered when there was no cache found for the response.
   * The responseData array will always be empty, except when another
   * eventListener added data.
   */
  const CREATED_CACHE_MISS = 'hn.response.created.cache-miss';

  /**
   * This event is triggered when all entities are added to the response.
   */
  const POST_ENTITIES_ADDED = 'hn.response.done.entities';

  /**
   * This event is sent just before the response is sent back to the browser.
   */
  const PRE_SEND = 'hn.response.done';

  /**
   * The response service to get and change the responseData of.
   *
   * @var \Drupal\hn\HnResponseService
   */
  private $responseService;

  /**
   * The requested path.
   *
   * @var string|null
   */
  private $path;

  /**
   * The entity that was resolved from the requested path.
   *
   * @var \Drupal\Core\Entity\EntityInterface|null
   */
  private $entryEntity;

  /**
   * Creates an response event.
   *
   * @param \Drupal\hn\HnResponseService $hn_response_service
   *   The response service to get and change the responseData of.
   * @param string|null $path
   *   The path the request is for.
   * @param \Drupal\Core\Entity\EntityInterface|null $entity
   *   The entity that was resolved from the requested path.
   */
  public function __construct(HnResponseService $hn_response_service, $path = NULL, $entity = NULL) {
    $this->responseService = $hn_response_service;
    $this->path = $path;
    $this->entryEntity = $entity;
  }

  /**
   * Returns the response data.
   *
   * @return array
   *   The current response data.
   */
  public function getResponseData() {
    return $this->responseService->responseData;
  }

  /**
   * Changes the response data.
   *
   * @param array $responseData
   *   The new response data.
   */
  public function setResponseData(array $responseData) {
    $this->responseService->responseData = $responseData;
  }

  /**
   * Returns the requested path.
   *
   * @return string|null
   *   The requested path.
   */
  public function getPath() {
    return $this->path;
  }

  /**
   * Returns the entity that was resolved from the requested path.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The resolved entity.
   */
  public function getEntryEntity() {
    return $this->entryEntity;
  }

}