Magento\Framework\Interception Namespace Reference

Namespaces
	Code
	Config
	Definition
	Fixture
	ObjectManager
	PluginList
	Test

Data Structures
class	AbstractPlugin
interface	ConfigInterface
interface	DefinitionInterface
class	GeneralTest
interface	InterceptorInterface
interface	PluginListInterface
class	TwoPluginTest

Functions
	___init ()
	___callParent ($method, array $arguments)
	__sleep ()
	__wakeup ()
	___callPlugins ($method, array $arguments, array $pluginInfo)

Variables
trait	Interceptor

Detailed Description

Interception config. Tells whether plugins have been added for type.

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Plugin method definitions. Provide the list of interception methods in specified plugin.

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

List of plugins configured in application

Copyright © Magento, Inc. All rights reserved. See COPYING.txt for license details.

Function Documentation

___callParent()

Magento\Framework\Interception\___callParent	(		$method,
		array	$arguments
	)

Calls parent class method

Parameters

string	$method
array	$arguments

Returns

mixed

Definition at line 56 of file Interceptor.php.

    {
        return parent::$method(...array_values($arguments));
    }

___callPlugins()

Magento\Framework\Interception\___callPlugins (   $method, array  $arguments, array  $pluginInfo  )

protected

Calls plugins for a given method.

Parameters

string	$method
array	$arguments
array	$pluginInfo

Returns

mixed|null

Definition at line 98 of file Interceptor.php.

    {
        $subject = $this;
        $type = $this->subjectType;
        $pluginList = $this->pluginList;

        $next = function (...$arguments) use (
            $method,
            &$pluginInfo,
            $subject,
            $type,
            $pluginList,
            &$next
        ) {
            $capMethod = ucfirst($method);
            $currentPluginInfo = $pluginInfo;
            $result = null;

            if (isset($currentPluginInfo[DefinitionInterface::LISTENER_BEFORE])) {
                // Call 'before' listeners
                foreach ($currentPluginInfo[DefinitionInterface::LISTENER_BEFORE] as $code) {
                    $pluginInstance = $pluginList->getPlugin($type, $code);
                    $pluginMethod = 'before' . $capMethod;
                    $beforeResult = $pluginInstance->$pluginMethod($this, ...array_values($arguments));

                    if ($beforeResult !== null) {
                        $arguments = (array)$beforeResult;
                    }
                }
            }

            if (isset($currentPluginInfo[DefinitionInterface::LISTENER_AROUND])) {
                // Call 'around' listener
                $code = $currentPluginInfo[DefinitionInterface::LISTENER_AROUND];
                $pluginInfo = $pluginList->getNext($type, $method, $code);
                $pluginInstance = $pluginList->getPlugin($type, $code);
                $pluginMethod = 'around' . $capMethod;
                $result = $pluginInstance->$pluginMethod($subject, $next, ...array_values($arguments));
            } else {
                // Call original method
                $result = $subject->___callParent($method, $arguments);
            }

            if (isset($currentPluginInfo[DefinitionInterface::LISTENER_AFTER])) {
                // Call 'after' listeners
                foreach ($currentPluginInfo[DefinitionInterface::LISTENER_AFTER] as $code) {
                    $pluginInstance = $pluginList->getPlugin($type, $code);
                    $pluginMethod = 'after' . $capMethod;
                    $result = $pluginInstance->$pluginMethod($subject, $result, ...array_values($arguments));
                }
            }

            return $result;
        };

        $result = $next(...array_values($arguments));
        $next = null;

        return $result;
    }

___init()

Magento\Framework\Interception\___init

(

)

Initialize the Interceptor

Returns

void

Definition at line 40 of file Interceptor.php.

    {
        $this->pluginList = ObjectManager::getInstance()->get(PluginListInterface::class);
        $this->subjectType = get_parent_class($this);
        if (method_exists($this->subjectType, '___init')) {
            parent::___init();
        }
    }

__sleep()

Magento\Framework\Interception\__sleep

(

)

Calls parent class sleep if defined, otherwise provides own implementation

Returns

array

Definition at line 66 of file Interceptor.php.

    {
        if (method_exists(get_parent_class($this), '__sleep')) {
            $properties = parent::__sleep();
        } else {
            $properties = array_keys(get_object_vars($this));
        }
        $properties = array_diff($properties, ['pluginList', 'subjectType']);
        return $properties;
    }

__wakeup()

Magento\Framework\Interception\__wakeup

(

)

Causes Interceptor to be initialized

Returns

void

Definition at line 82 of file Interceptor.php.

    {
        if (method_exists(get_parent_class($this), '__wakeup')) {
            parent::__wakeup();
        }
        $this->___init();
    }

Variable Documentation

Interceptor

trait Interceptor

Initial value:

{
    
    private $pluginList

Interceptor trait that contains the common logic for all interceptor classes.

A trait is used because our interceptor classes need to extend the class that they are intercepting.

Any class using this trait is required to implement \Magento\Framework\Interception\InterceptorInterface

See also

\Magento\Framework\Interception\InterceptorInterface

Definition at line 20 of file Interceptor.php.