BanIpManager.php

Same filename and directory in other branches
  1. 9 core/modules/ban/src/BanIpManager.php
  2. 8.9.x core/modules/ban/src/BanIpManager.php
  3. 11.x core/modules/ban/src/BanIpManager.php

Namespace

Drupal\ban

File

core/modules/ban/src/BanIpManager.php

View source
<?php

namespace Drupal\ban;

use Drupal\Core\Database\Connection;

/**
 * Ban IP manager.
 */
class BanIpManager implements BanIpManagerInterface {
  
  /**
   * The database connection used to check the IP against.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;
  
  /**
   * Constructs a BanIpManager object.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection which will be used to check the IP against.
   */
  public function __construct(Connection $connection) {
    $this->connection = $connection;
  }
  
  /**
   * {@inheritdoc}
   */
  public function isBanned($ip) {
    return (bool) $this->connection
      ->query("SELECT * FROM {ban_ip} WHERE [ip] = :ip", [
      ':ip' => $ip,
    ])
      ->fetchField();
  }
  
  /**
   * {@inheritdoc}
   */
  public function findAll() {
    return $this->connection
      ->query('SELECT * FROM {ban_ip}');
  }
  
  /**
   * {@inheritdoc}
   */
  public function banIp($ip) {
    $this->connection
      ->merge('ban_ip')
      ->key('ip', $ip)
      ->fields([
      'ip' => $ip,
    ])
      ->execute();
  }
  
  /**
   * {@inheritdoc}
   */
  public function unbanIp($id) {
    $this->connection
      ->delete('ban_ip')
      ->condition('ip', $id)
      ->execute();
  }
  
  /**
   * {@inheritdoc}
   */
  public function findById($ban_id) {
    return $this->connection
      ->query("SELECT [ip] FROM {ban_ip} WHERE [iid] = :iid", [
      ':iid' => $ban_id,
    ])
      ->fetchField();
  }

}

Classes

Title Deprecated Summary
BanIpManager Ban IP manager.

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