class PathHasAlias
Provides a 'Path has alias' condition.
@todo Add access callback information from Drupal 7.
Plugin annotation
@Condition(
id = "rules_path_has_alias",
label = @Translation("Path has alias"),
category = @Translation("Path"),
provider = "path_alias",
context_definitions = {
"path" = @ContextDefinition("string",
label = @Translation("Path"),
description = @Translation("Specifies the existing path you wish to check. For example, '/node/28' or '/forum/1'.")
),
"language" = @ContextDefinition("language",
label = @Translation("Language"),
description = @Translation("If specified, the language for which the URL alias applies."),
options_provider = "\Drupal\rules\TypedData\Options\LanguageOptions",
default_value = NULL,
required = FALSE
),
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Executable\ExecutablePluginBase extends \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Condition\ConditionPluginBase extends \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait implements \Drupal\Core\Executable\ExecutablePluginBase
- class \Drupal\rules\Core\RulesConditionBase extends \Drupal\rules\Core\RulesConditionInterface uses \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait implements \Drupal\Core\Condition\ConditionPluginBase
- class \Drupal\rules\Plugin\Condition\PathHasAlias extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\rules\Core\RulesConditionBase
- class \Drupal\rules\Core\RulesConditionBase extends \Drupal\rules\Core\RulesConditionInterface uses \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait implements \Drupal\Core\Condition\ConditionPluginBase
- class \Drupal\Core\Condition\ConditionPluginBase extends \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait implements \Drupal\Core\Executable\ExecutablePluginBase
- class \Drupal\Core\Executable\ExecutablePluginBase extends \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of PathHasAlias
File
-
src/
Plugin/ Condition/ PathHasAlias.php, line 36
Namespace
Drupal\rules\Plugin\ConditionView source
class PathHasAlias extends RulesConditionBase implements ContainerFactoryPluginInterface {
/**
* The alias manager service.
*
* @var \Drupal\path_alias\AliasManagerInterface
*/
protected $aliasManager;
/**
* Constructs a PathHasAlias 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\path_alias\AliasManagerInterface $alias_manager
* The alias manager service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, AliasManagerInterface $alias_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->aliasManager = $alias_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('path_alias.manager'));
}
/**
* Check if a URL path has a URL alias.
*
* @param string $path
* The path to check.
* @param \Drupal\Core\Language\LanguageInterface|null $language
* An optional language to look up the path in.
*
* @return bool
* TRUE if the path has an alias in the given language.
*/
protected function doEvaluate($path, LanguageInterface $language = NULL) {
$langcode = is_null($language) ? NULL : $language->getId();
$alias = $this->aliasManager
->getAliasByPath($path, $langcode);
// getAliasByPath() returns the path if there is no alias.
return $alias != $path;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConditionPluginBase::$executableManager | protected | property | The condition manager to proxy execute calls through. | ||
ConditionPluginBase::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | 6 |
ConditionPluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
ConditionPluginBase::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ConfigurableInterface::defaultConfiguration | 6 |
ConditionPluginBase::execute | public | function | Executes the plugin. | Overrides ExecutableInterface::execute | |
ConditionPluginBase::getConfiguration | public | function | Gets this plugin's configuration. | Overrides ConfigurableInterface::getConfiguration | |
ConditionPluginBase::isNegated | public | function | Determines whether condition result will be negated. | Overrides ConditionInterface::isNegated | |
ConditionPluginBase::setConfiguration | public | function | Sets the configuration for this plugin instance. | Overrides ConfigurableInterface::setConfiguration | |
ConditionPluginBase::setExecutableManager | public | function | Sets the executable manager class. | Overrides ConditionInterface::setExecutableManager | |
ConditionPluginBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | 6 |
ConditionPluginBase::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm | |
ConfigurationAccessControlTrait::checkConfigurationAccess | public | function | Checks configuration permission. | ||
ContextAwarePluginAssignmentTrait::addContextAssignmentElement | protected | function | Builds a form element for assigning a context to a given slot. | ||
ContextAwarePluginAssignmentTrait::contextHandler | protected | function | Wraps the context handler. | ||
ContextAwarePluginAssignmentTrait::t | abstract protected | function | Ensures the t() method is available. | ||
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::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. | ||
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 | 2 | ||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
ExecutablePluginBase::getConfig | public | function | Gets all configuration values. | ||
ExecutablePluginBase::getConfigDefinition | public | function | Gets the definition of a configuration option. | ||
ExecutablePluginBase::getConfigDefinitions | public | function | Gets an array of definitions of available configuration options. | ||
ExecutablePluginBase::setConfig | public | function | Sets the value of a particular configuration option. | ||
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 | |
MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PathHasAlias::$aliasManager | protected | property | The alias manager service. | ||
PathHasAlias::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
PathHasAlias::doEvaluate | protected | function | Check if a URL path has a URL alias. | ||
PathHasAlias::__construct | public | function | Constructs a PathHasAlias object. | Overrides ConditionPluginBase::__construct | |
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::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
RulesConditionBase::assertMetadata | public | function | Asserts additional metadata for the selected data. | Overrides ContextAwarePluginInterface::assertMetadata | 1 |
RulesConditionBase::evaluate | public | function | Evaluates the condition and returns TRUE or FALSE accordingly. | Overrides ConditionInterface::evaluate | 5 |
RulesConditionBase::getContextValue | public | function | Gets the value for a defined context. | Overrides ContextAwarePluginTrait::getContextValue | |
RulesConditionBase::negate | public | function | Negates the result after evaluating this condition. | Overrides RulesConditionInterface::negate | |
RulesConditionBase::refineContextDefinitions | public | function | Refines used and provided context definitions based upon context values. | Overrides ContextAwarePluginInterface::refineContextDefinitions | 1 |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
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 |