Inheritance diagram for PluginList:

Public Member Functions
	__construct (ReaderInterface $reader, ScopeInterface $configScope, CacheInterface $cache, RelationsInterface $relations, ConfigInterface $omConfig, DefinitionInterface $definitions, ObjectManagerInterface $objectManager, ClassDefinitions $classDefinitions, array $scopePriorityScheme=['global'], $cacheId='plugins', SerializerInterface $serializer=null)

	getPlugin ($type, $code)

	getNext ($type, $method, $code='__self')

	merge (array $config)

Public Member Functions inherited from Scoped
	__construct (\Magento\Framework\Config\ReaderInterface $reader, \Magento\Framework\Config\ScopeInterface $configScope, \Magento\Framework\Config\CacheInterface $cache, $cacheId, SerializerInterface $serializer=null)

	get ($path=null, $default=null)

Public Member Functions inherited from Data
	__construct (ReaderInterface $reader, CacheInterface $cache, $cacheId, SerializerInterface $serializer=null)

	merge (array $config)

	get ($path=null, $default=null)

	reset ()

Protected Member Functions
	_inheritPlugins ($type)

	_sort ($itemA, $itemB)

	_loadScopedData ()

	isCurrentScope ($scopeCode)

	getClassDefinitions ()

Protected Member Functions inherited from Scoped
	_loadScopedData ()

Protected Member Functions inherited from Data
	initData ()

Protected Attributes
	$_inherited = []

	$_processed

	$_omConfig

	$_relations

	$_definitions

	$_classDefinitions

	$_objectManager

	$_pluginInstances = []

Protected Attributes inherited from Scoped
	$_configScope

	$_reader

	$_cache

	$_cacheId

	$_scopePriorityScheme = []

	$_loadedScopes = []

Protected Attributes inherited from Data
	$_reader

	$_cache

	$_cacheId

	$cacheTags = []

	$_data = []

Detailed Description

Plugin config, provides list of plugins for a type

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 26 of file PluginList.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ReaderInterface	$reader,
		ScopeInterface	$configScope,
		CacheInterface	$cache,
		RelationsInterface	$relations,
		ConfigInterface	$omConfig,
		DefinitionInterface	$definitions,
		ObjectManagerInterface	$objectManager,
		ClassDefinitions	$classDefinitions,
		array	$scopePriorityScheme = `['global']`,
			$cacheId = `'plugins'`,
		SerializerInterface	$serializer = `null`
	)

Constructor

Parameters

ReaderInterface	$reader
ScopeInterface	$configScope
CacheInterface	$cache
RelationsInterface	$relations
ConfigInterface	$omConfig
DefinitionInterface	$definitions
ObjectManagerInterface	$objectManager
ClassDefinitions	$classDefinitions
array	$scopePriorityScheme
string \| null	$cacheId
SerializerInterface \| null	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 106 of file PluginList.php.

       {
         $this->serializer = $serializer ?: $objectManager->get(Serialize::class);
         parent::__construct($reader, $configScope, $cache, $cacheId, $this->serializer);
         $this->_omConfig = $omConfig;
         $this->_relations = $relations;
         $this->_definitions = $definitions;
         $this->_classDefinitions = $classDefinitions;
         $this->_scopePriorityScheme = $scopePriorityScheme;
         $this->_objectManager = $objectManager;
     }

Member Function Documentation

◆ _inheritPlugins()

_inheritPlugins ( $type )

protected

Collect parent types configuration for requested type

Parameters

string $type

Returns: array

Exceptions

