ParamsOverrider Class Reference

Public Member Functions
	__construct (array $paramOverriders=[])
	override (array $inputData, array $parameters)
	overrideRequestBodyIdWithPathParam (array $urlPathParams, array $requestBodyParams, $serviceClassName, $serviceMethodName)

Protected Member Functions
	isNestedArrayValueSet (&$nestedArray, $arrayKeys)
	setNestedArrayValue (&$nestedArray, $arrayKeys, $valueToSet)

Detailed Description

Override parameter values

Definition at line 17 of file ParamsOverrider.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$paramOverriders = []

)

Initialize dependencies

Parameters

ParamOverriderInterface[]

$paramOverriders

Definition at line 34 of file ParamsOverrider.php.

      {
        $this->paramOverriders = $paramOverriders;
    }

Member Function Documentation

isNestedArrayValueSet()

isNestedArrayValueSet ( &  $nestedArray,   $arrayKeys  )

protected

Determine if a nested array value is set.

Parameters

array	&$nestedArray
	string[]	$arrayKeys

Returns

bool true if array value is set

Definition at line 71 of file ParamsOverrider.php.

    {
        $currentArray = &$nestedArray;

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

override()

override	(	array	$inputData,
		array	$parameters
	)

Override parameter values based on webapi.xml

Parameters

array	$inputData	Incoming data from request
array	$parameters	Contains parameters to replace or default

Returns

array Data in same format as $inputData with appropriate parameters added or changed

Definition at line 47 of file ParamsOverrider.php.

    {
        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;
    }

overrideRequestBodyIdWithPathParam()

overrideRequestBodyIdWithPathParam	(	array	$urlPathParams,
		array	$requestBodyParams,
			$serviceClassName,
			$serviceMethodName
	)

Override request body property value with matching url path parameter value

This method assumes that webapi.xml url defines the substitution parameter as camelCase to the actual snake case key described as part of the api contract. example: /:parentId/nestedResource/:entityId. Here :entityId value will be used for overriding 'entity_id' property in the body. Since Webapi framework allows both camelCase and snakeCase, either of them will be substituted for now. If the request body is missing url path parameter as property, it will be added to the body. This method works only requests with scalar properties at top level or properties of single object embedded in the request body. Only the last path parameter value will be substituted from the url in case of multiple parameters.

Parameters

array	$urlPathParams	url path parameters as array
array	$requestBodyParams	body parameters as array
string	$serviceClassName	name of the service class that we are trying to call
string	$serviceMethodName	name of the method that we are trying to call

Returns

array

Definition at line 125 of file ParamsOverrider.php.

      {
        if (empty($urlPathParams)) {
            return $requestBodyParams;
        }
        $pathParamValue = end($urlPathParams);
        // Self apis should not be overridden
        if ($pathParamValue === 'me') {
            return $requestBodyParams;
        }
        $pathParamKey = key($urlPathParams);
        // Check if the request data is a top level object of body
        if (count($requestBodyParams) == 1 && is_array(end($requestBodyParams))) {
            $requestDataKey = key($requestBodyParams);
            if ($this->isPropertyDeclaredInDataObject(
                $serviceClassName,
                $serviceMethodName,
                $requestDataKey,
                $pathParamKey
            )
            ) {
                $this->substituteParameters($requestBodyParams[$requestDataKey], $pathParamKey, $pathParamValue);
            } else {
                $this->substituteParameters($requestBodyParams, $pathParamKey, $pathParamValue);
            }
        } else { // Else parameters passed as scalar values in body will be overridden
            $this->substituteParameters($requestBodyParams, $pathParamKey, $pathParamValue);
        }
        return $requestBodyParams;
    }

setNestedArrayValue()

setNestedArrayValue ( &  $nestedArray,   $arrayKeys,   $valueToSet  )

protected

Set a nested array value.

Parameters

array	&$nestedArray
	string[]	$arrayKeys
string	$valueToSet

Returns

void

Definition at line 92 of file ParamsOverrider.php.

    {
        $currentArray = &$nestedArray;
        $lastKey = array_pop($arrayKeys);

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

        $currentArray[$lastKey] = $valueToSet;
    }

---

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

• vendor/magento/module-webapi/Controller/Rest/ParamsOverrider.php