class BanAdmin

Same name in other branches
  1. 9 core/modules/ban/src/Form/BanAdmin.php \Drupal\ban\Form\BanAdmin
  2. 8.9.x core/modules/ban/src/Form/BanAdmin.php \Drupal\ban\Form\BanAdmin
  3. 10 core/modules/ban/src/Form/BanAdmin.php \Drupal\ban\Form\BanAdmin

Displays banned IP addresses.

@internal

Hierarchy

Expanded class hierarchy of BanAdmin

1 file declares its use of BanAdmin
BanAdminTest.php in core/modules/ban/tests/src/Unit/BanAdminTest.php
1 string reference to 'BanAdmin'
ban.routing.yml in core/modules/ban/ban.routing.yml
core/modules/ban/ban.routing.yml

File

core/modules/ban/src/Form/BanAdmin.php, line 16

Namespace

Drupal\ban\Form
View source
class BanAdmin extends FormBase {
    
    /**
     * @var \Drupal\ban\BanIpManagerInterface
     */
    protected $ipManager;
    
    /**
     * Constructs a new BanAdmin object.
     *
     * @param \Drupal\ban\BanIpManagerInterface $ip_manager
     *   The ban IP manager.
     */
    public function __construct(BanIpManagerInterface $ip_manager) {
        $this->ipManager = $ip_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('ban.ip_manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'ban_ip_form';
    }
    
    /**
     * {@inheritdoc}
     *
     * @param array $form
     *   A nested array form elements comprising the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param string $default_ip
     *   (optional) IP address to be passed on to
     *   \Drupal::formBuilder()->getForm() for use as the default value of the IP
     *   address form field.
     */
    public function buildForm(array $form, FormStateInterface $form_state, $default_ip = '') {
        $rows = [];
        $header = [
            $this->t('banned IP addresses'),
            $this->t('Operations'),
        ];
        $result = $this->ipManager
            ->findAll();
        foreach ($result as $ip) {
            $row = [];
            $row[] = $ip->ip;
            $links = [];
            $links['delete'] = [
                'title' => $this->t('Delete'),
                'url' => Url::fromRoute('ban.delete', [
                    'ban_id' => $ip->iid,
                ]),
            ];
            $row[] = [
                'data' => [
                    '#type' => 'operations',
                    '#links' => $links,
                ],
            ];
            $rows[] = $row;
        }
        $form['ip'] = [
            '#title' => $this->t('IP address'),
            '#type' => 'textfield',
            '#size' => 48,
            '#maxlength' => 40,
            '#default_value' => $default_ip,
            '#description' => $this->t('Enter a valid IP address.'),
        ];
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Add'),
        ];
        $form['ban_ip_banning_table'] = [
            '#type' => 'table',
            '#header' => $header,
            '#rows' => $rows,
            '#empty' => $this->t('No blocked IP addresses available.'),
            '#weight' => 120,
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        $ip = trim($form_state->getValue('ip'));
        if ($this->ipManager
            ->isBanned($ip)) {
            $form_state->setErrorByName('ip', $this->t('This IP address is already banned.'));
        }
        elseif ($ip == $this->getRequest()
            ->getClientIP()) {
            $form_state->setErrorByName('ip', $this->t('You may not ban your own IP address.'));
        }
        elseif (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'));
        $this->ipManager
            ->banIp($ip);
        $this->messenger()
            ->addStatus($this->t('The IP address %ip has been banned.', [
            '%ip' => $ip,
        ]));
        $form_state->setRedirect('ban.admin_page');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BanAdmin::$ipManager protected property
BanAdmin::buildForm public function Overrides FormInterface::buildForm
BanAdmin::create public static function Instantiates a new instance of this class. Overrides FormBase::create
BanAdmin::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
BanAdmin::submitForm public function Form submission handler. Overrides FormInterface::submitForm
BanAdmin::validateForm public function Form validation handler. Overrides FormBase::validateForm
BanAdmin::__construct public function Constructs a new BanAdmin object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 2
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. 2
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user. 2
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.
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.
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.