ExtensionAttributesFactory Class Reference

Public Member Functions
	__construct (\Magento\Framework\ObjectManagerInterface $objectManager)
	create ($extensibleClassName, $data=[])
	getExtensibleInterfaceName ($extensibleClassName)

Data Fields
const	EXTENSIBLE_INTERFACE_NAME = \Magento\Framework\Api\ExtensibleDataInterface::class

Protected Attributes
	$objectManager

Detailed Description

Factory class for instantiation of extension attributes objects.

Definition at line 12 of file ExtensionAttributesFactory.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Framework\ObjectManagerInterface

$objectManager

)

Factory constructor

Parameters

\Magento\Framework\ObjectManagerInterface

$objectManager

Definition at line 35 of file ExtensionAttributesFactory.php.

    {
        $this->objectManager = $objectManager;
    }

Member Function Documentation

create()

create	(		$extensibleClassName,
			$data = []
	)

Create extension attributes object, custom for each extensible class.

Parameters

string	$extensibleClassName
array	$data

Returns

\Magento\Framework\Api\ExtensionAttributesInterface

Ensure that proper return type of getExtensionAttributes() method is specified

Definition at line 47 of file ExtensionAttributesFactory.php.

    {
        $interfaceReflection = new \ReflectionClass($this->getExtensibleInterfaceName($extensibleClassName));

        $methodReflection = $interfaceReflection->getMethod('getExtensionAttributes');
        if ($methodReflection->getDeclaringClass()->getName() === self::EXTENSIBLE_INTERFACE_NAME) {
            throw new \LogicException(
                "Method 'getExtensionAttributes' must be overridden in the interfaces "
                . "which extend '" . self::EXTENSIBLE_INTERFACE_NAME . "'. "
                . "Concrete return type should be specified."
            );
        }

        $interfaceName = '\\' . $interfaceReflection->getName();
        $extensionClassName = substr($interfaceName, 0, -strlen('Interface')) . 'Extension';
        $extensionInterfaceName = $extensionClassName . 'Interface';

        $methodDocBlock = $methodReflection->getDocComment();
        $pattern = "/@return\s+" . str_replace('\\', '\\\\', $extensionInterfaceName) . "/";
        if (!preg_match($pattern, $methodDocBlock)) {
            throw new \LogicException(
                "Method 'getExtensionAttributes' must be overridden in the interfaces "
                . "which extend '" . self::EXTENSIBLE_INTERFACE_NAME . "'. "
                . "Concrete return type must be specified. Please fix :" . $interfaceName
            );
        }

        $extensionFactoryName = $extensionClassName . 'Factory';
        $extensionFactory = $this->objectManager->create($extensionFactoryName);
        return $extensionFactory->create($data);
    }

getExtensibleInterfaceName()

getExtensibleInterfaceName

(

$extensibleClassName

)

Identify concrete extensible interface name based on the class name.

Parameters

string

$extensibleClassName

Returns

string

Definition at line 86 of file ExtensionAttributesFactory.php.

    {
        $exceptionMessage = "Class '{$extensibleClassName}' must implement an interface, "
            . "which extends from '" . self::EXTENSIBLE_INTERFACE_NAME . "'";
        $notExtensibleClassFlag = '';

        if (isset($this->classInterfaceMap[$extensibleClassName])) {
            if ($notExtensibleClassFlag === $this->classInterfaceMap[$extensibleClassName]) {
                throw new \LogicException($exceptionMessage);
            } else {
                return $this->classInterfaceMap[$extensibleClassName];
            }
        }
        $modelReflection = new \ReflectionClass($extensibleClassName);
        if ($modelReflection->isInterface()
            && $modelReflection->isSubclassOf(self::EXTENSIBLE_INTERFACE_NAME)
            && $modelReflection->hasMethod('getExtensionAttributes')
        ) {
            $this->classInterfaceMap[$extensibleClassName] = $extensibleClassName;
            return $this->classInterfaceMap[$extensibleClassName];
        }
        foreach ($modelReflection->getInterfaces() as $interfaceReflection) {
            if ($interfaceReflection->isSubclassOf(self::EXTENSIBLE_INTERFACE_NAME)
                && $interfaceReflection->hasMethod('getExtensionAttributes')
            ) {
                $this->classInterfaceMap[$extensibleClassName] = $interfaceReflection->getName();
                return $this->classInterfaceMap[$extensibleClassName];
            }
        }
        $this->classInterfaceMap[$extensibleClassName] = $notExtensibleClassFlag;
        throw new \LogicException($exceptionMessage);
    }

Field Documentation

$objectManager

$objectManager

protected

Definition at line 21 of file ExtensionAttributesFactory.php.

EXTENSIBLE_INTERFACE_NAME

const EXTENSIBLE_INTERFACE_NAME = \Magento\Framework\Api\ExtensibleDataInterface::class

Definition at line 14 of file ExtensionAttributesFactory.php.

---

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

• vendor/magento/framework/Api/ExtensionAttributesFactory.php