class GeocoderManager in Geolocation Field 8

Same name and namespace in other branches

8.3 src/GeocoderManager.php \Drupal\geolocation\GeocoderManager
8.2 src/GeocoderManager.php \Drupal\geolocation\GeocoderManager

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\GeocoderManager

Expanded class hierarchy of GeocoderManager

1 string reference to 'GeocoderManager'

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

1 service uses GeocoderManager

plugin.manager.geolocation.geocoder in ./geolocation.services.yml: Drupal\geolocation\GeocoderManager

File

src/GeocoderManager.php, line 13

Namespace

Drupal\geolocation

View source

class GeocoderManager extends DefaultPluginManager {

  /**
   * Constructs an GeocoderManager 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/Geocoder', $namespaces, $module_handler, 'Drupal\\geolocation\\GeocoderInterface', 'Drupal\\geolocation\\Annotation\\Geocoder');
    $this
      ->alterInfo('geolocation_geocoder_info');
    $this
      ->setCacheBackend($cache_backend, 'geolocation_geocoder');
  }

  /**
   * Return Geocoder by ID.
   *
   * @param string $id
   *   Geocoder ID.
   * @param array $configuration
   *   Configuration.
   *
   * @return \Drupal\geolocation\GeocoderInterface|false
   *   Geocoder instance.
   */
  public function getGeocoder($id, array $configuration = []) {
    $definitions = $this
      ->getDefinitions();
    if (empty($definitions[$id])) {
      return FALSE;
    }
    try {

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

  /**
   * Get location capable geocoder definitions.
   *
   * @return array
   *   List of location capable geocoder definitions.
   */
  public function getLocationCapableGeocoders() {
    $location_capable_geocoders = [];
    foreach ($this
      ->getDefinitions() as $id => $definition) {
      if (!empty($definition['locationCapable'])) {
        $location_capable_geocoders[$id] = $definition;
      }
    }
    return $location_capable_geocoders;
  }

  /**
   * Get boundary capable geocoder definitions.
   *
   * @return array
   *   List of boundary capable geocoder definitions.
   */
  public function getBoundaryCapableGeocoders() {
    $boundary_capable_geocoders = [];
    foreach ($this
      ->getDefinitions() as $id => $definition) {
      if (!empty($definition['boundaryCapable'])) {
        $boundary_capable_geocoders[$id] = $definition;
      }
    }
    return $boundary_capable_geocoders;
  }

  /**
   * Return settings array for geocoder after select change.
   *
   * @param array $form
   *   Form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current From State.
   *
   * @return array|false
   *   Settings form.
   */
  public static function addGeocoderSettingsFormAjax(array $form, FormStateInterface $form_state) {
    $triggering_element = $form_state
      ->getTriggeringElement()['#parents'];
    array_pop($triggering_element);
    $target = $triggering_element;
    $target[] = 'plugin_id';
    $plugin_id = $form_state
      ->getValue($target, '');
    $target = $triggering_element;
    $target[] = 'settings';
    $geocoder_settings = $form_state
      ->getValue($target, []);

    /** @var \Drupal\geolocation\GeocoderInterface $geocoder_plugin */
    $geocoder_plugin = \Drupal::service('plugin.manager.geolocation.geocoder')
      ->getGeocoder($plugin_id, $geocoder_settings);
    if (empty($geocoder_plugin)) {
      $return = [
        '#type' => 'html_tag',
        '#tag' => 'span',
        '#value' => t('Non-existing geocoder plugin requested.'),
      ];
    }
    else {
      $geocoder_settings_form = $geocoder_plugin
        ->getOptionsForm();
      if (!empty($geocoder_settings_form)) {
        $return = $geocoder_settings_form;
      }
      else {
        $return = [
          '#type' => 'html_tag',
          '#tag' => 'span',
          '#value' => t("No settings available."),
        ];
      }
    }
    $return = array_merge_recursive($return, [
      '#prefix' => '<div id="geocoder-plugin-settings">',
      '#suffix' => '</div>',
    ]);
    return $return;
  }

}

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
GeocoderManager::addGeocoderSettingsFormAjax	public static	function	Return settings array for geocoder after select change.
GeocoderManager::getBoundaryCapableGeocoders	public	function	Get boundary capable geocoder definitions.
GeocoderManager::getGeocoder	public	function	Return Geocoder by ID.
GeocoderManager::getLocationCapableGeocoders	public	function	Get location capable geocoder definitions.
GeocoderManager::__construct	public	function	Constructs an GeocoderManager 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 GeocoderManager in Geolocation Field 8

Hierarchy

File

Namespace

Members

API Navigation