class ConfigMergeEvent in Config Merge 8

Class ConfigMergeEvent

@package Drupal\config_merge\Event

Hierarchy

• class \Drupal\config_merge\Event\ConfigMergeEvent extends \Symfony\Component\EventDispatcher\Event

File

src/Event/ConfigMergeEvent.php, line 12

Namespace

Drupal\config_merge\Event

class ConfigMergeEvent extends Event {

  /**
   * Config name that is being processed.
   *
   * @var string
   */
  protected $configName;

  /**
   * Array of logs keyed by operation name.
   *
   * @var array
   */
  protected $logs;

  /**
   * Config provider type.
   *
   * @var string
   */
  protected $providerType;

  /**
   * Config provider name.
   *
   * @var string
   */
  protected $providerName;

  /**
   * ConfigMergeEvent constructor.
   *
   * @param $config_name
   *   The name of the configuration object being changed.
   * @param $logs
   *   The logs array of merged or unmerged properties with the reason.
   * @param string $provider_type
   *   The type of the configuration provider.
   * @param string $provider_name
   *   The name of the configuration provider.
   */
  public function __construct($config_name, $logs, $provider_type = '', $provider_name = '') {
    $this->configName = $config_name;
    $this->logs = $logs;
    $this->providerType = $provider_type;
    $this->providerName = $provider_name;
  }

  /**
   * Gets the name of the configuration object that was in process.
   *
   * @return string
   */
  public function getConfigName() {
    return $this->configName;
  }

  /**
   * Gets the logs array of the merge process.
   *
   * @return array
   */
  public function getLogs() {
    return $this->logs;
  }

  /**
   * Gets the config provider type.
   *
   * @return string
   */
  public function getProviderType() {
    return $this->providerType;
  }

  /**
   * Gets the config provider name.
   *
   * @return string
   */
  public function getProviderName() {
    return $this->providerName;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigMergeEvent::$configName	protected	property	Config name that is being processed.
ConfigMergeEvent::$logs	protected	property	Array of logs keyed by operation name.
ConfigMergeEvent::$providerName	protected	property	Config provider name.
ConfigMergeEvent::$providerType	protected	property	Config provider type.
ConfigMergeEvent::getConfigName	public	function	Gets the name of the configuration object that was in process.
ConfigMergeEvent::getLogs	public	function	Gets the logs array of the merge process.
ConfigMergeEvent::getProviderName	public	function	Gets the config provider name.
ConfigMergeEvent::getProviderType	public	function	Gets the config provider type.
ConfigMergeEvent::__construct	public	function	ConfigMergeEvent constructor.