class SystemPageRedirect
Provides "Page redirect" rules action.
Plugin annotation
@RulesAction(
id = "rules_page_redirect",
label = @Translation("Page redirect"),
category = @Translation("System"),
context_definitions = {
"url" = @ContextDefinition("string",
label = @Translation("URL"),
description = @Translation("A Drupal path, path alias, or external URL to redirect to. Enter (optional) queries after ? and (optional) anchor after #.")
),
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\rules\Core\RulesActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait
- class \Drupal\rules\Plugin\RulesAction\SystemPageRedirect extends \Drupal\rules\Core\RulesActionBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\rules\Core\RulesActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of SystemPageRedirect
File
-
src/
Plugin/ RulesAction/ SystemPageRedirect.php, line 27
Namespace
Drupal\rules\Plugin\RulesActionView source
class SystemPageRedirect extends RulesActionBase implements ContainerFactoryPluginInterface {
/**
* The Rules debug logger.
*
* @var \Drupal\Core\Logger\LoggerChannelInterface
*/
protected $logger;
/**
* The current path service.
*
* @var \Drupal\Core\Path\CurrentPathStack
*/
protected $currentPathStack;
/**
* The current request.
*
* @var null|\Symfony\Component\HttpFoundation\Request
*/
protected $request;
/**
* Constructs a SystemPageRedirect 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\Logger\LoggerChannelInterface $logger
* The logger channel.
* @param \Drupal\Core\Path\CurrentPathStack $current_path_stack
* The current path stack service.
* @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
* The request stack service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerChannelInterface $logger, CurrentPathStack $current_path_stack, RequestStack $request_stack) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->logger = $logger;
$this->currentPathStack = $current_path_stack;
$this->request = $request_stack->getCurrentRequest();
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('logger.channel.rules_debug'), $container->get('path.current'), $container->get('request_stack'));
}
/**
* Redirect to a provided url at the end of the request.
*
* @param string $url
* Redirect destination url.
*/
protected function doExecute($url) {
$current_path = $this->currentPathStack
->getPath();
$is_rules_admin_page = strpos($current_path, 'admin/config/workflow/rules') !== FALSE;
// Make sure we do not redirect away from the rules admin pages.
if ($is_rules_admin_page) {
$this->logger
->warning('Skipped page redirect on a rules admin page.');
return;
}
// Make sure we do not redirect during batch processing.
$batch = batch_get();
if (isset($batch['current_set'])) {
$this->logger
->warning('Skipped page redirect during batch processing.');
return;
}
$this->request->attributes
->set('_rules_redirect_action_url', $url);
}
}
Members
Title Sort descending | 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 | ||
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. | |||
SystemPageRedirect::$currentPathStack | protected | property | The current path service. | |||
SystemPageRedirect::$logger | protected | property | The Rules debug logger. | |||
SystemPageRedirect::$request | protected | property | The current request. | |||
SystemPageRedirect::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | ||
SystemPageRedirect::doExecute | protected | function | Redirect to a provided url at the end of the request. | |||
SystemPageRedirect::__construct | public | function | Constructs a SystemPageRedirect object. |