class PdfBackendManager in FillPDF 8.4
Same name and namespace in other branches
- 5.0.x src/Plugin/PdfBackendManager.php \Drupal\fillpdf\Plugin\PdfBackendManager
Provides the FillPDF PdfBackend 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\fillpdf\Plugin\PdfBackendManager implements FallbackPluginManagerInterface
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of PdfBackendManager
6 files declare their use of PdfBackendManager
- BackendProxy.php in src/
Service/ BackendProxy.php - FillPdfOverviewForm.php in src/
Form/ FillPdfOverviewForm.php - FillPdfSettingsForm.php in src/
Form/ FillPdfSettingsForm.php - HandlePdfController.php in src/
Controller/ HandlePdfController.php - InputHelper.php in src/
InputHelper.php
1 string reference to 'PdfBackendManager'
1 service uses PdfBackendManager
File
- src/
Plugin/ PdfBackendManager.php, line 13
Namespace
Drupal\fillpdf\PluginView source
class PdfBackendManager extends DefaultPluginManager implements FallbackPluginManagerInterface {
/**
* Constructs a new BackendServiceManager 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/PdfBackend', $namespaces, $module_handler, 'Drupal\\fillpdf\\Plugin\\PdfBackendInterface', 'Drupal\\fillpdf\\Annotation\\PdfBackend');
$this
->alterInfo('fillpdf_pdfbackend_info');
$this
->setCacheBackend($cache_backend, 'fillpdf_pdfbackend_plugins');
}
/**
* Gets the definitions of all FillPDF backend plugins.
*
* @return mixed[]
* An associative array of plugin definitions, keyed by plugin ID and sorted
* by weight.
*/
public function getDefinitions() {
// Get all plugin definitions of this type.
$definitions = parent::getDefinitions();
// Unset the legacy plugin provider.
// @todo Remove in fillpdf:8.x-5.x.
unset($definitions['legacy_provider']);
// Sort plugins by weight.
uasort($definitions, function ($a, $b) {
return $a['weight'] - $b['weight'];
});
return $definitions;
}
/**
* {@inheritdoc}
*/
public function getFallbackPluginId($plugin_id, array $configuration = []) {
return 'legacy_provider';
}
/**
* {@inheritdoc}
*/
protected function handlePluginNotFound($plugin_id, array $configuration) {
$fallback_id = $this
->getFallbackPluginId($plugin_id, $configuration);
$configuration['backend'] = $plugin_id;
return $this
->getFactory()
->createInstance($fallback_id, $configuration);
}
}
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:: |
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 | ||
PdfBackendManager:: |
public | function |
Gets the definitions of all FillPDF backend plugins. Overrides DefaultPluginManager:: |
|
PdfBackendManager:: |
public | function |
Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface:: |
|
PdfBackendManager:: |
protected | function |
Allows plugin managers to specify custom behavior if a plugin is not found. Overrides PluginManagerBase:: |
|
PdfBackendManager:: |
public | function |
Constructs a new BackendServiceManager object. Overrides DefaultPluginManager:: |
1 |
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 |
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. |