BanDelete.php

Contains \Drupal\ban\Form\BanDelete.

Namespace

Drupal\ban\Form

File

drupal/core/modules/ban/lib/Drupal/ban/Form/BanDelete.php
View source
<?php

/**
 * @file
 * Contains \Drupal\ban\Form\BanDelete.
 */
namespace Drupal\ban\Form;

use Drupal\Core\Controller\ControllerInterface;
use Drupal\Core\Form\ConfirmFormBase;
use Drupal\ban\BanIpManager;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Provides a form to unban IP addresses.
 */
class BanDelete extends ConfirmFormBase implements ControllerInterface {

  /**
   * The banned IP address.
   *
   * @var string
   */
  protected $banIp;

  /**
   * Constructs a new BanDelete object.
   *
   * @param \Drupal\ban\BanIpManager $ip_manager
   */
  public function __construct(BanIpManager $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_delete_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getQuestion() {
    return t('Are you sure you want to unblock %ip?', array(
      '%ip' => $this->banIp,
    ));
  }

  /**
   * {@inheritdoc}
   */
  protected function getConfirmText() {
    return t('Delete');
  }

  /**
   * {@inheritdoc}
   */
  protected function getCancelPath() {
    return 'admin/config/people/ban';
  }

  /**
   * {@inheritdoc}
   *
   * @param string $ban_id
   *   The IP address record ID to unban.
   */
  public function buildForm(array $form, array &$form_state, $ban_id = '') {
    if (!($this->banIp = $this->ipManager
      ->findById($ban_id))) {
      throw new NotFoundHttpException();
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, array &$form_state) {
    $this->ipManager
      ->unbanIp($this->banIp);
    watchdog('user', 'Deleted %ip', array(
      '%ip' => $this->banIp,
    ));
    drupal_set_message(t('The IP address %ip was deleted.', array(
      '%ip' => $this->banIp,
    )));
    $form_state['redirect'] = 'admin/config/people/ban';
  }

}

Classes

Namesort descending Description
BanDelete Provides a form to unban IP addresses.