You are here

Home » API reference » Automatic IP ban (Autoban) 8 » AutobanBanForm.php

class AutobanBanForm in Automatic IP ban (Autoban) 8

Displays banned IP addresses.

Hierarchy

Expanded class hierarchy of AutobanBanForm

1 string reference to 'AutobanBanForm'
autoban.routing.yml in ./autoban.routing.yml
autoban.routing.yml

File

src/Form/AutobanBanForm.php, line 17

Namespace

Drupal\autoban\Form
View source 
class AutobanBanForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The autoban object.
   *
   * @var \Drupal\autoban\Controller\AutobanController
   */
  protected $autoban;

  /**
   * Construct the AutobanBanForm.
   *
   * @param \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
   *   Entity type manager.
   * @param \Drupal\autoban\Controller\AutobanController $autoban
   *   Autoban object.
   */
  public function __construct(EntityTypeManager $entity_type_manager, AutobanController $autoban) {
    $this->entityTypeManager = $entity_type_manager;
    $this->autoban = $autoban;
  }

  /**
   * Factory method for AutobanBanForm.
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('autoban'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $rule = '') {
    if (!$rule) {
      $rules = $this->entityTypeManager
        ->getStorage('autoban')
        ->loadMultiple();
      if (empty($rules)) {
        $this
          ->messenger()
          ->addMessage($this
          ->t('No rules for ban'), 'warning');
        return new RedirectResponse(Url::fromRoute('entity.autoban.list')
          ->toString());
      }
    }
    $form['message'] = [
      '#markup' => $rule ? $this
        ->t('The IP addresses for rule %rule will be banned.', [
        '%rule' => $rule,
      ]) : $this
        ->t('The IP addresses for all rules will be banned.'),
    ];
    $form['rule'] = [
      '#type' => 'hidden',
      '#value' => $rule,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $rule ? $this
        ->t('Ban') : $this
        ->t('Ban all'),
    ];
    $destination = $this
      ->getDestinationArray();
    $cancel_url = !empty($destination['destination']) && Url::fromRoute('<current>')
      ->toString() != $destination['destination'] ? Url::fromUserInput($destination['destination']) : Url::fromRoute('entity.autoban.list');
    $cancel_link = Link::fromTextAndUrl($this
      ->t('Cancel'), $cancel_url)
      ->toString();
    $form['actions']['cancel'] = [
      '#markup' => $cancel_link,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $rule = trim($form_state
      ->getValue('rule'));
    if (empty($rule)) {
      $rules = $this->entityTypeManager
        ->getStorage('autoban')
        ->loadMultiple();
      if (empty($rules)) {
        return;
      }
      foreach (array_keys($rules) as $rule_id) {
        $operations[] = [
          '\\Drupal\\autoban\\AutobanBatch::ipBan',
          [
            $rule_id,
          ],
        ];
      }
      $batch = [
        'title' => $this
          ->t('IP ban'),
        'operations' => $operations,
        'finished' => '\\Drupal\\autoban\\AutobanBatch::ipBanFinished',
        'file' => drupal_get_path('module', 'autoban') . '/AutobanBatch.php',
      ];
      batch_set($batch);
      $form_state
        ->setRedirect('entity.autoban.list');
    }
    else {
      $controller = $this->autoban;
      $banned_ip = $controller
        ->getBannedIp($rule);
      if (empty($banned_ip)) {
        $this
          ->messenger()
          ->addMessage($this
          ->t('No banned IP addresses for rule %rule.', [
          '%rule' => $rule,
        ]), 'warning');
        return;
      }
      $banned = $controller
        ->banIpList($banned_ip, $rule);
      if ($banned > 0) {
        $message = $this
          ->t('The IP addresses for rule %rule has been banned. Count: %count', [
          '%rule' => $rule,
          '%count' => $banned,
        ]);
      }
      else {
        $message = $this
          ->t('No banned IP addresses for rule %rule', [
          '%rule' => $rule,
        ]);
      }
      $this
        ->messenger()
        ->addMessage($message);
      $this
        ->getLogger('autoban')
        ->notice($message);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AutobanBanForm::$autoban protected property The autoban object.
AutobanBanForm::$entityTypeManager protected property The entity type manager.
AutobanBanForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AutobanBanForm::create public static function Factory method for AutobanBanForm. Overrides FormBase::create
AutobanBanForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AutobanBanForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AutobanBanForm::__construct public function Construct the AutobanBanForm.
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.