How is a «route/data/parameter» branch of a webapi.xml interpreted?

dmitrii_fediuk · April 5, 2017, 1:46am

mage2pro/core/blob/2.4.27/Payment/etc/webapi.xml#L10-L14


	<route url='/V1/df-payment/mine/place-order' method='POST'>
		<service class='Df\Payment\PlaceOrder' method='registered'/>
		<resources><resource ref='self'/></resources>
		<data><parameter name='cartId' force='true'>%cart_id%</parameter></data>
	</route>

Magento\Webapi\Controller\Rest\InputParamsResolver::resolve()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Webapi/Controller/Rest/InputParamsResolver.php#L100-L100


$inputData = $this->paramsOverrider->override($inputData, $route->getParameters());

Magento\Webapi\Controller\Rest\ParamsOverrider::override()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Webapi/Controller/Rest/ParamsOverrider.php#L40-L62


/**
 * Override parameter values based on webapi.xml
 *
 * @param array $inputData Incoming data from request
 * @param array $parameters Contains parameters to replace or default
 * @return array Data in same format as $inputData with appropriate parameters added or changed
 */
public function override(array $inputData, array $parameters)
{
    foreach ($parameters as $name => $paramData) {
        $arrayKeys = explode('.', $name);
        if ($paramData[Converter::KEY_FORCE] || !$this->isNestedArrayValueSet($inputData, $arrayKeys)) {
            $paramValue = $paramData[Converter::KEY_VALUE];
            if (isset($this->paramOverriders[$paramValue])) {
                $value = $this->paramOverriders[$paramValue]->getOverriddenValue();
            } else {
                $value = $paramData[Converter::KEY_VALUE];
            }
            $this->setNestedArrayValue($inputData, $arrayKeys, $value);
        }
    }
    return $inputData;
}

An example of the method’s arguments:

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Webapi/Controller/Rest/ParamsOverrider.php#L64-L82


/**
 * Determine if a nested array value is set.
 *
 * @param array &$nestedArray
 * @param string[] $arrayKeys
 * @return bool true if array value is set
 */
protected function isNestedArrayValueSet(&$nestedArray, $arrayKeys)
{
    $currentArray = &$nestedArray;


    foreach ($arrayKeys as $key) {
        if (!isset($currentArray[$key])) {
            return false;
        }
        $currentArray = &$currentArray[$key];
    }
    return true;
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Quote/etc/di.xml#L43-L49


<type name="Magento\Webapi\Controller\Rest\ParamsOverrider">
    <arguments>
        <argument name="paramOverriders" xsi:type="array">
            <item name="%cart_id%" xsi:type="object">Magento\Quote\Model\Webapi\ParamOverriderCartId\Proxy</item>
        </argument>
    </arguments>
</type>

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Webapi/etc/di.xml#L27-L33


<type name="Magento\Webapi\Controller\Rest\ParamsOverrider">
    <arguments>
        <argument name="paramOverriders" xsi:type="array">
            <item name="%customer_id%" xsi:type="object">Magento\Webapi\Controller\Rest\ParamOverriderCustomerId</item>
        </argument>
    </arguments>
</type>

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Quote/Model/Webapi/ParamOverriderCartId.php#L15-L15


* Replaces a "%cart_id%" value with the current authenticated customer's cart

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Quote/Model/Webapi/ParamOverriderCartId.php#L46-L62


public function getOverriddenValue()
{
    try {
        if ($this->userContext->getUserType() === UserContextInterface::USER_TYPE_CUSTOMER) {
            $customerId = $this->userContext->getUserId();


            /** @var \Magento\Quote\Api\Data\CartInterface */
            $cart = $this->cartManagement->getCartForCustomer($customerId);
            if ($cart) {
                return $cart->getId();
            }
        }
    } catch (NoSuchEntityException $e) {
        /* do nothing and just return null */
    }
    return null;
}

This value is the same as in the input data:

So actually the method does nothing in my case.

dmitrii_fediuk · April 6, 2017, 1:47am