You are here

Home » API reference » Config Actions 8 » ConfigActionsTemplate.php

class ConfigActionsTemplate in Config Actions 8

Plugin for config source from files.

Plugin annotation


@ConfigActionsSource(
  id = "template",
  description = @Translation("Use a config/template file."),
  weight = "-1",
)

Hierarchy

Expanded class hierarchy of ConfigActionsTemplate

File

src/Plugin/ConfigActionsSource/ConfigActionsTemplate.php, line 21

Namespace

Drupal\config_actions\Plugin\ConfigActionsSource
View source 
class ConfigActionsTemplate extends ConfigActionsSourceBase {

  /**
   * @var string
   *   The name of the default sub-directory containing config templates.
   */
  const CONFIG_TEMPLATE_DIRECTORY = 'config/templates';

  /**
   * The configuration storage.
   *
   * @var \Drupal\Core\Config\ExtensionInstallStorage
   */
  protected $templateStorage;

  /**
   * Constructs a new ConfigActionsSource object.
   *
   * @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 ConfigActionsServiceInterface $config_action_service
   *   The ConfigActionsService from the container.
   * @param FileSystem $file_system
   *   The FileSystem from the container.
   * @param \Drupal\Core\Config\StorageInterface $config_storage
   *   The active configuration storage.
   * @param string $profile
   *   The current installation profile.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigActionsServiceInterface $config_action_service, StorageInterface $config_storage, $profile) {
    $this->templateStorage = new ExtensionInstallStorage($config_storage, ConfigActionsFile::CONFIG_TEMPLATE_DIRECTORY, ExtensionInstallStorage::DEFAULT_COLLECTION, TRUE, $profile);
    parent::__construct($configuration, $plugin_id, $plugin_definition, $config_action_service);
  }

  /**
   * Create a plugin instance from the container
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   * @param array $configuration
   * @param string $plugin_id
   * @param mixed $plugin_definition
   * @return static
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var ConfigActionsServiceInterface $config_action_service */
    $config_action_service = $container
      ->get('config_actions');

    /** @var StorageInterface $config_storage */
    $config_storage = $container
      ->get('config.storage');
    return new static($configuration, $plugin_id, $plugin_definition, $config_action_service, $config_storage, $container
      ->getParameter('install_profile'));
  }

  /**
   * {@inheritdoc}
   */
  public function detect($source) {

    // No auto-detection for templates
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function doLoad() {
    $this
      ->setMerge(TRUE);
    return $this->templateStorage
      ->read($this->sourceId);
  }

  /**
   * {@inheritdoc}
   */
  public function doSave($data) {

    // Cannot save templates, use a File instead.
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigActionsSourceBase::$actionService protected property
ConfigActionsSourceBase::$changed protected property Determine if sourceData has been changed since last load/save.
ConfigActionsSourceBase::$merge protected property
ConfigActionsSourceBase::$pluginType protected property The type of the plugin instance
ConfigActionsSourceBase::$sourceBase protected property The Base namespace for the source. Plugin specific.
ConfigActionsSourceBase::$sourceData protected property The cached config data for this source instance.
ConfigActionsSourceBase::$sourceId protected property The ID value of the source. Plugin specific.
ConfigActionsSourceBase::getData public function Get the data cached from the last load/save. Overrides ConfigActionsSourceInterface::getData
ConfigActionsSourceBase::getMerge public function Return whether the data from this source will be merged Overrides ConfigActionsSourceInterface::getMerge
ConfigActionsSourceBase::getType public function Return the type of plugin. Overrides ConfigActionsSourceInterface::getType
ConfigActionsSourceBase::isChanged public function Return TRUE if the data has changed since the last load. Overrides ConfigActionsSourceInterface::isChanged
ConfigActionsSourceBase::load public function Load data from the source. Overrides ConfigActionsSourceInterface::load
ConfigActionsSourceBase::save public function Save data to the source. Overrides ConfigActionsSourceInterface::save
ConfigActionsSourceBase::setData public function Set the data cached in this plugin instance. Causes the plugin to be marked as Changed. Overrides ConfigActionsSourceInterface::setData
ConfigActionsSourceBase::setMerge public function Set whether data saved in this source should be merged with existing data Overrides ConfigActionsSourceInterface::setMerge
ConfigActionsTemplate::$templateStorage protected property The configuration storage.
ConfigActionsTemplate::CONFIG_TEMPLATE_DIRECTORY constant The name of the default sub-directory containing config templates.
ConfigActionsTemplate::create public static function Create a plugin instance from the container Overrides ConfigActionsSourceBase::create
ConfigActionsTemplate::detect public function Determine if $source is valid for the specific plugin. Overrides ConfigActionsSourceBase::detect
ConfigActionsTemplate::doLoad public function Load data from the source. Overrides ConfigActionsSourceBase::doLoad
ConfigActionsTemplate::doSave public function Save data to the source. Overrides ConfigActionsSourceBase::doSave
ConfigActionsTemplate::__construct public function Constructs a new ConfigActionsSource object. Overrides ConfigActionsSourceBase::__construct
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.