You are here

interface AutobanProviderInterface in Automatic IP ban (Autoban) 8

Provides an interface defining a AutobanProvider.

Hierarchy

Expanded class hierarchy of AutobanProviderInterface

All classes that implement AutobanProviderInterface

3 files declare their use of AutobanProviderInterface
AdvbanProvider.php in modules/autoban_advban/src/AdvbanProvider.php
AdvbanRangeProvider.php in modules/autoban_advban/src/AdvbanRangeProvider.php
BanProvider.php in modules/autoban_ban/src/BanProvider.php

File

src/AutobanProviderInterface.php, line 10

Namespace

Drupal\autoban
View source
interface AutobanProviderInterface {

  /**
   * Get BanProvider id for store in autoban rule.
   *
   * @return string
   *   Ban provider ID.
   */
  public function getId();

  /**
   * Get BanProvider name for choice list.
   *
   * @return string
   *   Human name for user select.
   */
  public function getName();

  /**
   * Get Ban type: single, range and so on.
   *
   * @return string
   *   Human name for ban type.
   */
  public function getBanType();

  /**
   * Get BanIpManager object.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection which will be used get BanIpManager.
   *
   * @return object
   *   BanIpManager object.
   */
  public function getBanIpManager(Connection $connection);

}

Members

Namesort descending Modifiers Type Description Overrides
AutobanProviderInterface::getBanIpManager public function Get BanIpManager object. 3
AutobanProviderInterface::getBanType public function Get Ban type: single, range and so on. 3
AutobanProviderInterface::getId public function Get BanProvider id for store in autoban rule. 3
AutobanProviderInterface::getName public function Get BanProvider name for choice list. 3