class RulesBanActionBase

Provides a base class for rules module IP ban actions.

Hierarchy

Expanded class hierarchy of RulesBanActionBase

File

src/Plugin/RulesAction/RulesBanActionBase.php, line 15

Namespace

Drupal\rules\Plugin\RulesAction
View source
abstract class RulesBanActionBase extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * The ban manager.
     *
     * @var \Drupal\ban\BanIpManagerInterface
     */
    protected $banManager;
    
    /**
     * The corresponding request stack.
     *
     * @var \Symfony\Component\HttpFoundation\RequestStack
     */
    protected $requestStack;
    
    /**
     * The logger channel the action will write log messages to.
     *
     * @var \Drupal\Core\Logger\LoggerChannelInterface
     */
    protected $logger;
    
    /**
     * Constructs the RulesBanActionBase 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\ban\BanIpManagerInterface $ban_manager
     *   The ban manager.
     * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
     *   The corresponding request stack.
     * @param \Drupal\Core\Logger\LoggerChannelInterface $logger
     *   The Rules logger channel.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, BanIpManagerInterface $ban_manager, RequestStack $request_stack, LoggerChannelInterface $logger) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->banManager = $ban_manager;
        $this->requestStack = $request_stack;
        $this->logger = $logger;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('ban.ip_manager'), $container->get('request_stack'), $container->get('logger.factory')
            ->get('rules'));
    }

}

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.
RulesBanActionBase::$banManager protected property The ban manager.
RulesBanActionBase::$logger protected property The logger channel the action will write log messages to.
RulesBanActionBase::$requestStack protected property The corresponding request stack.
RulesBanActionBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RulesBanActionBase::__construct public function Constructs the RulesBanActionBase object.