class ConfigMapperPopulateEvent

Same name and namespace in other branches
  1. 9 core/modules/config_translation/src/Event/ConfigMapperPopulateEvent.php \Drupal\config_translation\Event\ConfigMapperPopulateEvent
  2. 8.9.x core/modules/config_translation/src/Event/ConfigMapperPopulateEvent.php \Drupal\config_translation\Event\ConfigMapperPopulateEvent
  3. 10 core/modules/config_translation/src/Event/ConfigMapperPopulateEvent.php \Drupal\config_translation\Event\ConfigMapperPopulateEvent

Provides a class for events related to configuration translation mappers.

Hierarchy

  • class \Drupal\Component\EventDispatcher\Event extends \Symfony\Contracts\EventDispatcher\Event

Expanded class hierarchy of ConfigMapperPopulateEvent

3 files declare their use of ConfigMapperPopulateEvent
ConfigNamesMapper.php in core/modules/config_translation/src/ConfigNamesMapper.php
ConfigTranslationTestSubscriber.php in core/modules/config_translation/tests/modules/config_translation_test/src/EventSubscriber/ConfigTranslationTestSubscriber.php
EditorConfigTranslationSubscriber.php in core/modules/editor/src/EventSubscriber/EditorConfigTranslationSubscriber.php

File

core/modules/config_translation/src/Event/ConfigMapperPopulateEvent.php, line 12

Namespace

Drupal\config_translation\Event
View source 
class ConfigMapperPopulateEvent extends Event {
    
    /**
     * The configuration mapper this event is related to.
     *
     * @var \Drupal\config_translation\ConfigMapperInterface
     */
    protected $mapper;
    
    /**
     * The route match this event is related to.
     *
     * @var \Drupal\Core\Routing\RouteMatchInterface
     */
    protected $routeMatch;
    
    /**
     * Constructs a ConfigMapperPopulateEvent object.
     *
     * @param \Drupal\config_translation\ConfigMapperInterface $mapper
     *   The configuration mapper this event is related to.
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The route match this event is related to.
     */
    public function __construct(ConfigMapperInterface $mapper, RouteMatchInterface $route_match) {
        $this->mapper = $mapper;
        $this->routeMatch = $route_match;
    }
    
    /**
     * Gets the configuration mapper this event is related to.
     *
     * @return \Drupal\config_translation\ConfigMapperInterface
     *   The configuration mapper this event is related to.
     */
    public function getMapper() {
        return $this->mapper;
    }
    
    /**
     * Gets the route match this event is related to.
     *
     * @return \Drupal\Core\Routing\RouteMatchInterface
     *   The route match this event is related to.
     */
    public function getRouteMatch() {
        return $this->routeMatch;
    }

}

Members

Title Modifiers Object type Summary
ConfigMapperPopulateEvent::$mapper protected property The configuration mapper this event is related to.
ConfigMapperPopulateEvent::$routeMatch protected property The route match this event is related to.
ConfigMapperPopulateEvent::getMapper public function Gets the configuration mapper this event is related to.
ConfigMapperPopulateEvent::getRouteMatch public function Gets the route match this event is related to.
ConfigMapperPopulateEvent::__construct public function Constructs a ConfigMapperPopulateEvent object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.