interface RestrictIpMapperInterface in Restrict IP 8

Hierarchy

• interface \Drupal\restrict_ip\Mapper\RestrictIpMapperInterface

1 file declares its use of RestrictIpMapperInterface

RestrictIpService.php in src/Service/RestrictIpService.php

File

src/Mapper/RestrictIpMapperInterface.php, line 7

Namespace

Drupal\restrict_ip\Mapper

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);

}

Members

Name	Modifiers	Type	Description	Overrides
RestrictIpMapperInterface::getBlacklistedPaths	public	function	* Retrieve a list of blacklisted paths from the data source * *	1
RestrictIpMapperInterface::getWhitelistedIpAddresses	public	function	* Retrieve a list of whitelisted IP addresses from the data source * *	1
RestrictIpMapperInterface::getWhitelistedPaths	public	function	* Retrieve a list of whitelisted paths from the data source * *	1
RestrictIpMapperInterface::saveBlacklistedPaths	public	function	* Save paths to be blacklisted to the database * *	1
RestrictIpMapperInterface::saveWhitelistedIpAddresses	public	function	* Save whitelisted IP addresses to the database * *	1
RestrictIpMapperInterface::saveWhitelistedPaths	public	function	* Save paths to be whitelisted to the database * *	1