abstract class GeocoderPluginManagerBase in Geocoder 8.2
Same name and namespace in other branches
- 8.3 src/GeocoderPluginManagerBase.php \Drupal\geocoder\GeocoderPluginManagerBase
Provides a base class for geocoder plugin managers.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
- class \Drupal\geocoder\GeocoderPluginManagerBase
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of GeocoderPluginManagerBase
1 file declares its use of GeocoderPluginManagerBase
- PreprocessorPluginManager.php in modules/
geocoder_field/ src/ PreprocessorPluginManager.php
File
- src/
GeocoderPluginManagerBase.php, line 10
Namespace
Drupal\geocoderView source
abstract class GeocoderPluginManagerBase extends DefaultPluginManager {
/**
* List of fields types available as source for Geocode operations.
*
* @var array
*/
protected $geocodeSourceFieldsTypes = [
"string",
"string_long",
"text",
"text_long",
"text_with_summary",
"file",
"image",
];
/**
* List of fields types available as source for Reverse Geocode operations.
*
* @var array
*/
protected $reverseGeocodeSourceFieldsTypes = [
"geofield",
];
/**
* Gets a list of available plugins to be used in forms.
*
* @return string[]
* A list of plugins in a format suitable for form API '#options' key.
*/
public function getPluginsAsOptions() {
return array_map(function ($plugin) {
return $plugin['name'];
}, $this
->getPlugins());
}
/**
* Return the array of plugins and their settings if any.
*
* @return array
* A list of plugins with their settings.
*/
public function getPlugins() {
$definitions = array_map(function (array $definition) {
$definition += [
'name' => $definition['id'],
];
return $definition;
}, $this
->getDefinitions());
ksort($definitions);
return $definitions;
}
/**
* Gets a list of fields types available for Geocode operations.
*
* @return string[]
* A list of plugins in a format suitable for form API '#options' key.
*/
public function getGeocodeSourceFieldsTypes() {
return $this->geocodeSourceFieldsTypes;
}
/**
* Gets a list of fields types available for Reverse Geocode operations.
*
* @return string[]
* A list of plugins in a format suitable for form API '#options' key.
*/
public function getReverseGeocodeSourceFieldsTypes() {
return $this->reverseGeocodeSourceFieldsTypes;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DefaultPluginManager:: |
protected | property | Additional namespaces the annotation discovery mechanism should scan for annotation definitions. | |
DefaultPluginManager:: |
protected | property | Name of the alter hook if one should be invoked. | |
DefaultPluginManager:: |
protected | property | The cache key. | |
DefaultPluginManager:: |
protected | property | An array of cache tags to use for the cached definitions. | |
DefaultPluginManager:: |
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:: |
protected | property | The module handler to invoke the alter hook. | 1 |
DefaultPluginManager:: |
protected | property | An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations. | |
DefaultPluginManager:: |
protected | property | The name of the annotation that contains the plugin definition. | |
DefaultPluginManager:: |
protected | property | The interface each plugin should implement. | 1 |
DefaultPluginManager:: |
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:: |
protected | function | Invokes the hook to alter the definitions if the alter hook is set. | 1 |
DefaultPluginManager:: |
protected | function | Sets the alter hook name. | |
DefaultPluginManager:: |
public | function |
Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface:: |
5 |
DefaultPluginManager:: |
protected | function | Extracts the provider from a plugin definition. | |
DefaultPluginManager:: |
protected | function | Finds plugin definitions. | 7 |
DefaultPluginManager:: |
private | function | Fix the definitions of context-aware plugins. | |
DefaultPluginManager:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
protected | function | Returns the cached plugin definitions of the decorated discovery class. | |
DefaultPluginManager:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
public | function |
Gets the definition of all plugins for this type. Overrides DiscoveryTrait:: |
2 |
DefaultPluginManager:: |
protected | function |
Gets the plugin discovery. Overrides PluginManagerBase:: |
12 |
DefaultPluginManager:: |
protected | function |
Gets the plugin factory. Overrides PluginManagerBase:: |
|
DefaultPluginManager:: |
public | function | Performs extra processing on plugin definitions. | 13 |
DefaultPluginManager:: |
protected | function | Determines if the provider of a definition exists. | 3 |
DefaultPluginManager:: |
public | function | Initialize the cache backend. | |
DefaultPluginManager:: |
protected | function | Sets a cache of plugin definitions for the decorated discovery class. | |
DefaultPluginManager:: |
public | function |
Disable the use of caches. Overrides CachedDiscoveryInterface:: |
1 |
DefaultPluginManager:: |
public | function | Creates the discovery object. | 47 |
DiscoveryCachedTrait:: |
protected | property | Cached definitions array. | 1 |
DiscoveryCachedTrait:: |
public | function |
Overrides DiscoveryTrait:: |
3 |
DiscoveryTrait:: |
protected | function | Gets a specific plugin definition. | |
DiscoveryTrait:: |
public | function | ||
GeocoderPluginManagerBase:: |
protected | property | List of fields types available as source for Geocode operations. | |
GeocoderPluginManagerBase:: |
protected | property | List of fields types available as source for Reverse Geocode operations. | |
GeocoderPluginManagerBase:: |
public | function | Gets a list of fields types available for Geocode operations. | |
GeocoderPluginManagerBase:: |
public | function | Return the array of plugins and their settings if any. | 1 |
GeocoderPluginManagerBase:: |
public | function | Gets a list of available plugins to be used in forms. | |
GeocoderPluginManagerBase:: |
public | function | Gets a list of fields types available for Reverse Geocode operations. | |
PluginManagerBase:: |
protected | property | The object that discovers plugins managed by this manager. | |
PluginManagerBase:: |
protected | property | The object that instantiates plugins managed by this manager. | |
PluginManagerBase:: |
protected | property | The object that returns the preconfigured plugin instance appropriate for a particular runtime condition. | |
PluginManagerBase:: |
public | function |
Creates a pre-configured instance of a plugin. Overrides FactoryInterface:: |
12 |
PluginManagerBase:: |
public | function |
Gets a preconfigured instance of a plugin. Overrides MapperInterface:: |
7 |
PluginManagerBase:: |
protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 |
UseCacheBackendTrait:: |
protected | property | Cache backend instance. | |
UseCacheBackendTrait:: |
protected | property | Flag whether caches should be used or skipped. | |
UseCacheBackendTrait:: |
protected | function | Fetches from the cache backend, respecting the use caches flag. | 1 |
UseCacheBackendTrait:: |
protected | function | Stores data in the persistent cache, respecting the use caches flag. |