You are here

Home » API reference » Advanced ban 8 » AdvbanSearchForm.php

class AdvbanSearchForm in Advanced ban 8

Search banned IP addresses.

Hierarchy

Expanded class hierarchy of AdvbanSearchForm

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

File

src/Form/AdvbanSearchForm.php, line 16

Namespace

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

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

  /**
   * Date formatter variable.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * The time service.
   *
   * @var \Drupal\Component\Datetime\Time
   */
  protected $time;

  /**
   * Constructs AdvbanSearch form.
   *
   * @param \Drupal\advban\AdvbanIpManager $ip_manager
   *   Store AdvbanIpManager manager.
   * @param \Drupal\Core\Datetime\DateFormatter $dateFormatter
   *   Store DateFormatter manager.
   * @param \Drupal\Component\Datetime\Time $time
   *   The time service.
   */
  public function __construct(AdvbanIpManager $ip_manager, DateFormatter $dateFormatter, Time $time) {
    $this->ipManager = $ip_manager;
    $this->dateFormatter = $dateFormatter;
    $this->time = $time;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $params = $this
      ->getRequest()->query
      ->all();
    $ip = !empty($params['ip']) ? $params['ip'] : '';
    $form = [];
    $form['ip'] = [
      '#title' => $this
        ->t('IP address'),
      '#type' => 'textfield',
      '#required' => TRUE,
      '#size' => 48,
      '#maxlength' => 40,
      '#default_value' => $ip,
      '#description' => $this
        ->t('Enter a valid IP address.'),
    ];
    if (!empty($ip)) {
      $ip_data = $this->ipManager
        ->isBanned($ip, [
        'expiry_check' => FALSE,
        'info_output' => TRUE,
        'no_limit' => TRUE,
      ]);
      if ($ip_data['is_banned']) {
        $header = [
          $this
            ->t('Banned IP addresses'),
          $this
            ->t('Expiration time'),
          $this
            ->t('Status'),
          $this
            ->t('Operations'),
        ];
        $rows = [];
        $ip_data_iid = $ip_data['iid'];
        if (!is_array($ip_data_iid)) {
          $ip_data_iid = [
            $ip_data_iid,
          ];
        }
        foreach ($ip_data_iid as $iid) {
          $ip_full_data = $this->ipManager
            ->findById($iid);
          if ($ip_full_data) {
            if (is_array($ip_full_data)) {
              $ip_full_data = reset($ip_full_data);
            }
            $row = $this
              ->searchResult($ip_full_data);
            $rows[] = $row;
          }
        }
        $form['ban_ip_result'] = [
          '#type' => 'table',
          '#header' => $header,
          '#rows' => $rows,
          '#empty' => $this
            ->t('No blocked IP addresses available.'),
          '#weight' => 120,
        ];
      }
      else {
        $this
          ->messenger()
          ->addMessage($this
          ->t('IP address @ip has not been banned', [
          '@ip' => $ip,
        ]), 'warning');
      }
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Search'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $ip = trim($form_state
      ->getValue('ip'));
    if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_NO_RES_RANGE) == FALSE) {
      $form_state
        ->setErrorByName('ip', $this
        ->t('Enter a valid IP address.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $ip = trim($form_state
      ->getValue('ip'));
    if (!empty($ip)) {
      $form_state
        ->setRedirect('advban.search', [
        'ip' => $ip,
      ]);
    }
  }

  /**
   * Make table formatted search result.
   *
   * @param object $ip
   *   IP entry object.
   *
   * @return array
   *   Row for table formatter.
   */
  private function searchResult($ip) {
    $row = [];
    $row[] = $this->ipManager
      ->formatIp($ip->ip, $ip->ip_end);
    $row[] = empty($ip->expiry_date) ? $this
      ->t('Never') : $this->dateFormatter
      ->format($ip->expiry_date);
    $status = $this
      ->t('Banned');
    if (!empty($ip->expiry_date) && $ip->expiry_date <= $this->time
      ->getRequestTime()) {

      // This IP is not banned and this advban entry will be deleted by cron.
      $status = $this
        ->t('Expired');
    }
    $row[] = $status;
    $destination = $this
      ->getDestinationArray();
    $url_destination = [
      'destination' => $destination['destination'],
    ];
    $query = [
      'query' => [
        $url_destination,
      ],
    ];
    $links = [];
    $links['edit'] = [
      'title' => $this
        ->t('Edit'),
      'url' => Url::fromRoute('advban.admin_page', [
        'ban_id' => $ip->iid,
      ], $query),
    ];
    $links['delete'] = [
      'title' => $this
        ->t('Delete'),
      'url' => Url::fromRoute('advban.delete', [
        'ban_id' => $ip->iid,
      ], $query),
    ];
    $row[] = [
      'data' => [
        '#type' => 'operations',
        '#links' => $links,
      ],
    ];
    return $row;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdvbanSearchForm::$dateFormatter protected property Date formatter variable.
AdvbanSearchForm::$ipManager protected property The IP manager.
AdvbanSearchForm::$time protected property The time service.
AdvbanSearchForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AdvbanSearchForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
AdvbanSearchForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdvbanSearchForm::searchResult private function Make table formatted search result.
AdvbanSearchForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AdvbanSearchForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
AdvbanSearchForm::__construct public function Constructs AdvbanSearch form.
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.
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.