class PathAliasCreate

Provides a 'Create any path alias' action.

@todo Add access callback information from Drupal 7.

Plugin annotation


@RulesAction(
  id = "rules_path_alias_create",
  label = @Translation("Create any path alias"),
  category = @Translation("Path"),
  provider = "path_alias",
  context_definitions = {
    "source" = @ContextDefinition("string",
      label = @Translation("Existing system path"),
      description = @Translation("Specifies the existing path you wish to alias. For example, '/node/28' or '/forum/1'.")
    ),
    "alias" = @ContextDefinition("string",
      label = @Translation("Path alias"),
      description = @Translation("Specify an alternative path by which this data can be accessed. For example, '/about' for an about page. Use an absolute path and do not add a trailing slash.")
    ),
    "language" = @ContextDefinition("language",
      label = @Translation("Language"),
      description = @Translation("If specified, the language for which the path alias applies."),
      options_provider = "\Drupal\rules\TypedData\Options\LanguageOptions",
      default_value = NULL,
      required = FALSE
    ),
  }
)

Hierarchy

Expanded class hierarchy of PathAliasCreate

File

src/Plugin/RulesAction/PathAliasCreate.php, line 40

Namespace

Drupal\rules\Plugin\RulesAction
View source 
class PathAliasCreate extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * The alias storage service.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $aliasStorage;
    
    /**
     * Constructs a PathAliasCreate 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 \Drupal\Core\Entity\EntityStorageInterface $alias_storage
     *   The alias storage service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityStorageInterface $alias_storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->aliasStorage = $alias_storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager')
            ->getStorage('path_alias'));
    }
    
    /**
     * Creates an alias for an existing path.
     *
     * @param string $source
     *   The existing path that should be aliased.
     * @param string $alias
     *   The alias path that should be created.
     * @param \Drupal\Core\Language\LanguageInterface $language
     *   (optional) The language.
     */
    protected function doExecute($source, $alias, LanguageInterface $language = NULL) {
        $langcode = isset($language) ? $language->getId() : LanguageInterface::LANGCODE_NOT_SPECIFIED;
        $path_alias = $this->aliasStorage
            ->create([
            'path' => $source,
            'alias' => $alias,
            'langcode' => $langcode,
        ]);
        $path_alias->save();
    }

}

Members

Title Modifiers Object type Summary Member alias Overriden Title Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess public function Checks configuration permission.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function Aliased as: traitGetContextValue
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
ContextProviderTrait::$providedContext protected property The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext public function
ContextProviderTrait::getProvidedContextDefinition public function
ContextProviderTrait::getProvidedContextDefinitions public function
ContextProviderTrait::setProvidedValue public function
ContextProviderTrait::upcastEntityId public function Upcasts an entity id to a full entity object.
ExecutablePluginTrait::getLabelValue protected function Get the translated label from the plugin definition.
ExecutablePluginTrait::summary public function Get the translated summary from the label annotation. 4
PathAliasCreate::$aliasStorage protected property The alias storage service.
PathAliasCreate::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PathAliasCreate::doExecute protected function Creates an alias for an existing path.
PathAliasCreate::__construct public function Constructs a PathAliasCreate object.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RulesActionBase::$configuration protected property The plugin configuration.
RulesActionBase::access public function Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata public function Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext public function Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext 14
RulesActionBase::calculateDependencies public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::defaultConfiguration public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute 2
RulesActionBase::executeMultiple public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::getConfiguration public function @todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
RulesActionBase::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions 5
RulesActionBase::setConfiguration public function @todo this documentation is not actually inherited from any interface.