class LocationInputManager in Geolocation Field 8.2

Same name and namespace in other branches

8.3 src/LocationInputManager.php \Drupal\geolocation\LocationInputManager

Search plugin manager.

Hierarchy

class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
  - class \Drupal\geolocation\LocationInputManager

Expanded class hierarchy of LocationInputManager

3 files declare their use of LocationInputManager

ProximityFilter.php in src/Plugin/views/filter/ProximityFilter.php
ProximityFormField.php in src/Plugin/views/field/ProximityFormField.php
ViewsProximityFilter.php in src/Plugin/geolocation/Location/ViewsProximityFilter.php

1 string reference to 'LocationInputManager'

geolocation.services.yml in ./geolocation.services.yml: geolocation.services.yml

1 service uses LocationInputManager

plugin.manager.geolocation.locationinput in ./geolocation.services.yml: Drupal\geolocation\LocationInputManager

File

src/LocationInputManager.php, line 14

Namespace

Drupal\geolocation

View source

class LocationInputManager extends DefaultPluginManager {

  /**
   * Constructs an LocationInputManager object.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/geolocation/LocationInput', $namespaces, $module_handler, 'Drupal\\geolocation\\LocationInputInterface', 'Drupal\\geolocation\\Annotation\\LocationInput');
    $this
      ->alterInfo('geolocation_locationinput_info');
    $this
      ->setCacheBackend($cache_backend, 'geolocation_locationinput');
  }

  /**
   * Return LocationInput by ID.
   *
   * @param string $id
   *   LocationInput ID.
   * @param array $configuration
   *   Configuration.
   *
   * @return \Drupal\geolocation\LocationInputInterface|false
   *   LocationInput instance.
   */
  public function getLocationInputPlugin($id, array $configuration = []) {
    if (!$this
      ->hasDefinition($id)) {
      return FALSE;
    }
    try {

      /** @var \Drupal\geolocation\LocationInputInterface $instance */
      $instance = $this
        ->createInstance($id, $configuration);
      if ($instance) {
        return $instance;
      }
    } catch (\Exception $e) {
      return FALSE;
    }
    return FALSE;
  }

