You are here

Home » API reference » IP-based Determination of a Visitor's Country 8 » Ip2CountryResource.php

class Ip2CountryResource in IP-based Determination of a Visitor's Country 8

Provides a resource for looking up IP addresses.

Plugin annotation


@RestResource(
  id = "ip_lookup",
  label = @Translation("IP country lookup"),
  uri_paths = {
    "canonical" = "/ip2country/{ip_address}"
  }
)

Hierarchy

Expanded class hierarchy of Ip2CountryResource

File

src/Plugin/rest/resource/Ip2CountryResource.php, line 25

Namespace

Drupal\ip2country\Plugin\rest\resource
View source 
class Ip2CountryResource extends ResourceBase implements ContainerFactoryPluginInterface {

  /**
   * The ip2country.lookup service.
   *
   * @var \Drupal\ip2country\Ip2CountryLookupInterface
   */
  protected $ip2countryLookup;

  /**
   * Constructs a new Ip2CountryResource instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param array $serializer_formats
   *   The available serialization formats.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\ip2country\Ip2CountryLookupInterface $ip2countryLookup
   *   The Ip2Country lookup service manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, array $serializer_formats, LoggerInterface $logger, Ip2CountryLookupInterface $ip2countryLookup) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger);
    $this->ip2countryLookup = $ip2countryLookup;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->getParameter('serializer.formats'), $container
      ->get('logger.factory')
      ->get('rest'), $container
      ->get('ip2country.lookup'));
  }

  /**
   * Responds to GET requests for this Resource.
   *
   * @param string $ip_address
   *   The IP address to look up, formatted as a dotted quad (xxx.xxx.xxx.xxx).
   *
   * @return \Drupal\rest\ResourceResponse
   *   The response containing the 2-character ISO 3166-2 country code for
   *   the given IP address.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   Thrown when the IP address is not assigned to a country.
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   Thrown when the given IP address is not valid.
   */
  public function get($ip_address = NULL) {
    if (filter_var($ip_address, FILTER_VALIDATE_IP)) {
      $country_code = $this->ip2countryLookup
        ->getCountry($ip_address);
      if ($country_code) {
        return new ResourceResponse($country_code);
      }
      throw new NotFoundHttpException($this
        ->t('IP Address @ip is not assigned to a country.', [
        '@ip' => $ip_address,
      ]));
    }
    throw new BadRequestHttpException($this
      ->t('The IP address you entered is invalid. Please enter an address in the form xxx.xxx.xxx.xxx where xxx is between 0 and 255 inclusive.'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
Ip2CountryResource::$ip2countryLookup protected property The ip2country.lookup service.
Ip2CountryResource::create public static function Creates an instance of the plugin. Overrides ResourceBase::create
Ip2CountryResource::get public function Responds to GET requests for this Resource.
Ip2CountryResource::__construct public function Constructs a new Ip2CountryResource instance. Overrides ResourceBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ResourceBase::$logger protected property A logger instance.
ResourceBase::$serializerFormats protected property The available serialization formats.
ResourceBase::availableMethods public function Returns the available HTTP request methods on this plugin. Overrides ResourceInterface::availableMethods 1
ResourceBase::getBaseRoute protected function Gets the base route for a particular method. 2
ResourceBase::getBaseRouteRequirements protected function Gets the base route requirements for a particular method. 1
ResourceBase::permissions public function Implements ResourceInterface::permissions(). Overrides ResourceInterface::permissions 2
ResourceBase::requestMethods protected function Provides predefined HTTP request methods.
ResourceBase::routes public function Returns a collection of routes with URL path information for the resource. Overrides ResourceInterface::routes
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.