class UnBanIp

Provides the 'Remove the ban on an IP address' 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_unban_ip",
  label = @Translation("Remove the ban on an IP address"),
  category = @Translation("Ban"),
  provider = "ban",
  context_definitions = {
    "ip" = @ContextDefinition("string",
      label = @Translation("IP Address"),
      description = @Translation("Removes the ban on 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 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\rules\Core\RulesActionBase extends \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait implements \Drupal\Core\Plugin\PluginBase
      • class \Drupal\rules\Plugin\RulesAction\RulesBanActionBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\rules\Core\RulesActionBase
        • class \Drupal\rules\Plugin\RulesAction\UnBanIp implements \Drupal\rules\Plugin\RulesAction\RulesBanActionBase

Expanded class hierarchy of UnBanIp

File

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

Namespace

class UnBanIp extends RulesBanActionBase {
  
  /**
   * Executes the UnBanIP action with the given context.
   *
   * @param string $ip
   *   (optional) The IP address for which the ban should be removed.
   */
  protected function doExecute($ip = NULL) {
    if (!isset($ip)) {
      $ip = $this->requestStack
        ->getCurrentRequest()
        ->getClientIp();
    }
    $this->banManager
      ->unbanIp($ip);
    $this->logger
      ->notice('Removed ban on IP address %ip', [
      '%ip' => $ip,
    ]);
  }

}

Members