Definition at line 138 of file PluginList.php.

     {
         $type = ltrim($type, '\\');
         if (!array_key_exists($type, $this->_inherited)) {
             $realType = $this->_omConfig->getOriginalInstanceType($type);
 
             if ($realType !== $type) {
                 $plugins = $this->_inheritPlugins($realType);
             } elseif ($this->_relations->has($type)) {
                 $relations = $this->_relations->getParents($type);
                 $plugins = [];
                 foreach ($relations as $relation) {
                     if ($relation) {
                         $relationPlugins = $this->_inheritPlugins($relation);
                         if ($relationPlugins) {
                             $plugins = array_replace_recursive($plugins, $relationPlugins);
                         }
                     }
                 }
             } else {
                 $plugins = [];
             }
             if (isset($this->_data[$type])) {
                 if (!$plugins) {
                     $plugins = $this->_data[$type];
                 } else {
                     $plugins = array_replace_recursive($plugins, $this->_data[$type]);
                 }
             }
             $this->_inherited[$type] = null;
             if (is_array($plugins) && count($plugins)) {
                 $this->filterPlugins($plugins);
                 uasort($plugins, [$this, '_sort']);
                 $this->trimInstanceStartingBackslash($plugins);
                 $this->_inherited[$type] = $plugins;
                 $lastPerMethod = [];
                 foreach ($plugins as $key => $plugin) {
                     // skip disabled plugins
                     if (isset($plugin['disabled']) && $plugin['disabled']) {
                         unset($plugins[$key]);
                         continue;
                     }
                     $pluginType = $this->_omConfig->getOriginalInstanceType($plugin['instance']);
                     if (!class_exists($pluginType)) {
                         throw new \InvalidArgumentException('Plugin class ' . $pluginType . ' doesn\'t exist');
                     }
                     foreach ($this->_definitions->getMethodList($pluginType) as $pluginMethod => $methodTypes) {
                         $current = isset($lastPerMethod[$pluginMethod]) ? $lastPerMethod[$pluginMethod] : '__self';
                         $currentKey = $type . '_' . $pluginMethod . '_' . $current;
                         if ($methodTypes & DefinitionInterface::LISTENER_AROUND) {
                             $this->_processed[$currentKey][DefinitionInterface::LISTENER_AROUND] = $key;
                             $lastPerMethod[$pluginMethod] = $key;
                         }
                         if ($methodTypes & DefinitionInterface::LISTENER_BEFORE) {
                             $this->_processed[$currentKey][DefinitionInterface::LISTENER_BEFORE][] = $key;
                         }
                         if ($methodTypes & DefinitionInterface::LISTENER_AFTER) {
                             $this->_processed[$currentKey][DefinitionInterface::LISTENER_AFTER][] = $key;
                         }
                     }
                 }
             }
             return $plugins;
         }
         return $this->_inherited[$type];
     }

◆ _loadScopedData()

_loadScopedData ( )

protected

Load configuration for current scope

Returns: void @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 280 of file PluginList.php.

     {
         $scope = $this->_configScope->getCurrentScope();
         if (false == isset($this->_loadedScopes[$scope])) {
             if (false == in_array($scope, $this->_scopePriorityScheme)) {
                 $this->_scopePriorityScheme[] = $scope;
             }
             $cacheId = implode('|', $this->_scopePriorityScheme) . "|" . $this->_cacheId;
             $data = $this->_cache->load($cacheId);
             if ($data) {
                 list($this->_data, $this->_inherited, $this->_processed) = $this->serializer->unserialize($data);
                 foreach ($this->_scopePriorityScheme as $scopeCode) {
                     $this->_loadedScopes[$scopeCode] = true;
                 }
             } else {
                 $virtualTypes = [];
                 foreach ($this->_scopePriorityScheme as $scopeCode) {
                     if (false == isset($this->_loadedScopes[$scopeCode])) {
                         $data = $this->_reader->read($scopeCode) ?: [];
                         unset($data['preferences']);
                         if (count($data) > 0) {
                             $this->_inherited = [];
                             $this->_processed = [];
                             $this->merge($data);
                             foreach ($data as $class => $config) {
                                 if (isset($config['type'])) {
                                     $virtualTypes[] = $class;
                                 }
                             }
                         }
                         $this->_loadedScopes[$scopeCode] = true;
                     }
                     if ($this->isCurrentScope($scopeCode)) {
                         break;
                     }
                 }
                 foreach ($virtualTypes as $class) {
                     $this->_inheritPlugins($class);
                 }
                 foreach ($this->getClassDefinitions() as $class) {
                     $this->_inheritPlugins($class);
                 }
                 $this->_cache->save(
                     $this->serializer->serialize([$this->_data, $this->_inherited, $this->_processed]),
                     $cacheId
                 );
             }
             $this->_pluginInstances = [];
         }
     }

◆ _sort()

_sort	(	$itemA,
		$itemB
	)

protected

Sort items

Parameters

array	$itemA
array	$itemB

Returns: int

Definition at line 225 of file PluginList.php.

     {
         if (isset($itemA['sortOrder'])) {
             if (isset($itemB['sortOrder'])) {
                 return $itemA['sortOrder'] - $itemB['sortOrder'];
             }
             return $itemA['sortOrder'];
         } elseif (isset($itemB['sortOrder'])) {
             return (0 - (int)$itemB['sortOrder']);
         } else {
             return 0;
         }
     }

◆ getClassDefinitions()

getClassDefinitions ( )

protected

Returns class definitions

Returns: array

Definition at line 347 of file PluginList.php.

     {
         return $this->_classDefinitions->getClasses();
     }

◆ getNext()

getNext	(	$type,
		$method,
		$code = `'__self'`
	)

Retrieve next plugins in chain

Parameters

string	$type
string	$method
string	$code

Returns: array

Implements PluginListInterface.

Definition at line 264 of file PluginList.php.

     {
         $this->_loadScopedData();
         if (!isset($this->_inherited[$type]) && !array_key_exists($type, $this->_inherited)) {
             $this->_inheritPlugins($type);
         }
         $key = $type . '_' . lcfirst($method) . '_' . $code;
         return $this->_processed[$key] ?? null;
     }

◆ getPlugin()

getPlugin	(	$type,
		$code
	)

Retrieve plugin Instance

Parameters

string	$type
string	$code

Returns: mixed

Implements PluginListInterface.

Definition at line 246 of file PluginList.php.

     {
         if (!isset($this->_pluginInstances[$type][$code])) {
             $this->_pluginInstances[$type][$code] = $this->_objectManager->get(
                 $this->_inherited[$type][$code]['instance']
             );
         }
         return $this->_pluginInstances[$type][$code];
     }

◆ isCurrentScope()

isCurrentScope ( $scopeCode )

protected

Whether scope code is current scope code

Parameters

string $scopeCode

Returns: bool

Definition at line 337 of file PluginList.php.

     {
         return $this->_configScope->getCurrentScope() == $scopeCode;
     }

◆ merge()

merge ( array $config )

Merge configuration

Parameters

array $config

Returns: void

Implements DataInterface.

Definition at line 358 of file PluginList.php.

     {
         foreach ($config as $type => $typeConfig) {
             if (isset($typeConfig['plugins'])) {
                 $type = ltrim($type, '\\');
                 if (isset($this->_data[$type])) {
                     $this->_data[$type] = array_replace_recursive($this->_data[$type], $typeConfig['plugins']);
                 } else {
                     $this->_data[$type] = $typeConfig['plugins'];
                 }
             }
         }
     }

Field Documentation

◆ $_classDefinitions

$_classDefinitions

protected

Definition at line 68 of file PluginList.php.

◆ $_definitions

$_definitions

protected

Definition at line 61 of file PluginList.php.

◆ $_inherited

$_inherited = []

protected

Definition at line 33 of file PluginList.php.

◆ $_objectManager

$_objectManager

protected

Definition at line 73 of file PluginList.php.

◆ $_omConfig

$_omConfig

protected

Definition at line 47 of file PluginList.php.

◆ $_pluginInstances

$_pluginInstances = []

protected

Definition at line 78 of file PluginList.php.

◆ $_processed

$_processed

protected

Definition at line 40 of file PluginList.php.

◆ $_relations

$_relations

protected

Definition at line 54 of file PluginList.php.

The documentation for this class was generated from the following file:

vendor/magento/framework/Interception/PluginList/PluginList.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _inheritPlugins()

◆ _loadScopedData()

◆ _sort()

◆ getClassDefinitions()

◆ getNext()

◆ getPlugin()

◆ isCurrentScope()

◆ merge()

Field Documentation

◆ $_classDefinitions

◆ $_definitions

◆ $_inherited

◆ $_objectManager

◆ $_omConfig

◆ $_pluginInstances

◆ $_processed

◆ $_relations