You are here

class AdvbanDeleteAll in Advanced ban 8

Provides a form to unban IP addresses.

Hierarchy

Expanded class hierarchy of AdvbanDeleteAll

1 string reference to 'AdvbanDeleteAll'
advban.routing.yml in ./advban.routing.yml
advban.routing.yml

File

src/Form/AdvbanDeleteAll.php, line 13

Namespace

Drupal\advban\Form
View source
class AdvbanDeleteAll extends FormBase {

  /**
   * The IP manager.
   *
   * @var \Drupal\advban\AdvbanIpManagerInterface
   */
  protected $ipManager;

  /**
   * Constructs a new BanDelete object.
   *
   * @param \Drupal\advban\AdvbanIpManagerInterface $ip_manager
   *   The IP manager.
   */
  public function __construct(AdvbanIpManagerInterface $ip_manager) {
    $this->ipManager = $ip_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('advban.ip_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'advban_ip_delete_all_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = [];
    $form['advban_delete_range'] = [
      '#title' => $this
        ->t('Delete all simple/range IP'),
      '#options' => [
        'all' => $this
          ->t('Delete all'),
        'simple' => $this
          ->t('Delete all simple IP only'),
        'range' => $this
          ->t('Delete all range IP only'),
      ],
      '#type' => 'radios',
      '#required' => TRUE,
    ];
    $form['advban_delete_expire'] = [
      '#title' => $this
        ->t('Delete all expired IP'),
      '#options' => [
        'all' => $this
          ->t('Delete all'),
        'expired' => $this
          ->t('Delete expired IP only'),
        'not_expired' => $this
          ->t('Delete not expired IP only'),
      ],
      '#type' => 'radios',
      '#required' => TRUE,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $params = [
      'range' => $form_state
        ->getValue('advban_delete_range'),
      'expire' => $form_state
        ->getValue('advban_delete_expire'),
    ];
    $deleted = $this->ipManager
      ->unbanIpAll($params);
    if ($deleted > 0) {
      $this
        ->logger('advanced ban')
        ->notice('Deleted all IP');
      $this
        ->messenger()
        ->addMessage($this
        ->t('Checked IP addresses groups were deleted.'));
    }
    else {
      $this
        ->messenger()
        ->addMessage($this
        ->t('No IP addresses for delete.'));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdvbanDeleteAll::$ipManager protected property The IP manager.
AdvbanDeleteAll::buildForm public function Form constructor. Overrides FormInterface::buildForm
AdvbanDeleteAll::create public static function Instantiates a new instance of this class. Overrides FormBase::create
AdvbanDeleteAll::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdvbanDeleteAll::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AdvbanDeleteAll::__construct public function Constructs a new BanDelete object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.