  /**
   * Get form render array.
   *
   * @param array $settings
   *   Settings.
   * @param mixed $context
   *   Optional context.
   *
   * @return array
   *   Form.
   */
  public function getOptionsForm(array $settings, $context = NULL) {
    $form = [
      '#type' => 'table',
      '#prefix' => t('<h3>Location input</h3>Each option will, if it can be applied, supersede any following option.'),
      '#header' => [
        [
          'data' => t('Enable'),
          'colspan' => 2,
        ],
        t('Option'),
        t('Settings'),
        t('Weight'),
      ],
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'geolocation-centre-option-weight',
        ],
      ],
    ];
    foreach ($this
      ->getDefinitions() as $location_input_id => $location_input_definition) {

      /** @var \Drupal\geolocation\LocationInputInterface $location_input */
      $location_input = $this
        ->createInstance($location_input_id);
      foreach ($location_input
        ->getAvailableLocationInputOptions($context) as $option_id => $label) {
        $option_enable_id = HTML::getUniqueId($option_id . '_enabled');
        $weight = isset($settings[$option_id]['weight']) ? $settings[$option_id]['weight'] : 0;
        $form[$option_id] = [
          '#weight' => $weight,
          '#attributes' => [
            'class' => [
              'draggable',
            ],
          ],
          'enable' => [
            '#attributes' => [
              'id' => $option_enable_id,
            ],
            '#type' => 'checkbox',
            '#default_value' => isset($settings[$option_id]['enable']) ? $settings[$option_id]['enable'] : FALSE,
          ],
          'location_input_id' => [
            '#type' => 'value',
            '#value' => $location_input_id,
          ],
          'option' => [
            '#markup' => $label,
          ],
          'settings' => [
            '#markup' => '',
          ],
          'weight' => [
            '#type' => 'weight',
            '#title' => t('Weight for @option', [
              '@option' => $label,
            ]),
            '#title_display' => 'invisible',
            '#size' => 4,
            '#default_value' => $weight,
            '#attributes' => [
              'class' => [
                'geolocation-centre-option-weight',
              ],
            ],
          ],
        ];
        $location_input_settings = [];
        if (!empty($settings[$option_id]['settings'])) {
          $location_input_settings = $settings[$option_id]['settings'];
        }
        $option_form = $location_input
          ->getSettingsForm($option_id, $location_input
          ->getSettings($location_input_settings), $context);
        if (!empty($option_form)) {
          $option_form['#states'] = [
            'visible' => [
              ':input[id="' . $option_enable_id . '"]' => [
                'checked' => TRUE,
              ],
            ],
          ];
          $option_form['#type'] = 'item';
          $form[$option_id]['settings'] = $option_form;
        }
      }
    }
    uasort($form, [
      SortArray::class,
      'sortByWeightProperty',
    ]);
    return $form;
  }

  /**
   * Get coordinates.
   *
   * @param array $form_values
   *   Form values.
   * @param array $settings
   *   Option settings.
   * @param mixed $context
   *   Context.
   *
   * @return array
   *   Centre value.
   */
  public function getCoordinates(array $form_values, array $settings, $context = NULL) {
    $coordinates = [];
    foreach ($settings as $option_id => $option) {

      // Ignore if not enabled.
      if (empty($option['enable'])) {
        continue;
      }
      if (!$this
        ->hasDefinition($option['location_input_id'])) {
        continue;
      }

      /** @var \Drupal\geolocation\LocationInputInterface $location_input_plugin */
      $location_input_plugin = $this
        ->createInstance($option['location_input_id']);
      if (empty($option['settings'])) {
        $option['settings'] = [];
      }
      $plugin_coordinates = $location_input_plugin
        ->getCoordinates($form_values, $option_id, $location_input_plugin
        ->getSettings($option['settings']), $context);
      if (!empty($plugin_coordinates)) {

        // Break on first found coordinates.
        return $plugin_coordinates;
      }
    }
    return $coordinates;
  }

  /**
   * Alter output.
   *
   * @param array $settings
   *   Option settings.
   * @param mixed $context
   *   Context.
   * @param array|null $default_value
   *   Form values.
   *
   * @return array
   *   Centre value.
   */
  public function getForm(array $settings, $context = NULL, array $default_value = NULL) {
    $form = [];

    /*
     * Centre handling.
     */
    foreach ($settings as $option_id => $option) {

      // Ignore if not enabled.
      if (empty($option['enable'])) {
        continue;
      }
      if (!$this
        ->hasDefinition($option['location_input_id'])) {
        continue;
      }

      /** @var \Drupal\geolocation\LocationInputInterface $location_input_plugin */
      $location_input_plugin = $this
        ->createInstance($option['location_input_id']);
      $plugin_form = $location_input_plugin
        ->getForm($option_id, empty($option['settings']) ? [] : $option['settings'], $context, $default_value);
      if ($plugin_form !== FALSE) {
        return $plugin_form;
      }
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultPluginManager::$additionalAnnotationNamespaces	protected	property	Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook	protected	property	Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey	protected	property	The cache key.
DefaultPluginManager::$cacheTags	protected	property	An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults	protected	property	A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes.	9
DefaultPluginManager::$moduleHandler	protected	property	The module handler to invoke the alter hook.	1
DefaultPluginManager::$namespaces	protected	property	An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName	protected	property	The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface	protected	property	The interface each plugin should implement.	1
DefaultPluginManager::$subdir	protected	property	The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions	protected	function	Invokes the hook to alter the definitions if the alter hook is set.	1
DefaultPluginManager::alterInfo	protected	function	Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions	5
DefaultPluginManager::extractProviderFromDefinition	protected	function	Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions	protected	function	Finds plugin definitions.	7
DefaultPluginManager::fixContextAwareDefinitions	private	function	Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions	2
DefaultPluginManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery	12
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition	public	function	Performs extra processing on plugin definitions.	13
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.	3
DefaultPluginManager::setCacheBackend	public	function	Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions	protected	function	Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches	public	function	Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches	1
DiscoveryCachedTrait::$definitions	protected	property	Cached definitions array.	1
DiscoveryCachedTrait::getDefinition	public	function	Overrides DiscoveryTrait::getDefinition	3
DiscoveryTrait::doGetDefinition	protected	function	Gets a specific plugin definition.
DiscoveryTrait::hasDefinition	public	function
LocationInputManager::getCoordinates	public	function	Get coordinates.
LocationInputManager::getForm	public	function	Alter output.
LocationInputManager::getLocationInputPlugin	public	function	Return LocationInput by ID.
LocationInputManager::getOptionsForm	public	function	Get form render array.
LocationInputManager::__construct	public	function	Constructs an LocationInputManager object. Overrides DefaultPluginManager::__construct
PluginManagerBase::$discovery	protected	property	The object that discovers plugins managed by this manager.
PluginManagerBase::$factory	protected	property	The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper	protected	property	The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance	12
PluginManagerBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance	7
PluginManagerBase::handlePluginNotFound	protected	function	Allows plugin managers to specify custom behavior if a plugin is not found.	1
UseCacheBackendTrait::$cacheBackend	protected	property	Cache backend instance.
UseCacheBackendTrait::$useCaches	protected	property	Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet	protected	function	Fetches from the cache backend, respecting the use caches flag.	1
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.

You are here

class LocationInputManager in Geolocation Field 8.2

Hierarchy

File

Namespace

Members

API Navigation