MethodsMap Class Reference

Public Member Functions
	__construct (\Magento\Framework\Cache\FrontendInterface $cache, TypeProcessor $typeProcessor, \Magento\Framework\Api\AttributeTypeResolverInterface $typeResolver, FieldNamer $fieldNamer)
	getMethodReturnType ($typeName, $methodName)
	getMethodsMap ($interfaceName)
	isMethodValidForDataField ($type, $methodName)
	isMethodReturnValueRequired ($type, $methodName)

Data Fields
const	SERVICE_METHOD_PARAMS_CACHE_PREFIX = 'service_method_params_'
const	SERVICE_INTERFACE_METHODS_CACHE_PREFIX = 'serviceInterfaceMethodsMap'
const	BASE_MODEL_CLASS = \Magento\Framework\Model\AbstractExtensibleModel::class
const	METHOD_META_NAME = 'name'
const	METHOD_META_TYPE = 'type'
const	METHOD_META_HAS_DEFAULT_VALUE = 'isDefaultValueAvailable'
const	METHOD_META_DEFAULT_VALUE = 'defaultValue'

Detailed Description

Gathers method metadata information.

Definition at line 18 of file MethodsMap.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Cache\FrontendInterface	$cache,
		TypeProcessor	$typeProcessor,
		\Magento\Framework\Api\AttributeTypeResolverInterface	$typeResolver,
		FieldNamer	$fieldNamer
	)

Parameters

\Magento\Framework\Cache\FrontendInterface	$cache
TypeProcessor	$typeProcessor
\Magento\Framework\Api\AttributeTypeResolverInterface	$typeResolver
FieldNamer	$fieldNamer

Definition at line 60 of file MethodsMap.php.

      {
        $this->cache = $cache;
        $this->typeProcessor = $typeProcessor;
        $this->attributeTypeResolver = $typeResolver;
        $this->fieldNamer = $fieldNamer;
    }

Member Function Documentation

getMethodReturnType()

getMethodReturnType	(		$typeName,
			$methodName
	)

Get return type by type name and method name.

Parameters

string	$typeName
string	$methodName

Returns

string

Definition at line 79 of file MethodsMap.php.

    {
        return $this->getMethodsMap($typeName)[$methodName]['type'];
    }

getMethodsMap()

getMethodsMap

(

$interfaceName

)

Return service interface or Data interface methods loaded from cache

Parameters

string

$interfaceName

Returns

array

Service methods' reflection data stored in cache as 'methodName' => 'returnType'
ex.
[
 'create' => '\Magento\Customer\Api\Data\Customer',
 'validatePassword' => 'boolean'
]

Definition at line 98 of file MethodsMap.php.

    {
        $key = self::SERVICE_INTERFACE_METHODS_CACHE_PREFIX . "-" . md5($interfaceName);
        if (!isset($this->serviceInterfaceMethodsMap[$key])) {
            $methodMap = $this->cache->load($key);
            if ($methodMap) {
                $this->serviceInterfaceMethodsMap[$key] = $this->getSerializer()->unserialize($methodMap);
            } else {
                $methodMap = $this->getMethodMapViaReflection($interfaceName);
                $this->serviceInterfaceMethodsMap[$key] = $methodMap;
                $this->cache->save($this->getSerializer()->serialize($this->serviceInterfaceMethodsMap[$key]), $key);
            }
        }
        return $this->serviceInterfaceMethodsMap[$key];
    }

isMethodReturnValueRequired()

isMethodReturnValueRequired	(		$type,
			$methodName
	)

If the method has only non-null return types

Parameters

string	$type
string	$methodName

Returns

bool

Definition at line 221 of file MethodsMap.php.

    {
        $methods = $this->getMethodsMap($type);
        return $methods[$methodName]['isRequired'];
    }

isMethodValidForDataField()

isMethodValidForDataField	(		$type,
			$methodName
	)

Determines if the given method's on the given type is suitable for an output data array.

Parameters

string	$type
string	$methodName

Returns

bool

Definition at line 197 of file MethodsMap.php.

    {
        $methods = $this->getMethodsMap($type);
        if (isset($methods[$methodName])) {
            $methodMetadata = $methods[$methodName];
            // any method with parameter(s) gets ignored because we do not know the type and value of
            // the parameter(s), so we are not able to process
            if ($methodMetadata['parameterCount'] > 0) {
                return false;
            }

            return $this->fieldNamer->getFieldNameForMethodName($methodName) !== null;
        }

        return false;
    }

Field Documentation

BASE_MODEL_CLASS

const BASE_MODEL_CLASS = \Magento\Framework\Model\AbstractExtensibleModel::class

Definition at line 22 of file MethodsMap.php.

METHOD_META_DEFAULT_VALUE

const METHOD_META_DEFAULT_VALUE = 'defaultValue'

Definition at line 27 of file MethodsMap.php.

METHOD_META_HAS_DEFAULT_VALUE

const METHOD_META_HAS_DEFAULT_VALUE = 'isDefaultValueAvailable'

Definition at line 26 of file MethodsMap.php.

METHOD_META_NAME

const METHOD_META_NAME = 'name'

Definition at line 24 of file MethodsMap.php.

METHOD_META_TYPE

const METHOD_META_TYPE = 'type'

Definition at line 25 of file MethodsMap.php.

SERVICE_INTERFACE_METHODS_CACHE_PREFIX

const SERVICE_INTERFACE_METHODS_CACHE_PREFIX = 'serviceInterfaceMethodsMap'

Definition at line 21 of file MethodsMap.php.

SERVICE_METHOD_PARAMS_CACHE_PREFIX

const SERVICE_METHOD_PARAMS_CACHE_PREFIX = 'service_method_params_'

Definition at line 20 of file MethodsMap.php.

---

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

• vendor/magento/framework/Reflection/MethodsMap.php