ConfigMapperPopulateEvent.php

Same filename in other branches
  1. 9 core/modules/config_translation/src/Event/ConfigMapperPopulateEvent.php
  2. 10 core/modules/config_translation/src/Event/ConfigMapperPopulateEvent.php
  3. 11.x core/modules/config_translation/src/Event/ConfigMapperPopulateEvent.php

Namespace

Drupal\config_translation\Event

File

core/modules/config_translation/src/Event/ConfigMapperPopulateEvent.php

View source
<?php

namespace Drupal\config_translation\Event;

use Drupal\config_translation\ConfigMapperInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Symfony\Component\EventDispatcher\Event;

/**
 * Provides a class for events related to configuration translation mappers.
 */
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;
    }

}

Classes

Title Deprecated Summary
ConfigMapperPopulateEvent Provides a class for events related to configuration translation mappers.

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