BanIpManagerInterface.php

Same filename in other branches
  1. 9 core/modules/ban/src/BanIpManagerInterface.php
  2. 8.9.x core/modules/ban/src/BanIpManagerInterface.php
  3. 10 core/modules/ban/src/BanIpManagerInterface.php

Namespace

Drupal\ban

File

core/modules/ban/src/BanIpManagerInterface.php

View source
<?php

namespace Drupal\ban;


/**
 * Provides an interface defining a BanIp manager.
 */
interface BanIpManagerInterface {
    
    /**
     * Returns if this IP address is banned.
     *
     * @param string $ip
     *   The IP address to check.
     *
     * @return bool
     *   TRUE if the IP address is banned, FALSE otherwise.
     */
    public function isBanned($ip);
    
    /**
     * Finds all banned IP addresses.
     *
     * @return \Drupal\Core\Database\StatementInterface
     *   The result of the database query.
     */
    public function findAll();
    
    /**
     * Bans an IP address.
     *
     * @param string $ip
     *   The IP address to ban.
     */
    public function banIp($ip);
    
    /**
     * Removes the ban of an IP address.
     *
     * @param string $id
     *   The IP address to unban.
     */
    public function unbanIp($id);
    
    /**
     * Finds a banned IP address by its ID.
     *
     * @param int $ban_id
     *   The ID for a banned IP address.
     *
     * @return string|false
     *   Either the banned IP address or FALSE if none exist with that ID.
     */
    public function findById($ban_id);

}

Interfaces

Title Deprecated Summary
BanIpManagerInterface Provides an interface defining a BanIp manager.

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