ConfigNormalizerBase.php in Configuration Normalizer 8

Namespace

Drupal\config_normalizer\Plugin

File

src/Plugin/ConfigNormalizerBase.php

<?php

namespace Drupal\config_normalizer\Plugin;

use Drupal\config_normalizer\Config\NormalizedReadOnlyStorageInterface;
use Drupal\Component\Plugin\PluginBase;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Base class for Config normalizer plugins.
 */
abstract class ConfigNormalizerBase extends PluginBase implements ConfigNormalizerInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Creates a new config normalizer plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'));
  }

  /**
   * Determines whether the context has a default normalization mode.
   *
   * @param array $context
   *   An array of key-value pairs to pass additional context when needed.
   *
   * @return bool
   *   TRUE if the context normalization mode is default. Otherwise, FALSE.
   */
  protected function isDefaultModeContext(array $context) {
    return !empty($context['normalization_mode']) && $context['normalization_mode'] === NormalizedReadOnlyStorageInterface::DEFAULT_NORMALIZATION_MODE;
  }

  /**
   * Determines whether the context reference storage is the active storage.
   *
   * @param array $context
   *   An array of key-value pairs to pass additional context when needed.
   *
   * @return bool
   *   TRUE if the context normalization mode is default. Otherwise, FALSE.
   */
  protected function isActiveStorageContext(array $context) {
    if (!empty($context['reference_storage_service']) && !empty($context['reference_storage_service']->_serviceId) && $context['reference_storage_service']->_serviceId === 'config.storage') {
      return TRUE;
    }
    return FALSE;
  }

}

Classes

Name	Description
ConfigNormalizerBase	Base class for Config normalizer plugins.