class DataProviderManager in Geolocation Field 8.2
Same name and namespace in other branches
- 8.3 src/DataProviderManager.php \Drupal\geolocation\DataProviderManager
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\DataProviderManager
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of DataProviderManager
1 string reference to 'DataProviderManager'
1 service uses DataProviderManager
File
- src/
DataProviderManager.php, line 16
Namespace
Drupal\geolocationView source
class DataProviderManager extends DefaultPluginManager {
/**
* Constructs an DataProviderManager 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/DataProvider', $namespaces, $module_handler, 'Drupal\\geolocation\\DataProviderInterface', 'Drupal\\geolocation\\Annotation\\DataProvider');
$this
->alterInfo('geolocation_dataprovider_info');
$this
->setCacheBackend($cache_backend, 'geolocation_dataprovider');
}
/**
* Return DataProvider by field type.
*
* @param \Drupal\views\Plugin\views\field\FieldPluginBase $viewField
* Map type.
* @param array $configuration
* Configuration.
*
* @return \Drupal\geolocation\DataProviderInterface|false
* Data provider.
*/
public function getDataProviderByViewsField(FieldPluginBase $viewField, array $configuration = []) {
$definitions = $this
->getDefinitions();
try {
foreach ($definitions as $dataProviderId => $dataProviderDefinition) {
/** @var \Drupal\geolocation\DataProviderInterface $dataProvider */
$dataProvider = $this
->createInstance($dataProviderId, $configuration);
if ($dataProvider
->isViewsGeoOption($viewField)) {
$dataProvider
->setViewsField($viewField);
return $dataProvider;
}
}
} catch (\Exception $e) {
return FALSE;
}
return FALSE;
}
/**
* Return DataProvider by field type.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $fieldDefinition
* Field definition.
* @param array $configuration
* Configuration.
*
* @return \Drupal\geolocation\DataProviderInterface|false
* Data provider.
*/
public function getDataProviderByFieldDefinition(FieldDefinitionInterface $fieldDefinition, array $configuration = []) {
$definitions = $this
->getDefinitions();
try {
foreach ($definitions as $dataProviderId => $dataProviderDefinition) {
/** @var \Drupal\geolocation\DataProviderInterface $dataProvider */
$dataProvider = $this
->createInstance($dataProviderId, $configuration);
if ($dataProvider
->isFieldGeoOption($fieldDefinition)) {
$dataProvider
->setFieldDefinition($fieldDefinition);
return $dataProvider;
}
}
} catch (\Exception $e) {
return FALSE;
}
return FALSE;
}
/**
* Return settings array for data provider after select change.
*
* @param array $form
* Form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* Current From State.
*
* @return array|false
* Settings form.
*/
public function addDataProviderSettingsFormAjax(array $form, FormStateInterface $form_state) {
$triggering_element_parents = $form_state
->getTriggeringElement()['#array_parents'];
$settings_element_parents = $triggering_element_parents;
array_pop($settings_element_parents);
$settings_element_parents[] = 'data_provider_settings';
return NestedArray::getValue($form, $settings_element_parents);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DataProviderManager:: |
public | function | Return settings array for data provider after select change. | |
DataProviderManager:: |
public | function | Return DataProvider by field type. | |
DataProviderManager:: |
public | function | Return DataProvider by field type. | |
DataProviderManager:: |
public | function |
Constructs an DataProviderManager object. Overrides DefaultPluginManager:: |
|
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 |
DiscoveryCachedTrait:: |
protected | property | Cached definitions array. | 1 |
DiscoveryCachedTrait:: |
public | function |
Overrides DiscoveryTrait:: |
3 |
DiscoveryTrait:: |
protected | function | Gets a specific plugin definition. | |
DiscoveryTrait:: |
public | function | ||
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. |