SmartIpLocationInterface.php in Smart IP 8.2
Same filename and directory in other branches
Namespace
Drupal\smart_ipFile
src/SmartIpLocationInterface.phpView source
<?php
/**
* @file
* Contains \Drupal\smart_ip\SmartIpLocationInterface.
*/
namespace Drupal\smart_ip;
/**
* Provides an interface for Smart IP's data location.
*
* @package Drupal\smart_ip
*/
interface SmartIpLocationInterface {
/**
* Source ID for pure Smart IP as geolocation source.
*/
const SMART_IP = 0;
/**
* Source ID for Google Map Geocoded Smart IP as geolocation source.
*/
const GEOCODED_SMART_IP = 1;
/**
* Source ID for W3C as geolocation source.
*/
const W3C = 2;
/**
* Sets the Smart IP location data..
*
* @param array $location
* An array of Smart IP location data.
*/
public function setData(array $location);
/**
* Sets an item in Smart IP location data.
*
* @param string $key
* Name of the item in Smart IP location data.
* @param mixed $value
* Value of the item of interest.
*/
public function set($key, $value);
/**
* Gets all the Smart IP location data.
*
* @return array
* An array of Smart IP location data.
*/
public function getData();
/**
* Gets an item in Smart IP location data or all the Smart IP location data
* if supplied no parameter.
*
* @param string $key
* Name of the item in Smart IP location data.
* @return mixed
* Value of the requested item in Smart IP location data or an array of it.
*/
public function get($key);
/**
* Saves the Smart IP location data to user data and session (for anonymous,
* saves to session only).
*/
public function save();
}
Interfaces
Name![]() |
Description |
---|---|
SmartIpLocationInterface | Provides an interface for Smart IP's data location. |