Ip2CountryLookupInterface.php in IP-based Determination of a Visitor's Country 8

Namespace

Drupal\ip2country

File

src/Ip2CountryLookupInterface.php

<?php

namespace Drupal\ip2country;


/**
 * Interface for Ip2CountryLookup.
 */
interface Ip2CountryLookupInterface {

  /**
   * Gets the ISO 3166 2-character country code from the IP address.
   *
   * @param string|int|null $ip_address
   *   IP address either as a dotted quad string (e.g. "127.0.0.1") or
   *   as a 32-bit unsigned long integer.
   *
   * @return string|false
   *   ISO 3166-1 2-character country code for this IP address, or
   *   FALSE if the lookup failed to find a country.
   */
  public function getCountry($ip_address = NULL);

}

Interfaces

Name	Description
Ip2CountryLookupInterface	Interface for Ip2CountryLookup.