RestrictIpMapperInterface.php in Restrict IP 3.x
Same filename and directory in other branches
Namespace
Drupal\restrict_ip\MapperFile
src/Mapper/RestrictIpMapperInterface.phpView source
<?php
namespace Drupal\restrict_ip\Mapper;
use Drupal\Core\Database\ConnectionInterface;
interface RestrictIpMapperInterface {
/**
* Retrieve a list of whitelisted IP addresses from the data source
*
* @return array
* An array of whitelisted IP addresses
*/
public function getWhitelistedIpAddresses();
/**
* Save whitelisted IP addresses to the database
*
* @param array $ip_addresses
* An array of IP addresses to be saved
* @param bool $overwriteExisting
* A boolean indicating whether existing IP addresses should be deleted before saving
*/
public function saveWhitelistedIpAddresses(array $ip_addresses, $overwriteExisting = TRUE);
/**
* Retrieve a list of whitelisted paths from the data source
*
* @return array
* An array of whitelisted paths
*/
public function getWhitelistedPaths();
/**
* Save paths to be whitelisted to the database
*
* @param array $whitelistedPaths
* An array of paths to be saved for whitelisting
* @param bool $overwriteExisting
* A boolean indicating whether existing whitelisted paths should be deleted before saving
*/
public function saveWhitelistedPaths(array $whitelistedPaths, $overwriteExisting = TRUE);
/**
* Retrieve a list of blacklisted paths from the data source
*
* @return array
* An array of blacklisted paths
*/
public function getBlacklistedPaths();
/**
* Save paths to be blacklisted to the database
*
* @param array $blacklistedPaths
* An array of paths to be saved for blacklisting
* @param bool $overwriteExisting
* A boolean indicating whether existing blacklisted paths should be deleted before saving
*/
public function saveBlacklistedPaths(array $blacklistedPaths, $overwriteExisting = TRUE);
}
Interfaces
Name | Description |
---|---|
RestrictIpMapperInterface |