class ClientLocation in Geolocation Field 8.2

Location based proximity center.

Plugin annotation

@LocationInput(
  id = "client_location",
  name = @Translation("Client location"),
  description = @Translation("If client provides location, use it."),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geolocation\LocationInputBase implements ContainerFactoryPluginInterface, LocationInputInterface
      • class \Drupal\geolocation\Plugin\geolocation\LocationInput\ClientLocation implements LocationInputInterface

File

src/Plugin/geolocation/LocationInput/ClientLocation.php, line 17

Namespace

Drupal\geolocation\Plugin\geolocation\LocationInput

class ClientLocation extends LocationInputBase implements LocationInputInterface {

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    $settings = parent::getDefaultSettings();
    $settings['auto_submit'] = FALSE;
    $settings['hide_form'] = FALSE;
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm($option_id = NULL, array $settings = [], $context = NULL) {
    $settings = $this
      ->getSettings($settings);
    $form = parent::getSettingsForm($option_id, $settings, $context);
    $form['auto_submit'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Auto-submit form'),
      '#default_value' => $settings['auto_submit'],
      '#description' => $this
        ->t('Only triggers if location could be set'),
    ];
    $form['hide_form'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide coordinates form'),
      '#default_value' => $settings['hide_form'],
    ];
    $form['#description'] = $this
      ->t('Location will be set if it is empty and client location is available. This requires a https connection.');
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getForm($center_option_id, array $center_option_settings, $context = NULL, array $default_value = NULL) {
    $form = parent::getForm($center_option_id, $center_option_settings, $context, $default_value);
    $identifier = uniqid($center_option_id);
    if (!empty($form['coordinates'])) {
      $form['coordinates']['#attributes'] = [
        'class' => [
          $identifier,
          'location-input-client-location',
        ],
      ];
      $form['coordinates']['#attached'] = [
        'library' => [
          'geolocation/location_input.client_location',
        ],
        'drupalSettings' => [
          'geolocation' => [
            'locationInput' => [
              'clientLocation' => [
                [
                  'identifier' => $identifier,
                  'autoSubmit' => $center_option_settings['auto_submit'],
                  'hideForm' => $center_option_settings['hide_form'],
                ],
              ],
            ],
          ],
        ],
      ];
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ClientLocation::getDefaultSettings	public static	function	Provide a populated settings array. Overrides LocationInputBase::getDefaultSettings
ClientLocation::getForm	public	function	Get center form. Overrides LocationInputBase::getForm
ClientLocation::getSettingsForm	public	function	Settings form by ID and context. Overrides LocationInputBase::getSettingsForm
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
LocationInputBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
LocationInputBase::getAvailableLocationInputOptions	public	function	For one LocationInput (i.e. boundary filter), return all options. Overrides LocationInputInterface::getAvailableLocationInputOptions	1
LocationInputBase::getCoordinates	public	function	Get center value. Overrides LocationInputInterface::getCoordinates	2
LocationInputBase::getSettings	public	function	Provide LocationInput option specific settings. Overrides LocationInputInterface::getSettings
LocationInputBase::validateSettingsForm	public	function
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.