You are here

function smart_ip_help in Smart IP 8.3

Same name and namespace in other branches
  1. 8.4 smart_ip.module \smart_ip_help()
  2. 8.2 smart_ip.module \smart_ip_help()
  3. 6.2 smart_ip.module \smart_ip_help()
  4. 6 smart_ip.module \smart_ip_help()
  5. 7.2 smart_ip.module \smart_ip_help()
  6. 7 smart_ip.module \smart_ip_help()

Implements hook_help().

File

./smart_ip.module, line 29
Determines country, geo location (longitude/latitude), region, city and postal code of the user, based on IP address

Code

function smart_ip_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.smart_ip':
      return $output = '<p>' . t("Smart IP identify visitor's geographical location (longitude/latitude), \n        country, region, city and postal code based on the IP address of the user. \n        These information will be stored at session variable (&#36;_SESSION) with \n        array key 'smart_ip' and Drupal user data service using the parameters \n        'smart_ip' as module and 'geoip_location' as name of the user but \n        optionally it can be disabled (by role) at Smart IP admin page. Other\n        modules can use the function \n        \\Drupal\\smart_ip\\SmartIp::query(&#36;ipAddress) that returns an array \n        containing the visitor's ISO 3166 2-character country code, longitude, \n        latitude, region, city and postal code. It provides a feature for you to \n        perform your own IP lookup and admin spoofing of an arbitrary IP for \n        testing purposes.") . '</p>';
      return $output;
    case 'smart_ip.settings':
      $output = '<p>' . t('Configure the Smart IP settings') . '</p>';
      return $output;
  }
  return '';
}