class ConfigActionsFile in Config Actions 8

Plugin for config source from files.

Plugin annotation


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

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\config_actions\ConfigActionsSourceBase implements ConfigActionsSourceInterface, ContainerFactoryPluginInterface
    class \Drupal\config_actions\Plugin\ConfigActionsSource\ConfigActionsFile

Expanded class hierarchy of ConfigActionsFile

1 file declares its use of ConfigActionsFile

ConfigActionsSourceTest.php in tests/src/Kernel/ConfigActionsSourceTest.php

File

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

Namespace

Drupal\config_actions\Plugin\ConfigActionsSource

View source

class ConfigActionsFile extends ConfigActionsSourceBase {

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

  /**
   * @var \Drupal\Core\File\FileSystem
   */
  protected $fileSystem;

  /**
   * 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.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigActionsServiceInterface $config_action_service, FileSystem $file_system) {
    $this->fileSystem = $file_system;
    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 FileSystem $file_system */
    $file_system = $container
      ->get('file_system');
    return new static($configuration, $plugin_id, $plugin_definition, $config_action_service, $file_system);
  }

  /**
   * {@inheritdoc}
   */
  public function detect($source) {
    $extension = '.' . FileStorage::getFileExtension();
    return is_string($source) && substr($source, -strlen($extension)) === $extension;
  }

  /**
   * Return the file name and path from the source specifier
   * @param $source
   * @param string $base
   *   Optional base path
   * @return array
   *   0 - file name
   *   1 - file path
   */
  protected function filePath($source, $base = '') {
    $filepath = $this->fileSystem
      ->dirname($source);
    $filename = $this->fileSystem
      ->basename($source, '.' . FileStorage::getFileExtension());

    // See if Source specifies its own path or not.
    if (empty($filepath) || $filepath == '.') {

      // Path not specified, so use provided base or current directory.
      $base = !empty($base) ? $base : dirname(__FILE__);
      $filepath = $base . '/' . self::CONFIG_TEMPLATE_DIRECTORY;
    }
    elseif (!empty($base)) {

      // If path was specified in Source, prepend any provided base path.
      $filepath = $base . '/' . $filepath;
    }
    return [
      $filepath,
      $filename,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function doLoad() {
    $this
      ->setMerge(TRUE);
    list($filepath, $filename) = $this
      ->filePath($this->sourceId, $this->sourceBase);
    $template_storage = new FileStorage($filepath, StorageInterface::DEFAULT_COLLECTION);
    return $template_storage
      ->read($filename);
  }

  /**
   * {@inheritdoc}
   */
  public function doSave($data) {
    list($filepath, $filename) = $this
      ->filePath($this->sourceId, $this->sourceBase);
    $template_storage = new FileStorage($filepath, StorageInterface::DEFAULT_COLLECTION);
    return $template_storage
      ->write($filename, $data);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigActionsFile::$fileSystem	protected	property
ConfigActionsFile::CONFIG_TEMPLATE_DIRECTORY		constant	The name of the default sub-directory containing config templates.
ConfigActionsFile::create	public static	function	Create a plugin instance from the container Overrides ConfigActionsSourceBase::create
ConfigActionsFile::detect	public	function	Determine if $source is valid for the specific plugin. Overrides ConfigActionsSourceBase::detect
ConfigActionsFile::doLoad	public	function	Load data from the source. Overrides ConfigActionsSourceBase::doLoad
ConfigActionsFile::doSave	public	function	Save data to the source. Overrides ConfigActionsSourceBase::doSave
ConfigActionsFile::filePath	protected	function	Return the file name and path from the source specifier
ConfigActionsFile::__construct	public	function	Constructs a new ConfigActionsSource object. Overrides ConfigActionsSourceBase::__construct
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
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.

You are here

class ConfigActionsFile in Config Actions 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation