class CheckoutPaneManager in Ubercart 8.4
Manages discovery and instantiation of checkout panes.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
- class \Drupal\uc_cart\Plugin\CheckoutPaneManager
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of CheckoutPaneManager
4 files declare their use of CheckoutPaneManager
- AjaxAdminForm.php in uc_ajax_admin/
src/ Form/ AjaxAdminForm.php - CheckoutController.php in uc_cart/
src/ Controller/ CheckoutController.php - CheckoutForm.php in uc_cart/
src/ Form/ CheckoutForm.php - CheckoutSettingsForm.php in uc_cart/
src/ Form/ CheckoutSettingsForm.php
1 string reference to 'CheckoutPaneManager'
- uc_cart.services.yml in uc_cart/
uc_cart.services.yml - uc_cart/uc_cart.services.yml
1 service uses CheckoutPaneManager
File
- uc_cart/
src/ Plugin/ CheckoutPaneManager.php, line 14
Namespace
Drupal\uc_cart\PluginView source
class CheckoutPaneManager extends DefaultPluginManager {
/**
* Configuration for the checkout panes.
*
* @var array
*/
protected $paneConfig;
/**
* {@inheritdoc}
*/
protected $defaults = [
'status' => TRUE,
'weight' => 0,
];
/**
* Constructs a CheckoutPaneManager 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.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
parent::__construct('Plugin/Ubercart/CheckoutPane', $namespaces, $module_handler, CheckoutPanePluginInterface::class, CheckoutPane::class);
$this
->alterInfo('uc_checkout_pane');
$this
->setCacheBackend($cache_backend, 'uc_checkout_panes');
$this->paneConfig = \Drupal::config('uc_cart.settings')
->get('panes');
}
/**
* Gets instances of checkout pane plugins, optionally filtered.
*
* @param array $filter
* An array of definition keys to filter by.
*
* @return array
* An array of checkout pane plugin instances.
*/
public function getPanes(array $filter = []) {
$instances = [];
foreach ($this
->getDefinitions() as $id => $definition) {
foreach ($filter as $key => $value) {
if (isset($definition[$key]) && $definition[$key] == $value) {
continue 2;
}
}
$instance = $this
->createInstance($id, $this->paneConfig[$id] ?: []);
if (!isset($filter['enabled']) || $filter['enabled'] != $instance
->isEnabled()) {
$instances[$id] = $instance;
}
}
uasort($instances, [
$this,
'sortHelper',
]);
return $instances;
}
/**
* Provides uasort() callback to sort plugins.
*/
public function sortHelper($a, $b) {
$a_weight = $a
->getWeight();
$b_weight = $b
->getWeight();
if ($a_weight == $b_weight) {
return 0;
}
return $a_weight < $b_weight ? -1 : 1;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CheckoutPaneManager:: |
protected | property |
A set of defaults to be referenced by $this->processDefinition() if
additional processing of plugins is necessary or helpful for development
purposes. Overrides DefaultPluginManager:: |
|
CheckoutPaneManager:: |
protected | property | Configuration for the checkout panes. | |
CheckoutPaneManager:: |
public | function | Gets instances of checkout pane plugins, optionally filtered. | |
CheckoutPaneManager:: |
public | function | Provides uasort() callback to sort plugins. | |
CheckoutPaneManager:: |
public | function |
Constructs a CheckoutPaneManager 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 | 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. |