final class TokenType in Hook Event Dispatcher 8

Token ValueObject.

Convenience object to handle the integrity and assembly of token types.

Hierarchy

• class \Drupal\hook_event_dispatcher\Value\TokenType

4 files declare their use of TokenType

ExampleTokenEventSubscriber.php in src/Example/ExampleTokenEventSubscriber.php

TokenEventTest.php in tests/src/Unit/Token/TokenEventTest.php

TokensInfoEvent.php in src/Event/Token/TokensInfoEvent.php

TokenTypeTest.php in tests/src/Unit/Token/TokenTypeTest.php

File

src/Value/TokenType.php, line 14

Namespace

Drupal\hook_event_dispatcher\Value

final class TokenType {

  /**
   * Type.
   *
   * @var string
   */
  private $type;

  /**
   * Name.
   *
   * @var string
   */
  private $name;

  /**
   * Description.
   *
   * @var string|\Drupal\Component\Render\MarkupInterface
   */
  private $description;

  /**
   * Needs data.
   *
   * @var string
   */
  private $needsData;

  /**
   * Use create function instead.
   */
  private function __construct() {
  }

  /**
   * Token type factory.
   *
   * @param string $type
   *   The group name, like 'node'.
   * @param string|MarkupInterface $name
   *   The print-able name of the type.
   *
   * @return self
   *   A new instance.
   *
   * @throws \UnexpectedValueException
   */
  public static function create($type, $name) {
    $instance = new self();
    if (!is_string($type)) {
      throw new UnexpectedValueException('Type should be a string');
    }
    if (!is_string($name) && !$name instanceof MarkupInterface) {
      throw new UnexpectedValueException('Name should be a string or an instance of MarkupInterface');
    }
    $instance->type = $type;
    $instance->name = $name;
    return $instance;
  }

  /**
   * Set description and return a new instance.
   *
   * @param string $description
   *   The description of the token type.
   *
   * @return self
   *   A new instance with the description.
   *
   * @throws \UnexpectedValueException
   */
  public function setDescription($description) {
    if (!is_string($description) && !$description instanceof MarkupInterface) {
      throw new UnexpectedValueException('Description should be a string or an instance of MarkupInterface');
    }
    $clone = clone $this;
    $clone->description = $description;
    return $clone;
  }

  /**
   * Set the needs data and return a new instance.
   *
   * @param string $needsData
   *   The needs data.
   *
   * @return self
   *   A new instance with the needs data property.
   *
   * @throws \UnexpectedValueException
   */
  public function setNeedsData($needsData) {
    if ($needsData && !is_string($needsData)) {
      throw new UnexpectedValueException('NeedsData should be a string');
    }
    $clone = clone $this;
    $clone->needsData = $needsData;
    return $clone;
  }

  /**
   * Getter.
   *
   * @return string|null
   *   The description.
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * Getter.
   *
   * @return string|null
   *   The needs data property.
   */
  public function getNeedsData() {
    return $this->needsData;
  }

  /**
   * Getter.
   *
   * @return string
   *   The token type like 'node'.
   */
  public function getType() {
    return $this->type;
  }

  /**
   * Getter.
   *
   * @return string
   *   The token type label, like 'The Node type'.
   */
  public function getName() {
    return $this->name;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TokenType::$description	private	property	Description.
TokenType::$name	private	property	Name.
TokenType::$needsData	private	property	Needs data.
TokenType::$type	private	property	Type.
TokenType::create	public static	function	Token type factory.
TokenType::getDescription	public	function	Getter.
TokenType::getName	public	function	Getter.
TokenType::getNeedsData	public	function	Getter.
TokenType::getType	public	function	Getter.
TokenType::setDescription	public	function	Set description and return a new instance.
TokenType::setNeedsData	public	function	Set the needs data and return a new instance.
TokenType::__construct	private	function	Use create function instead.