class GeofieldProximitySourceManager in Geofield 8

Provides the Geofield Proximity Source 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\geofield\Plugin\GeofieldProximitySourceManager uses StringTranslationTrait

Expanded class hierarchy of GeofieldProximitySourceManager

6 files declare their use of GeofieldProximitySourceManager

ContextProximityFilter.php in src/Plugin/GeofieldProximitySource/ContextProximityFilter.php
GeofieldProximityArgument.php in src/Plugin/views/argument/GeofieldProximityArgument.php
GeofieldProximityField.php in src/Plugin/views/field/GeofieldProximityField.php
GeofieldProximityFilter.php in src/Plugin/views/filter/GeofieldProximityFilter.php
GeofieldProximitySort.php in src/Plugin/views/sort/GeofieldProximitySort.php

... See full list

1 string reference to 'GeofieldProximitySourceManager'

geofield.services.yml in ./geofield.services.yml: geofield.services.yml

1 service uses GeofieldProximitySourceManager

plugin.manager.geofield_proximity_source in ./geofield.services.yml: Drupal\geofield\Plugin\GeofieldProximitySourceManager

File

src/Plugin/GeofieldProximitySourceManager.php, line 16

Namespace

Drupal\geofield\Plugin

View source

class GeofieldProximitySourceManager extends DefaultPluginManager {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/GeofieldProximitySource', $namespaces, $module_handler, 'Drupal\\geofield\\Plugin\\GeofieldProximitySourceInterface', 'Drupal\\geofield\\Annotation\\GeofieldProximitySource');
    $this
      ->alterInfo('geofield_geofield_proximity_source_info');
    $this
      ->setCacheBackend($cache_backend, 'geofield_geofield_proximity_source_plugins');
  }

  /**
   * Builds the common elements of the Proximity Form.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param string $context
   *   The array list of the specific view handler plugin type to look for.
   *   Possible values:
   *   - filter
   *   - sort
   *   - field
   *   - NULL (all).
   * @param bool $is_exposed
   *   The check/differentiate if it is part of an exposed form.
   */
  public function buildCommonFormElements(array &$form, FormStateInterface $form_state, $context = NULL, $is_exposed = FALSE) {

    // Attach Geofield Map Libraries.
    $form['#attached']['library'][] = 'geofield/geofield_proximity';
    $form['units'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Unit of Measure'),
      '#description' => '',
      '#options' => geofield_radius_options(),
      '#default_value' => '',
    ];
    $form['source_intro'] = [
      '#markup' => $this
        ->t('How do you want to enter your proximity parameters (distance and origin point)?'),
    ];
    $form['source'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Proximity Definition Mode (Source of Distance and Origin Point)'),
      '#options' => [],
      '#default_value' => '',
      '#ajax' => [
        'callback' => [
          get_class($this),
          'sourceUpdate',
        ],
        'effect' => 'fade',
      ],
    ];
    foreach ($this
      ->getDefinitions() as $plugin_id => $definition) {
      if (isset($definition['context']) && (empty($definition['context']) || in_array($context, $definition['context'])) && (!isset($definition['exposedOnly']) || $definition['exposedOnly'] && $is_exposed) && (!isset($definition['no_ui']) || !$definition['no_ui'])) {
        $form['source']['#options'][$plugin_id] = $definition['label'];
      }
    }
    $form['source_configuration'] = [
      '#type' => 'container',
      '#tree' => TRUE,
      '#prefix' => '<div id="proximity-source-configuration">',
      '#suffix' => '</div>',
    ];
  }

  /**
   * Ajax callback triggered on Source Selection.
   *
   * @param array $form
   *   The build form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   Ajax response with updated form element.
   */
  public static function sourceUpdate(array $form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $response
      ->addCommand(new ReplaceCommand('#proximity-source-configuration', $form['options']['source_configuration']));
    return $response;
  }

}

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
GeofieldProximitySourceManager::buildCommonFormElements	public	function	Builds the common elements of the Proximity Form.
GeofieldProximitySourceManager::sourceUpdate	public static	function	Ajax callback triggered on Source Selection.
GeofieldProximitySourceManager::__construct	public	function	Creates the discovery 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
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.
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 GeofieldProximitySourceManager in Geofield 8

Hierarchy

File

Namespace

Members

API Navigation