You are here

Home » API reference » IP Geolocation Views & Maps 8 » IpLookupForm.php

class IpLookupForm in IP Geolocation Views & Maps 8

Pending doc.

Hierarchy

Expanded class hierarchy of IpLookupForm

File

src/Form/IpLookupForm.php, line 12

Namespace

Drupal\ip_geoloc\Form
View source 
class IpLookupForm extends FormBase {
  protected $ipGeolocApi;

  /**
   * Create the form, adds dependency injection.
   */
  public function __construct(ConfigFactoryInterface $config_factory, IpGeoLocAPI $ipGeolocApi) {
    parent::__construct($config_factory);
    $this->ipGeolocApi = $ipGeolocApi;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'ip_geoloc_ip_lookup_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Migration comment:  Part of ip_geoloc_set_location_form definition.
    $config = \Drupal::config('ip_geoloc.settings');
    $last_visit = $form_state
      ->has('last_visit') ? $form_state
      ->get('last_visit') : '';
    $formatted_address = $form_state
      ->has('formatted_address') ? $form_state
      ->get('formatted_address') : '';
    if (!empty($last_visit) || !empty($formatted_address)) {
      $prefix = '<div class="ip_geoloc_address_lookup">' . $formatted_address . (empty($last_visit) ? '' : "<br/>{$last_visit}") . '</div>';
    }
    $form['ip_address'] = [
      '#type' => 'textfield',
      '#title' => t('IP address'),
      '#default_value' => '',
      '#size' => 16,
      '#required' => FALSE,
      '#prefix' => isset($prefix) ? $prefix : NULL,
    ];
    if (user_access('administer site configuration') && $config
      ->get('ip_geoloc_store_addresses') ? $config
      ->get('ip_geoloc_store_addresses') : TRUE) {
      $form['store'] = [
        '#type' => 'checkbox',
        '#title' => t('If found, store on IP geolocation database for future reference.'),
        '#default_value' => FALSE,
      ];
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => t('Lookup'),
      '#submit' => [
        'ip_geoloc_ip_lookup_submit',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Migration comment:  Part of _ip_geoloc_process_go_to_submit for submiting ip_geoloc_set_location_form
    // $form_state->set(['storage', 'value'], 'something');.
    $store = !empty($form_state
      ->getStorage());
    $location = $this->ipGeolocApi
      ->getLocationByIp(trim($form_state
      ->get('ip_address'), TRUE, $store));
    $connection = \Drupal::database();

    // @TODO Acesslog table doesn't exist for d8
    if ($connection
      ->schema()
      ->tableExists('accesslog')) {
      $last_visit = $connection
        ->query('SELECT MAX(timestamp) FROM {accesslog} WHERE hostname = :ip_address', [
        ':ip_address' => $location['ip_address'],
      ])
        ->fetchField();
      if ($last_visit) {
        $last_visit = format_date($last_visit, 'short');
        $form_state
          ->set([
          'storage',
          'value',
        ], 'last_visit');
        $form_state
          ->set([
          'storage',
          $this
            ->t('<strong>Last visit:</strong> %date', [
            '%date' => $last_visit,
          ]),
        ], 'last_visit');
      }
    }
    $formatted_address = isset($location['formatted_address']) ? t('%ip: <strong>%address</strong>', [
      '%ip' => $location['ip_address'],
      '%address' => $location['formatted_address'],
    ]) : '';
    $form_state
      ->set([
      'storage',
      $formatted_address,
    ], 'formatted_address');

    // To preserve entered values and storage array.
    $form_state
      ->setRebuild();
  }

}

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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
IpLookupForm::$ipGeolocApi protected property
IpLookupForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
IpLookupForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
IpLookupForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
IpLookupForm::__construct public function Create the form, adds dependency injection.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.