class BlockEventVariables in Hook Event Dispatcher 3.x

Class BlockEventVariables.

Hierarchy

• class \Drupal\preprocess_event_dispatcher\Variables\AbstractEventVariables
  • class \Drupal\preprocess_event_dispatcher\Variables\BlockEventVariables

2 files declare their use of BlockEventVariables

BlockPreprocessEventFactory.php in modules/preprocess_event_dispatcher/src/Factory/BlockPreprocessEventFactory.php

OtherEventVariablesTest.php in modules/preprocess_event_dispatcher/tests/src/Unit/OtherEventVariablesTest.php

File

modules/preprocess_event_dispatcher/src/Variables/BlockEventVariables.php, line 11

Namespace

Drupal\preprocess_event_dispatcher\Variables

class BlockEventVariables extends AbstractEventVariables {

  /**
   * Get the block.
   *
   * @return \Drupal\block\BlockInterface
   *   The block.
   */
  public function getBlock() : BlockInterface {
    return $this->variables['block'];
  }

  /**
   * Get the block identifier.
   *
   * @return string
   *   Identifier for the block.
   */
  public function getId() : string {
    return $this->variables['elements']['#id'];
  }

  /**
   * Get the content for a given child.
   *
   * @param string $childName
   *   Name of the child.
   *
   * @return array
   *   Content of the child or [].
   */
  public function getContentChild(string $childName) : array {
    return $this->variables['content'][$childName] ?? [];
  }

  /**
   * Get the block content.
   *
   * @return null|\Drupal\block_content\BlockContentInterface
   *   Block Content Entity or NULL.
   */
  public function getBlockContent() : ?BlockContentInterface {
    return $this->variables['content']['#block_content'] ?? NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AbstractEventVariables::$variables	protected	property	Variables.
AbstractEventVariables::get	public	function	Get a variable with a given name, return default if it does not exist.	1
AbstractEventVariables::getByReference	public	function	Get a variable with a given name by reference.	1
AbstractEventVariables::remove	public	function	Remove a given variable.	1
AbstractEventVariables::set	public	function	Set a variable to a given value.	1
AbstractEventVariables::__construct	public	function	Event Variables constructor.
BlockEventVariables::getBlock	public	function	Get the block.
BlockEventVariables::getBlockContent	public	function	Get the block content.
BlockEventVariables::getContentChild	public	function	Get the content for a given child.
BlockEventVariables::getId	public	function	Get the block identifier.