How is a web service response adjusted?

dmitrii_fediuk · April 4, 2017, 6:16pm

magento/magento2/blob/2.1.5/app/code/Magento/Webapi/Controller/Rest.php#L307-L312


$outputData = call_user_func_array([$service, $serviceMethodName], $inputParams);
$outputData = $this->serviceOutputProcessor->process(
    $outputData,
    $serviceClassName,
    $serviceMethodName
);

github.com

magento/magento2/blob/2.1.5/lib/internal/Magento/Framework/Webapi/ServiceOutputProcessor.php#L41-L60


/**
 * Converts the incoming data into scalar or an array of scalars format.
 *
 * If the data provided is null, then an empty array is returned.  Otherwise, if the data is an object, it is
 * assumed to be a Data Object and converted to an associative array with keys representing the properties of the
 * Data Object.
 * Nested Data Objects are also converted.  If the data provided is itself an array, then we iterate through the
 * contents and convert each piece individually.
 *
 * @param mixed $data
 * @param string $serviceClassName
 * @param string $serviceMethodName
 * @return array|int|string|bool|float Scalar or array of scalars
 */
public function process($data, $serviceClassName, $serviceMethodName)
{
    /** @var string $dataType */
    $dataType = $this->methodsMapProcessor->getMethodReturnType($serviceClassName, $serviceMethodName);
    return $this->convertValue($data, $dataType);
}

github.com

magento/magento2/blob/2.1.5/lib/internal/Magento/Framework/Webapi/ServiceOutputProcessor.php#L84-L115


/**
 * Convert associative array into proper data object.
 *
 * @param array $data
 * @param string $type
 * @return array|object
 */
public function convertValue($data, $type)
{
    if (is_array($data)) {
        $result = [];
        $arrayElementType = substr($type, 0, -2);
        foreach ($data as $datum) {
            if (is_object($datum)) {
                $datum = $this->processDataObject(
                    $this->dataObjectProcessor->buildOutputDataArray($datum, $arrayElementType)
                );
            }
            $result[] = $datum;
        }
        return $result;
    } elseif (is_object($data)) {
        return $this->processDataObject(
            $this->dataObjectProcessor->buildOutputDataArray($data, $type)
        );
    } elseif ($data === null) {
        return [];
    } else {
        /** No processing is required for scalar types */
        return $data;
    }
}

dmitrii_fediuk · April 4, 2017, 7:28pm