How does \Magento\Webapi\Controller\Rest::processApiRequest() work for a «/carts/mine/payment-information» POST request?

dmitry_fedyuk · May 9, 2016, 3:01am

Context:

magento/magento2/blob/cf7df72/app/code/Magento/Webapi/Controller/Rest.php#L279-L279


$inputParams = $this->serviceInputProcessor->process($serviceClassName, $serviceMethodName, $inputData);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L69-L85


/**
 * Convert the input array from key-value format to a list of parameters suitable for the specified class / method.
 *
 * The input array should have the field name as the key, and the value will either be a primitive or another
 * key-value array.  The top level of this array needs keys that match the names of the parameters on the
 * service method.
 *
 * Mismatched types are caught by the PHP runtime, not explicitly checked for by this code.
 *
 * @param string $serviceClassName name of the service class that we are trying to call
 * @param string $serviceMethodName name of the method that we are trying to call
 * @param array $inputArray data to send to method in key-value format
 * @return array list of parameters that can be used to call the service method
 * @throws InputException if no value is provided for required parameters
 * @throws WebapiException
 */
public function process($serviceClassName, $serviceMethodName, array $inputArray)

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L89-L89


foreach ($this->methodsMap->getMethodParams($serviceClassName, $serviceMethodName) as $param) {

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/MethodsMap.php#L108-L115


/**
 * Retrieve requested service method params metadata.
 *
 * @param string $serviceClassName
 * @param string $serviceMethodName
 * @return array
 */
public function getMethodParams($serviceClassName, $serviceMethodName)

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Checkout/Api/PaymentInformationManagementInterface.php#L14-L27


/**
 * Set payment information and place order for a specified cart.
 *
 * @param int $cartId
 * @param \Magento\Quote\Api\Data\PaymentInterface $paymentMethod
 * @param \Magento\Quote\Api\Data\AddressInterface|null $billingAddress
 * @throws \Magento\Framework\Exception\CouldNotSaveException
 * @return int Order ID.
 */
public function savePaymentInformationAndPlaceOrder(
    $cartId,
    \Magento\Quote\Api\Data\PaymentInterface $paymentMethod,
    \Magento\Quote\Api\Data\AddressInterface $billingAddress = null
);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/MethodsMap.php#L122-L124


$serviceClass = new ClassReflection($serviceClassName);
/** @var MethodReflection $serviceMethod */
$serviceMethod = $serviceClass->getMethod($serviceMethodName);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/MethodsMap.php#L125-L137


$params = [];
/** @var ParameterReflection $paramReflection */
foreach ($serviceMethod->getParameters() as $paramReflection) {
    $isDefaultValueAvailable = $paramReflection->isDefaultValueAvailable();
    $params[] = [
        self::METHOD_META_NAME => $paramReflection->getName(),
        self::METHOD_META_TYPE => $this->typeProcessor->getParamType($paramReflection),
        self::METHOD_META_HAS_DEFAULT_VALUE => $isDefaultValueAvailable,
        self::METHOD_META_DEFAULT_VALUE => $isDefaultValueAvailable ? $paramReflection->getDefaultValue() : null
    ];
}
$this->cache->save(serialize($params), $cacheId, [ReflectionCache::CACHE_TAG]);
return $params;

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L89-L91


foreach ($this->methodsMap->getMethodParams($serviceClassName, $serviceMethodName) as $param) {
    $paramName = $param[MethodsMap::METHOD_META_NAME];
    $snakeCaseParamName = strtolower(preg_replace("/(?<=\\w)(?=[A-Z])/", "_$1", $paramName));

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L92-L102


if (isset($inputArray[$paramName]) || isset($inputArray[$snakeCaseParamName])) {
    $paramValue = isset($inputArray[$paramName])
        ? $inputArray[$paramName]
        : $inputArray[$snakeCaseParamName];


    try {
        $inputData[] = $this->convertValue($paramValue, $param[MethodsMap::METHOD_META_TYPE]);
    } catch (SerializationException $e) {
        throw new WebapiException(new Phrase($e->getMessage()));
    }
} else {

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L89-L98


foreach ($this->methodsMap->getMethodParams($serviceClassName, $serviceMethodName) as $param) {
    $paramName = $param[MethodsMap::METHOD_META_NAME];
    $snakeCaseParamName = strtolower(preg_replace("/(?<=\\w)(?=[A-Z])/", "_$1", $paramName));
    if (isset($inputArray[$paramName]) || isset($inputArray[$snakeCaseParamName])) {
        $paramValue = isset($inputArray[$paramName])
            ? $inputArray[$paramName]
            : $inputArray[$snakeCaseParamName];


        try {
            $inputData[] = $this->convertValue($paramValue, $param[MethodsMap::METHOD_META_TYPE]);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L233-L241


/**
 * Convert data from array to Data Object representation if type is Data Object or array of Data Objects.
 *
 * @param mixed $data
 * @param string $type Convert given value to the this type
 * @return mixed
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function convertValue($data, $type)

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L243-L243


$isArrayType = $this->typeProcessor->isArrayType($type);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L406-L420


/**
 * Check if given type is an array of type items.
 * Example:
 * <pre>
 *  ComplexType[] -> array of ComplexType items
 *  string[] -> array of strings
 * </pre>
 *
 * @param string $type
 * @return bool
 */
public function isArrayType($type)
{
    return (bool)preg_match('/(\[\]$|^ArrayOf)/', $type);
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L247-L249


if ($this->typeProcessor->isTypeSimple($type) || $this->typeProcessor->isTypeAny($type)) {
    $result = $this->typeProcessor->processSimpleAndAnyType($data, $type);
} else {

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L371-L388


public function isTypeSimple($type)
{
    $type = $this->normalizeType($type);
    if ($this->isArrayType($type)) {
        $type = $this->getArrayItemType($type);
    }


    return in_array(
        $type,
        [
            self::NORMALIZED_STRING_TYPE,
            self::NORMALIZED_INT_TYPE,
            self::NORMALIZED_FLOAT_TYPE,
            self::NORMALIZED_DOUBLE_TYPE,
            self::NORMALIZED_BOOLEAN_TYPE
        ]
    );
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L344-L363


/**
 * Normalize short type names to full type names.
 *
 * @param string $type
 * @return string
 */
public function normalizeType($type)
{
    if ($type == 'null') {
        return null;
    }
    $normalizationMap = [
        self::STRING_TYPE => self::NORMALIZED_STRING_TYPE,
        self::INT_TYPE => self::NORMALIZED_INT_TYPE,
        self::BOOLEAN_TYPE => self::NORMALIZED_BOOLEAN_TYPE,
        self::ANY_TYPE => self::NORMALIZED_ANY_TYPE,
    ];


    return is_string($type) && isset($normalizationMap[$type]) ? $normalizationMap[$type] : $type;
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L20-L38


/**#@+
 * Pre-normalized type constants
 */
const STRING_TYPE = 'str';
const INT_TYPE = 'integer';
const BOOLEAN_TYPE = 'bool';
const ANY_TYPE = 'mixed';
/**#@-*/


/**#@+
 * Normalized type constants
 */
const NORMALIZED_STRING_TYPE = 'string';
const NORMALIZED_INT_TYPE = 'int';
const NORMALIZED_FLOAT_TYPE = 'float';
const NORMALIZED_DOUBLE_TYPE = 'double';
const NORMALIZED_BOOLEAN_TYPE = 'boolean';
const NORMALIZED_ANY_TYPE = 'anyType';
/**#@-*/

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L390-L404


/**
 * Check if given type is any type.
 *
 * @param string $type
 * @return bool
 */
public function isTypeAny($type)
{
    $type = $this->normalizeType($type);
    if ($this->isArrayType($type)) {
        $type = $this->getArrayItemType($type);
    }


    return ($type == self::NORMALIZED_ANY_TYPE);
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L249-L263


} else {
    /** Complex type or array of complex types */
    if ($isArrayType) {
        // Initializing the result for array type else it will return null for empty array
        $result = is_array($data) ? [] : null;
        $itemType = $this->typeProcessor->getArrayItemType($type);
        if (is_array($data)) {
            foreach ($data as $key => $item) {
                $result[$key] = $this->_createFromArray($itemType, $item);
            }
        }
    } else {
        $result = $this->_createFromArray($type, $data);
    }
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L114-L124


/**
 * Creates a new instance of the given class and populates it with the array of data. The data can
 * be in different forms depending on the adapter being used, REST vs. SOAP. For REST, the data is
 * in snake_case (e.g. tax_class_id) while for SOAP the data is in camelCase (e.g. taxClassId).
 *
 * @param string $className
 * @param array $data
 * @return object the newly created and populated object
 * @throws \Exception
 */
protected function _createFromArray($className, $data)

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L126-L127


$data = is_array($data) ? $data : [];
$class = new ClassReflection($className);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L128-L130


if (is_subclass_of($className, self::EXTENSION_ATTRIBUTES_TYPE)) {
    $className = substr($className, 0, -strlen('Interface'));
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L29-L29


const EXTENSION_ATTRIBUTES_TYPE = '\Magento\Framework\Api\ExtensionAttributesInterface';

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L131-L131


$object = $this->objectManager->create($className);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L133-L133


foreach ($data as $propertyName => $value) {

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L134-L136


// Converts snake_case to uppercase CamelCase to help form getter/setter method names
// This use case is for REST only. SOAP request data is already camel cased
$camelCaseProperty = SimpleDataObjectConverter::snakeCaseToUpperCamelCase($propertyName);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L137-L137


$methodName = $this->typeProcessor->findGetterMethodName($class, $camelCaseProperty);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L579-L591


/**
 * Find the getter method name for a property from the given class
 *
 * @param ClassReflection $class
 * @param string $camelCaseProperty
 * @return string processed method name
 * @throws \Exception If $camelCaseProperty has no corresponding getter method
 */
public function findGetterMethodName(ClassReflection $class, $camelCaseProperty)
{
    $getterName = 'get' . $camelCaseProperty;
    $boolGetterName = 'is' . $camelCaseProperty;
    return $this->findAccessorMethodName($class, $camelCaseProperty, $getterName, $boolGetterName);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L627-L642


/**
 * Find the accessor method name for a property from the given class
 *
 * @param ClassReflection $class
 * @param string $camelCaseProperty
 * @param string $accessorName
 * @param bool $boolAccessorName
 * @return string processed method name
 * @throws \Exception If $camelCaseProperty has no corresponding setter method
 */
protected function findAccessorMethodName(
    ClassReflection $class,
    $camelCaseProperty,
    $accessorName,
    $boolAccessorName
) {

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L643-L657


if ($this->classHasMethod($class, $accessorName)) {
    $methodName = $accessorName;
    return $methodName;
} elseif ($this->classHasMethod($class, $boolAccessorName)) {
    $methodName = $boolAccessorName;
    return $methodName;
} else {
    throw new \LogicException(
        sprintf(
            'Property "%s" does not have corresponding setter in class "%s".',
            $camelCaseProperty,
            $class->getName()
        )
    );
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L660-L672


/**
 * Checks if method is defined
 *
 * Case sensitivity of the method is taken into account.
 *
 * @param ClassReflection $class
 * @param string $methodName
 * @return bool
 */
protected function classHasMethod(ClassReflection $class, $methodName)
{
    return $class->hasMethod($methodName) && ($class->getMethod($methodName)->getName() == $methodName);
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Api/Data/PaymentInterface.php#L40-L45


/**
 * Get payment method code
 *
 * @return string
 */
public function getMethod();

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L137-L137


$methodName = $this->typeProcessor->findGetterMethodName($class, $camelCaseProperty);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L138-L138


$methodReflection = $class->getMethod($methodName);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L139-L140


if ($methodReflection->isPublic()) {
    $returnType = $this->typeProcessor->getGetterReturnType($methodReflection)['type'];

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L268-L279


/**
 * Identify getter return type by its reflection.
 *
 * @param \Zend\Code\Reflection\MethodReflection $methodReflection
 * @return array <pre>array(
 *     'type' => <string>$type,
 *     'isRequired' => $isRequired,
 *     'description' => $description
 * )</pre>
 * @throws \InvalidArgumentException
 */
public function getGetterReturnType($methodReflection)

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L281-L281


$methodDocBlock = $methodReflection->getDocBlock();

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Api/Data/PaymentInterface.php#L40-L45


/**
 * Get payment method code
 *
 * @return string
 */
public function getMethod();

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L282-L287


if (!$methodDocBlock) {
    throw new \InvalidArgumentException(
        "Each getter must have description with @return annotation. "
        . "See {$methodReflection->getDeclaringClass()->getName()}::{$methodReflection->getName()}()"
    );
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L288-L288


$returnAnnotations = $methodDocBlock->getTags('return');

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L289-L294


if (empty($returnAnnotations)) {
    throw new \InvalidArgumentException(
        "Getter return type must be specified using @return annotation. "
        . "See {$methodReflection->getDeclaringClass()->getName()}::{$methodReflection->getName()}()"
    );
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L295-L297


/** @var \Zend\Code\Reflection\DocBlock\Tag\ReturnTag $returnAnnotation */
$returnAnnotation = current($returnAnnotations);
$returnType = $returnAnnotation->getType();

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L298-L318


/*
 * Adding this code as a workaround since \Zend\Code\Reflection\DocBlock\Tag\ReturnTag::initialize does not
 * detect and return correct type for array of objects in annotation.
 * eg @return \Magento\Webapi\Service\Entity\SimpleData[] is returned with type
 * \Magento\Webapi\Service\Entity\SimpleData instead of \Magento\Webapi\Service\Entity\SimpleData[]
 */
$escapedReturnType = str_replace('[]', '\[\]', $returnType);
$escapedReturnType = str_replace('\\', '\\\\', $escapedReturnType);


if (preg_match("/.*\\@return\\s+({$escapedReturnType}).*/i", $methodDocBlock->getContents(), $matches)) {
    $returnType = $matches[1];
}
$isRequired = preg_match("/.*\@return\s+\S+\|null.*/i", $methodDocBlock->getContents(), $matches)
    ? false
    : true;
return [
    'type' => $returnType,
    'isRequired' => $isRequired,
    'description' => $returnAnnotation->getDescription(),
    'parameterCount' => $methodReflection->getNumberOfRequiredParameters()
];

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L140-L140


$returnType = $this->typeProcessor->getGetterReturnType($methodReflection)['type'];

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L141-L149


try {
    $setterName = $this->typeProcessor->findSetterMethodName($class, $camelCaseProperty);
} catch (\Exception $e) {
    if (empty($value)) {
        continue;
    } else {
        throw $e;
    }
}

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L612-L625


/**
 * Find the setter method name for a property from the given class
 *
 * @param ClassReflection $class
 * @param string $camelCaseProperty
 * @return string processed method name
 * @throws \Exception If $camelCaseProperty has no corresponding setter method
 */
public function findSetterMethodName(ClassReflection $class, $camelCaseProperty)
{
    $setterName = 'set' . $camelCaseProperty;
    $boolSetterName = 'setIs' . $camelCaseProperty;
    return $this->findAccessorMethodName($class, $camelCaseProperty, $setterName, $boolSetterName);
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Api/Data/PaymentInterface.php#L47-L53


/**
 * Set payment method code
 *
 * @param string $method
 * @return $this
 */
public function setMethod($method);

github.com

magento/magento2/blob/cf7df72/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php#L153-L153


$setterValue = $this->convertValue($value, $returnType);

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Quote/Model/Quote/Payment.php#L265-L274


/**
 * Set payment method code
 *
 * @param string $method
 * @return $this
 */
public function setMethod($method)
{
    return $this->setData(self::KEY_METHOD, $method);
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Webapi/Controller/Rest.php#L279-L279


$inputParams = $this->serviceInputProcessor->process($serviceClassName, $serviceMethodName, $inputData);

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Webapi/Controller/Rest.php#L280-L282


$service = $this->_objectManager->get($serviceClassName);
/** @var \Magento\Framework\Api\AbstractExtensibleObject $outputData */
$outputData = call_user_func_array([$service, $serviceMethodName], $inputParams);

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Checkout/Model/PaymentInformationManagement.php#L64-L76


public function savePaymentInformationAndPlaceOrder(
    $cartId,
    \Magento\Quote\Api\Data\PaymentInterface $paymentMethod,
    \Magento\Quote\Api\Data\AddressInterface $billingAddress = null
) {
    $this->savePaymentInformation($cartId, $paymentMethod, $billingAddress);
    try {
        $orderId = $this->cartManagement->placeOrder($cartId);
    } catch (\Exception $e) {
        throw new CouldNotSaveException(__('Cannot place order'), $e);
    }
    return $orderId;
}

Further reading: How does a payment information saving work when a registered customer places an order?

dmitry_fedyuk · April 5, 2017, 1:28pm