interface ConfigActionsServiceInterface in Config Actions 8

Defines an interface for config actions service

Hierarchy

• interface \Drupal\config_actions\ConfigActionsServiceInterface

7 files declare their use of ConfigActionsServiceInterface

ConfigActionsCommands.php in src/Commands/ConfigActionsCommands.php

ConfigActionsFile.php in src/Plugin/ConfigActionsSource/ConfigActionsFile.php

ConfigActionsId.php in src/Plugin/ConfigActionsSource/ConfigActionsId.php

ConfigActionsPluginBaseTest.php in tests/src/Unit/ConfigActionsPluginBaseTest.php

ConfigActionsTemplate.php in src/Plugin/ConfigActionsSource/ConfigActionsTemplate.php

... See full list

File

src/ConfigActionsServiceInterface.php, line 8

Namespace

Drupal\config_actions

interface ConfigActionsServiceInterface {

  /**
   *  The sub-directory of a module containing config action files.
   */
  const CONFIG_ACTIONS_CONFIG_DIR = 'config/actions';

  /**
   * Process a single config_actions action
   *
   * @param array $action
   *   array of action data
   * @param array $options
   *   optional array of action options
   *   If $options is empty, values are taken from $action data
   * @param string $action_id
   *   The id string of the action to be executed.  If omitted, execute all
   *   actions in the $action array. Nested actions can be separated with a
   *   colon, such as "action:subaction"
   * @return mixed
   *   Returns the data processed, or NULL if no action was processed.
   */
  function processAction(array $action, array $options = [], $action_id = '');

  /**
   * Return a list of actions within an actions array
   *
   * @param array $actions
   *   array of action data
   * @return array
   *   Returns the list of action ids contained within the action data
   *   Nested actions have the form parent:child
   */
  function listActions(array $actions);

  /**
   * Process a specific action id from a given module
   * @param string $module_name
   * @param string $action_id
   *   if empty, process all actions in the module. Nested actions can be
   *   separated with a colon, such as "action:subaction"
   * @param string $file
   *   if empty, process all actions files in the module. Otherwise only
   *   process actions in the named file.  Just the file, not the path.
   *   The .yml extension is optional, but you cannot reference non *.yml files.
   * @param array $variables
   *   list of action variables to override imported behavior.
   * @return mixed
   *   Returns data imported or NULL if nothing was found.
   *   Data is keyed by the name of the action file that was found.
   */
  public function importAction($module_name, $action_id = '', $file = '', $variables = []);

  /**
   * Load data from a given source plugin.
   * @param mixed $source specifier
   * @param string $type
   *   source plugin id
   * @param string $base
   *   optional base path
   */
  public function loadSource($source, $type = '', $base = '');

  /**
   * Save data from a given source plugin.
   * @param mixed $data to be saved
   * @param mixed $dest specifier
   * @param string $type
   *   source plugin id
   * @param string $base
   *   optional base path
   * @param bool $force
   *   True if data should be saved regardless of pipeline
   * @return bool
   *   True if plugin could save data
   */
  public function saveSource($data, $dest, $type = '', $base = '', $force = FALSE);

  /**
   * Force saving all cached sources.
   */
  public function saveAll();

  /**
   * Clear the internal cache of source plugins.
   * Saves any changed data first via SaveAll.
   */
  public function clearSourceCache();

  /**
   * Return a list of actions within a module
   * @param string $module_name
   *   If omitted, all actions are listed
   * @param string $file
   *   if empty, list all actions files in the module. Otherwise only
   *   list actions in the named file.  Just the file, not the path.
   *   Do not include the .yml extension.
   * @return array keyed by module name and action file name
   *   each element an action array keyed by action id
   *   $result[$module_name][$file_name][$action_id] = action_data
   */
  public function listAll($module_name = '', $file = '');

  /**
   * Get or set the autoExecute property of the service.  When autoExecute
   * is TRUE, actions marked with the "auto: false" option are skipped.
   * If FALSE, all actions can are executed.
   * @param null|bool $value
   *   If specified, set the value of the autoExecute property
   * @return bool returns the value of the autoExecute property
   */
  public function autoExecute($value = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigActionsServiceInterface::autoExecute	public	function	Get or set the autoExecute property of the service. When autoExecute is TRUE, actions marked with the "auto: false" option are skipped. If FALSE, all actions can are executed.	1
ConfigActionsServiceInterface::clearSourceCache	public	function	Clear the internal cache of source plugins. Saves any changed data first via SaveAll.	1
ConfigActionsServiceInterface::CONFIG_ACTIONS_CONFIG_DIR		constant	The sub-directory of a module containing config action files.
ConfigActionsServiceInterface::importAction	public	function	Process a specific action id from a given module	1
ConfigActionsServiceInterface::listActions		function	Return a list of actions within an actions array	1
ConfigActionsServiceInterface::listAll	public	function	Return a list of actions within a module	1
ConfigActionsServiceInterface::loadSource	public	function	Load data from a given source plugin.	1
ConfigActionsServiceInterface::processAction		function	Process a single config_actions action	1
ConfigActionsServiceInterface::saveAll	public	function	Force saving all cached sources.	1
ConfigActionsServiceInterface::saveSource	public	function	Save data from a given source plugin.	1