RequestPath
class RequestPath extends ConditionPluginBase implements ContainerFactoryPluginInterface (View source)
Provides a 'Request Path' condition.
Traits
Handles context assignments for context-aware plugins.
Wrapper methods for classes that needs typed data manager object.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected ContextInterface[] | $context | The data objects representing the context of this plugin. |
from ContextAwarePluginBase |
| protected TypedDataManagerInterface | $typedDataManager | The typed data manager used for creating the data types. |
from TypedDataTrait |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected ExecutableManagerInterface | $executableManager | The condition manager to proxy execute calls through. |
from ConditionPluginBase |
| protected AliasManagerInterface | $aliasManager | An alias manager to find the alias for the current system path. |
|
| protected PathMatcherInterface | $pathMatcher | The path matcher. |
|
| protected RequestStack | $requestStack | The request stack. |
|
| protected CurrentPathStack | $currentPath | The current path. |
Methods
Constructs a RequestPath condition plugin.
Creates context objects from any context mappings in configuration.
Gets the context definitions of the plugin.
Gets a specific context definition of the plugin.
Gets the value for a defined context.
Sets the value for a defined context.
Validates the set values for the defined contexts.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Gets a mapping of the expected assignment names to their context names.
Sets a mapping of the expected assignment names to their context names.
Wraps the context handler.
The cache contexts associated with this object.
The maximum age for which this object may be cached.
Gets an array of definitions of available configuration options.
Gets the definition of a configuration option.
Sets the value of a particular configuration option.
Builds a form element for assigning a context to a given slot.
Sets the configuration for this plugin instance.
Gets default configuration for this plugin.
Calculates dependencies for the configured plugin.
Sets the executable manager class.
Creates an instance of the plugin.
Provides a human readable summary of the condition's configuration.
Evaluates the condition and returns TRUE or FALSE accordingly.
Details
__construct(AliasManagerInterface $alias_manager, PathMatcherInterface $path_matcher, RequestStack $request_stack, CurrentPathStack $current_path, array $configuration, string $plugin_id, mixed $plugin_definition)
Constructs a RequestPath condition plugin.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
__get($name)
Implements magic __get() method.
protected ContextInterface[]
createContextFromConfiguration(array $context_configuration)
Creates context objects from any context mappings in configuration.
ContextDefinitionInterface[]
getContextDefinitions()
Gets the context definitions of the plugin.
ContextDefinitionInterface
getContextDefinition(string $name)
Gets a specific context definition of the plugin.
array
getContexts()
Gets the defined contexts.
ContextInterface
getContext(string $name)
Gets a defined context.
setContext(string $name, ContextInterface $context)
Set a context on this plugin.
array
getContextValues()
Gets the values for all defined contexts.
mixed
getContextValue(string $name)
Gets the value for a defined context.
$this
setContextValue(string $name, mixed $value)
Sets the value for a defined context.
ConstraintViolationListInterface
validateContexts()
Validates the set values for the defined contexts.
$this
setTypedDataManager(TypedDataManagerInterface $typed_data_manager)
Sets the typed data manager.
TypedDataManagerInterface
getTypedDataManager()
Gets the typed data manager.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
array
getContextMapping()
Gets a mapping of the expected assignment names to their context names.
$this
setContextMapping(array $context_mapping)
Sets a mapping of the expected assignment names to their context names.
protected ContextHandlerInterface
contextHandler()
Wraps the context handler.
string[]
getCacheContexts()
The cache contexts associated with this object.
These identify a specific variation/representation of the object.
Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.
string[]
getCacheTags()
The cache tags associated with this object.
When this object is modified, these cache tags will be invalidated.
int
getCacheMaxAge()
The maximum age for which this object may be cached.
DataDefinitionInterface[]
getConfigDefinitions()
Gets an array of definitions of available configuration options.
DataDefinitionInterface|false
getConfigDefinition(string $key)
Gets the definition of a configuration option.
array
getConfig()
Gets all configuration values.
$this
setConfig(string $key, mixed $value)
Sets the value of a particular configuration option.
protected array
addContextAssignmentElement(ContextAwarePluginInterface $plugin, array $contexts)
Builds a form element for assigning a context to a given slot.
bool
isNegated()
Determines whether condition result will be negated.
array
buildConfigurationForm(array $form, FormStateInterface $form_state)
Form constructor.
Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and
array_parents, see \Drupal\Core\Render\Element\FormElement.
validateConfigurationForm(array $form, FormStateInterface $form_state)
Form validation handler.
submitConfigurationForm(array $form, FormStateInterface $form_state)
Form submission handler.
execute()
Executes the plugin.
array
getConfiguration()
Gets this plugin's configuration.
setConfiguration(array $configuration)
Sets the configuration for this plugin instance.
array
defaultConfiguration()
Gets default configuration for this plugin.
array
calculateDependencies()
Calculates dependencies for the configured plugin.
Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.
setExecutableManager(ExecutableManagerInterface $executableManager)
Sets the executable manager class.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
summary()
Provides a human readable summary of the condition's configuration.
bool
evaluate()
Evaluates the condition and returns TRUE or FALSE accordingly.