class BanIpManager

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

Ban IP manager.

Hierarchy

Expanded class hierarchy of BanIpManager

1 file declares its use of BanIpManager
IpAddressBlockingTest.php in core/modules/ban/tests/src/Functional/IpAddressBlockingTest.php
1 string reference to 'BanIpManager'
ban.services.yml in core/modules/ban/ban.services.yml
core/modules/ban/ban.services.yml
1 service uses BanIpManager
ban.ip_manager in core/modules/ban/ban.services.yml
Drupal\ban\BanIpManager

File

core/modules/ban/src/BanIpManager.php, line 10

Namespace

Drupal\ban
View source 
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();
    }

}

Members

Title Modifiers Object type Summary Overriden Title
BanIpManager::$connection protected property The database connection used to check the IP against.
BanIpManager::banIp public function Bans an IP address. Overrides BanIpManagerInterface::banIp
BanIpManager::findAll public function Finds all banned IP addresses. Overrides BanIpManagerInterface::findAll
BanIpManager::findById public function Finds a banned IP address by its ID. Overrides BanIpManagerInterface::findById
BanIpManager::isBanned public function Returns if this IP address is banned. Overrides BanIpManagerInterface::isBanned
BanIpManager::unbanIp public function Unbans an IP address. Overrides BanIpManagerInterface::unbanIp
BanIpManager::__construct public function Constructs a BanIpManager object.

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