class BanIp

Provides the 'Ban IP' action.

@todo Add access callback information from Drupal 7. @todo We should maybe use a dedicated data type for the ip address, as we do in Drupal 7.

Plugin annotation

@RulesAction(
  id = "rules_ban_ip",
  label = @Translation("Ban an IP address"),
  category = @Translation("Ban"),
  provider = "ban",
  context_definitions = {
    "ip" = @ContextDefinition("string",
      label = @Translation("IP Address"),
      description = @Translation("Ban an IP address using the Ban Module. If no IP is provided, the current user IP is used."),
      default_value = NULL,
      required = FALSE
    ),
  }
)

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\RulesBanActionBase extends \Drupal\rules\Core\RulesActionBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
        • class \Drupal\rules\Plugin\RulesAction\BanIp extends \Drupal\rules\Plugin\RulesAction\RulesBanActionBase

Expanded class hierarchy of BanIp

File

src/Plugin/RulesAction/BanIp.php, line 27

Namespace

class BanIp extends RulesBanActionBase {
    
    /**
     * Executes the BanIP action with the given context.
     *
     * @param string $ip
     *   (optional) The IP address that should be banned.
     */
    protected function doExecute($ip = NULL) {
        if (!isset($ip)) {
            $ip = $this->requestStack
                ->getCurrentRequest()
                ->getClientIp();
        }
        $this->banManager
            ->banIp($ip);
        $this->logger
            ->notice('Banned IP address %ip', [
            '%ip' => $ip,
        ]);
    }

}

Members