interface AliasTypeInterface in Pathauto 8

Provides an interface for pathauto alias types.

Hierarchy

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

1 file declares its use of AliasTypeInterface

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

File

src/AliasTypeInterface.php, line 11

Namespace

Drupal\pathauto

interface AliasTypeInterface extends ContextAwarePluginInterface, DerivativeInspectionInterface {

  /**
   * Get the label.
   *
   * @return string
   *   The label.
   */
  public function getLabel();

  /**
   * Get the token types.
   *
   * @return string[]
   *   The token types.
   */
  public function getTokenTypes();

  /**
   * Returns the source prefix; used for bulk delete.
   *
   * @return string
   *   The source path prefix.
   */
  public function getSourcePrefix();

  /**
   * Determines if this plugin type can apply a given object.
   *
   * @param object $object
   *   The object used to determine if this plugin can apply.
   *
   * @return bool
   *   Whether this plugin applies to the given object.
   */
  public function applies($object);

}

Members

Name	Modifiers	Type	Description	Overrides
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