class MapRenderEvent in farmOS 2.x

An event that is dispatched before rendering a map on the page.

@group farm

Hierarchy

• class \Drupal\Component\EventDispatcher\Event extends \Symfony\Component\EventDispatcher\Event
  • class \Drupal\farm_map\Event\MapRenderEvent

7 files declare their use of MapRenderEvent

FarmMap.php in modules/core/map/src/Element/FarmMap.php

MapRenderEventSubscriber.php in modules/asset/land/src/EventSubscriber/MapRenderEventSubscriber.php

MapRenderEventSubscriber.php in modules/asset/structure/src/EventSubscriber/MapRenderEventSubscriber.php

MapRenderEventSubscriber.php in modules/core/map/src/EventSubscriber/MapRenderEventSubscriber.php

MapRenderEventSubscriber.php in modules/core/quantity/src/EventSubscriber/MapRenderEventSubscriber.php

... See full list

File

modules/core/map/src/Event/MapRenderEvent.php, line 13

Namespace

Drupal\farm_map\Event

class MapRenderEvent extends Event {
  const EVENT_NAME = 'map_render_event';

  /**
   * The farm_map render element.
   *
   * @var \Drupal\farm_map\Element\FarmMap
   */
  public $element;

  /**
   * The map type config entity.
   *
   * @var \Drupal\farm_map\Entity\MapTypeInterface
   */
  private $mapType;

  /**
   * MapRenderEvent constructor.
   *
   * @param \Drupal\farm_map\Entity\MapTypeInterface $map_type
   *   The farm_map render element.
   * @param array $element
   *   The farm_map render array.
   */
  public function __construct(MapTypeInterface $map_type, array $element) {
    $this->element = $element;
    $this->mapType = $map_type;
  }

  /**
   * Getter method to get the map target ID.
   *
   * @return string
   *   The map target ID.
   */
  public function getMapTargetId() {
    return $this->element['#attributes']['id'];
  }

  /**
   * Getter method to get the map type being rendered.
   *
   * @return \Drupal\farm_map\Entity\MapTypeInterface
   *   The map type config entity.
   */
  public function getMapType() {
    return $this->mapType;
  }

  /**
   * Add behavior to the map.
   *
   * @param string $behavior_name
   *   The behavior name.
   * @param array $settings
   *   Optional behavior settings that will be added to
   *   drupalSettings.farm_map.behaviors.behavior_name.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function addBehavior(string $behavior_name, array $settings = []) {

    // Load the behavior.

    /** @var \Drupal\farm_map\Entity\MapBehaviorInterface $behavior */
    $behavior = \Drupal::entityTypeManager()
      ->getStorage('map_behavior')
      ->load($behavior_name);

    // Attach the library.
    $this->element['#attached']['library'][] = $behavior
      ->getLibrary();

    // Add behavior settings if supplied.
    if (!empty($settings)) {
      $behaviorSettings['behaviors'][$behavior_name] = $settings;
      $this
        ->addSettings($behaviorSettings);
    }
  }

  /**
   * Add settings to the map.
   *
   * These settings will be added to drupalSettings.farm_map.
   *
   * @param array $settings
   *   The settings to be added.
   */
  public function addSettings(array $settings) {
    $existing = [];
    if (!empty($this->element['#attached']['drupalSettings']['farm_map'])) {
      $existing = $this->element['#attached']['drupalSettings']['farm_map'];
    }
    $this->element['#attached']['drupalSettings']['farm_map'] = array_replace_recursive($existing, $settings);
  }

  /**
   * Add cache tags to the render element.
   *
   * @param array $tags
   *   An array of cache tags.
   */
  public function addCacheTags(array $tags) {
    $existing = [];
    if (!empty($this->element['#cache']['tags'])) {
      $existing = $this->element['#cache']['tags'];
    }
    $this->element['#cache']['tags'] = array_unique(array_merge($tags, $existing));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MapRenderEvent::$element	public	property	The farm_map render element.
MapRenderEvent::$mapType	private	property	The map type config entity.
MapRenderEvent::addBehavior	public	function	Add behavior to the map.
MapRenderEvent::addCacheTags	public	function	Add cache tags to the render element.
MapRenderEvent::addSettings	public	function	Add settings to the map.
MapRenderEvent::EVENT_NAME		constant
MapRenderEvent::getMapTargetId	public	function	Getter method to get the map target ID.
MapRenderEvent::getMapType	public	function	Getter method to get the map type being rendered.
MapRenderEvent::__construct	public	function	MapRenderEvent constructor.