class ConfigActionsList in Config Actions 8

Plugin for handling a list of source locations.

Plugin annotation

@ConfigActionsSource(
  id = "list",
  description = @Translation("List of sources."),
)

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\ConfigActionsList

File

src/Plugin/ConfigActionsSource/ConfigActionsList.php, line 15

Namespace

Drupal\config_actions\Plugin\ConfigActionsSource

class ConfigActionsList extends ConfigActionsSourceBase {

  /**
   * Return True if array is Sequential
   * @param array $arr
   * @return bool
   */
  protected function isSequential($arr) {
    if (array() === $arr) {
      return false;
    }
    return is_array($arr) && array_keys($arr) == range(0, count($arr) - 1);
  }

  /**
   * {@inheritdoc}
   */
  public function detect($source) {
    return $this
      ->isSequential($source);
  }

  /**
   * {@inheritdoc}
   */
  public function doLoad() {
    $data = [];

    // Loop through sources and pick first success
    foreach ($this->sourceId as $source) {
      $data = $this->actionService
        ->loadSource($source, '', $this->sourceBase);
      if (!empty($data)) {
        break;
      }
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function doSave($data) {
    $result = FALSE;

    // Loop through sources and pick first success
    foreach ($this->sourceId as $source) {
      $result = $this->actionService
        ->saveSource($data, $source, '', $this->sourceBase);
      if ($result) {
        break;
      }
    }
    return $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigActionsList::detect	public	function	Determine if $source is valid for the specific plugin. Overrides ConfigActionsSourceBase::detect
ConfigActionsList::doLoad	public	function	Load data from the source. Overrides ConfigActionsSourceBase::doLoad
ConfigActionsList::doSave	public	function	Save data to the source. Overrides ConfigActionsSourceBase::doSave
ConfigActionsList::isSequential	protected	function	Return True if array is Sequential
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::create	public static	function	Create a plugin instance from the container Overrides ContainerFactoryPluginInterface::create	3
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
ConfigActionsSourceBase::__construct	public	function	Constructs a new ConfigActionsSource plugin object. Overrides PluginBase::__construct	3
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.