class PrintHtmlAlterEvent in Entity Print 8.2

An event to alter the HTML string.

Hierarchy

• class \Drupal\entity_print\Event\PrintHtmlAlterEvent extends \Symfony\Component\EventDispatcher\Event

3 files declare their use of PrintHtmlAlterEvent

PostRenderSubscriber.php in src/EventSubscriber/PostRenderSubscriber.php

PrintHtmlAlterTestEvent.php in tests/src/Kernel/PrintHtmlAlterTestEvent.php

RendererBase.php in src/Renderer/RendererBase.php

File

src/Event/PrintHtmlAlterEvent.php, line 10

Namespace

Drupal\entity_print\Event

class PrintHtmlAlterEvent extends Event {

  /**
   * The HTML string.
   *
   * @var string
   */
  protected $html;

  /**
   * An array of entities we're rendering.
   *
   * @var \Drupal\Core\Entity\EntityInterface[]
   */
  protected $entities;

  /**
   * PrintHtmlAlterEvent constructor.
   *
   * @param string $html
   *   The generated HTML.
   * @param array $entities
   *   An array of entities we're rendering.
   */
  public function __construct(&$html, array $entities) {
    $this->html =& $html;
    $this->entities = $entities;
  }

  /**
   * Gets the rendered HTML.
   *
   * @return string
   *   The HTML string.
   */
  public function &getHtml() {
    return $this->html;
  }

  /**
   * Gets the entities being rendered.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]
   *   An array of entities.
   */
  public function getEntities() {
    return $this->entities;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PrintHtmlAlterEvent::$entities	protected	property	An array of entities we're rendering.
PrintHtmlAlterEvent::$html	protected	property	The HTML string.
PrintHtmlAlterEvent::getEntities	public	function	Gets the entities being rendered.
PrintHtmlAlterEvent::getHtml	public	function	Gets the rendered HTML.	1
PrintHtmlAlterEvent::__construct	public	function	PrintHtmlAlterEvent constructor.	1