interface AliasTypeBatchUpdateInterface in Pathauto 8

Alias types that support batch updates and deletions.

Hierarchy

• interface \Drupal\Core\Plugin\ContextAwarePluginInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface
  • interface \Drupal\pathauto\AliasTypeInterface
    • interface \Drupal\pathauto\AliasTypeBatchUpdateInterface

3 files declare their use of AliasTypeBatchUpdateInterface

EntityAliasTypeBase.php in src/Plugin/pathauto/AliasType/EntityAliasTypeBase.php

PathautoBulkUpdateForm.php in src/Form/PathautoBulkUpdateForm.php

PathautoCommands.php in src/Commands/PathautoCommands.php

File

src/AliasTypeBatchUpdateInterface.php, line 8

Namespace

Drupal\pathauto

interface AliasTypeBatchUpdateInterface extends AliasTypeInterface {

  /**
   * Gets called to batch update all entries.
   *
   * @param string $action
   *   One of:
   *   - 'create' to generate a URL alias for paths having none.
   *   - 'update' to recreate the URL alias for paths already having one, useful
   *     if the pattern changed.
   *   - 'all' to do both actions above at the same time.
   * @param array $context
   *   Batch context.
   */
  public function batchUpdate($action, &$context);

  /**
   * Gets called to batch delete all aliases created by pathauto.
   *
   * @param array $context
   *   Batch context.
   */
  public function batchDelete(&$context);

}

Members

Name	Modifiers	Type	Description	Overrides
AliasTypeBatchUpdateInterface::batchDelete	public	function	Gets called to batch delete all aliases created by pathauto.	1
AliasTypeBatchUpdateInterface::batchUpdate	public	function	Gets called to batch update all entries.	1
AliasTypeInterface::applies	public	function	Determines if this plugin type can apply a given object.	1
AliasTypeInterface::getLabel	public	function	Get the label.	1
AliasTypeInterface::getSourcePrefix	public	function	Returns the source prefix; used for bulk delete.	1
AliasTypeInterface::getTokenTypes	public	function	Get the token types.	1
ContextAwarePluginInterface::getContext	public	function	Gets a defined context.	1
ContextAwarePluginInterface::getContextDefinition	public	function	Gets a specific context definition of the plugin. Overrides ContextAwarePluginInterface::getContextDefinition
ContextAwarePluginInterface::getContextDefinitions	public	function	Gets the context definitions of the plugin. Overrides ContextAwarePluginInterface::getContextDefinitions
ContextAwarePluginInterface::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names.	1
ContextAwarePluginInterface::getContexts	public	function	Gets the defined contexts.	1
ContextAwarePluginInterface::getContextValue	public	function	Gets the value for a defined context.	1
ContextAwarePluginInterface::getContextValues	public	function	Gets the values for all defined contexts.	1
ContextAwarePluginInterface::setContext	public	function	Set a context on this plugin.	1
ContextAwarePluginInterface::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names.	1
ContextAwarePluginInterface::setContextValue	public	function	Sets the value for a defined context.	1
ContextAwarePluginInterface::validateContexts	public	function	Validates the set values for the defined contexts.	1
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2