display_builder-1.0.x-dev/src/Event/DisplayBuilderEvent.php

<?php

declare(strict_types=1);

namespace Drupal\display_builder\Event;

use Drupal\Component\EventDispatcher\Event;

/**
 * Event fired when display builder is used.
 */
final class DisplayBuilderEvent extends Event {

  /**
   * The result for this event.
   *
   * A render array.
   */
  private array $result = [];

  /**
   * Constructs a DisplayBuilderEvent object.
   *
   * @param string $builder_id
   *   The display builder ID.
   * @param array $island_enabled
   *   The enabled islands.
   * @param array|null $data
   *   The data associated with this event.
   * @param string|null $instance_id
   *   The instance ID.
   * @param string|null $parent_id
   *   The parent instance ID.
   */
  public function __construct(
    private string $builder_id,
    private array $island_enabled,
    private ?array $data = NULL,
    private ?string $instance_id = NULL,
    private ?string $parent_id = NULL,
  ) {}

  /**
   * Append a result for this event.
   *
   * @param array $result
   *   The result array to append.
   */
  public function appendResult(array $result): void {
    $this->result[] = $result;
  }

  /**
   * Gets the display builder ID.
   *
   * @return string
   *   The display builder ID.
   */
  public function getBuilderId(): string {
    return $this->builder_id;
  }

  /**
   * Gets the data associated with this event.
   *
   * @return array
   *   The event data.
   */
  public function getData(): ?array {
    return $this->data;
  }

  /**
   * Gets the instance ID.
   *
   * @return string
   *   The instance ID.
   */
  public function getInstanceId(): ?string {
    return $this->instance_id;
  }

  /**
   * Gets the enabled islands.
   *
   * @return array
   *   The enabled islands.
   */
  public function getIslandEnabled(): array {
    return $this->island_enabled;
  }

  /**
   * Gets the parent instance ID.
   *
   * @return string
   *   The parent instance ID.
   */
  public function getParentId(): ?string {
    return $this->parent_id;
  }

  /**
   * Gets the result for this event.
   *
   * @return array
   *   The result array, or empty array if not set.
   */
  public function getResult(): array {
    return $this->result;
  }

}