You are here

Home » API reference » Geocoder 8.2 » GeocoderFieldPluginManager.php

class GeocoderFieldPluginManager in Geocoder 8.2

Same name and namespace in other branches
  1. 8.3 modules/geocoder_field/src/GeocoderFieldPluginManager.php \Drupal\geocoder_field\GeocoderFieldPluginManager

The Geocoder Field Plugin manager.

Hierarchy

Expanded class hierarchy of GeocoderFieldPluginManager

1 file declares its use of GeocoderFieldPluginManager
DefaultField.php in modules/geocoder_field/src/Plugin/Geocoder/Field/DefaultField.php
1 string reference to 'GeocoderFieldPluginManager'
geocoder_field.services.yml in modules/geocoder_field/geocoder_field.services.yml
modules/geocoder_field/geocoder_field.services.yml
1 service uses GeocoderFieldPluginManager
geocoder_field.plugin.manager.field in modules/geocoder_field/geocoder_field.services.yml
Drupal\geocoder_field\GeocoderFieldPluginManager

File

modules/geocoder_field/src/GeocoderFieldPluginManager.php, line 15

Namespace

Drupal\geocoder_field
View source 
class GeocoderFieldPluginManager extends DefaultPluginManager {

  /**
   * The geocoder field preprocessor plugin manager service.
   *
   * @var \Drupal\geocoder_field\PreprocessorPluginManager
   */
  protected $preprocessorPluginManager;

  /**
   * The entity field manager service.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * Constructs a new geocoder field plugin manager.
   *
   * @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
   *   The cache backend to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\geocoder_field\PreprocessorPluginManager $preprocessor_plugin_manager
   *   The geocoder field preprocessor plugin manager service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager service.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, PreprocessorPluginManager $preprocessor_plugin_manager, EntityFieldManagerInterface $entity_field_manager) {
    parent::__construct('Plugin/Geocoder/Field', $namespaces, $module_handler, GeocoderFieldPluginInterface::class, GeocoderField::class);
    $this
      ->alterInfo('geocode_field_info');
    $this
      ->setCacheBackend($cache_backend, 'geocode_field_plugins');
    $this->preprocessorPluginManager = $preprocessor_plugin_manager;
    $this->entityFieldManager = $entity_field_manager;
  }

  /**
   * Get Fields Options.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle.
   * @param string $field_name
   *   The field name.
   * @param array $field_types
   *   The field types array.
   *
   * @return mixed
   *   The options results.
   */
  private function getFieldsOptions($entity_type_id, $bundle, $field_name, array $field_types) {
    $options = [];
    foreach ($this->entityFieldManager
      ->getFieldDefinitions($entity_type_id, $bundle) as $id => $definition) {
      if (in_array($definition
        ->getType(), $field_types) && $definition
        ->getName() !== $field_name && !in_array($id, [
        'title',
        'revision_log',
      ])) {
        $options[$id] = new TranslatableMarkup('@label (@name) [@type]', [
          '@label' => $definition
            ->getLabel(),
          '@name' => $definition
            ->getName(),
          '@type' => $definition
            ->getType(),
        ]);
      }
    }
    return $options;
  }

  /**
   * Returns the first plugin that handles a specific field type.
   *
   * @param string $field_type
   *   The type of field for which to find a plugin.
   *
   * @return \Drupal\geocoder_field\GeocoderFieldPluginInterface|null
   *   The plugin instance or NULL, if no plugin handles this field type.
   */
  public function getPluginByFieldType($field_type) {
    foreach ($this
      ->getDefinitions() as $definition) {
      if (in_array($field_type, $definition['field_types'])) {

        /* @var \Drupal\geocoder_field\GeocoderFieldPluginInterface $geocoder_field_plugin */
        $geocoder_field_plugin = $this
          ->createInstance($definition['id']);
        return $geocoder_field_plugin;
      }
    }
    return NULL;
  }

  /**
   * Gets a list of fields available as source for Geocode operations.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle.
   * @param string $field_name
   *   The field name.
   *
   * @return array
   *   The array of source fields and their label.
   */
  public function getGeocodeSourceFields($entity_type_id, $bundle, $field_name) {

    // List the possible Geocoding Field Types.
    $source_fields_types = $this->preprocessorPluginManager
      ->getGeocodeSourceFieldsTypes();

    // Add File and Image field types, for File provider integration.
    if ($this->moduleHandler
      ->moduleExists('image')) {
      array_push($source_fields_types, "file", "image");
    }

    // Add Address and Country Field types, for Address module integration.
    if ($this->moduleHandler
      ->moduleExists('geocoder_address')) {
      array_push($source_fields_types, "address", "address_country");
    }

    // Add Computed field types, for Computed field module integration.
    if ($this->moduleHandler
      ->moduleExists('computed_field')) {
      array_push($source_fields_types, "computed_string", "computed_string_long");
    }

    // Allow other modules to add/alter list of possible Geocoding Field Types.
    $this->moduleHandler
      ->alter('geocode_source_fields', $source_fields_types);
    return $this
      ->getFieldsOptions($entity_type_id, $bundle, $field_name, $source_fields_types);
  }

  /**
   * Gets a list of fields available as source for Reverse Geocode operations.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle.
   * @param string $field_name
   *   The field name.
   *
   * @return array
   *   The array of source fields and their label.
   */
  public function getReverseGeocodeSourceFields($entity_type_id, $bundle, $field_name) {

    // List the possible Reverse Geocoding Field Types.
    $source_fields_types = $this->preprocessorPluginManager
      ->getReverseGeocodeSourceFieldsTypes();

    // Allow other modules to add/alter list of possible Reverse
    // Geocoding Field Types.
    $this->moduleHandler
      ->alter('reverse_geocode_source_fields', $source_fields_types);
    return $this
      ->getFieldsOptions($entity_type_id, $bundle, $field_name, $source_fields_types);
  }

}

Members

Namesort descending 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
GeocoderFieldPluginManager::$entityFieldManager protected property The entity field manager service.
GeocoderFieldPluginManager::$preprocessorPluginManager protected property The geocoder field preprocessor plugin manager service.
GeocoderFieldPluginManager::getFieldsOptions private function Get Fields Options.
GeocoderFieldPluginManager::getGeocodeSourceFields public function Gets a list of fields available as source for Geocode operations.
GeocoderFieldPluginManager::getPluginByFieldType public function Returns the first plugin that handles a specific field type.
GeocoderFieldPluginManager::getReverseGeocodeSourceFields public function Gets a list of fields available as source for Reverse Geocode operations.
GeocoderFieldPluginManager::__construct public function Constructs a new geocoder field plugin manager. 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.