Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
InputParamsResolver Class Reference

Public Member Functions

 __construct (RestRequest $request, ParamsOverrider $paramsOverrider, ServiceInputProcessor $inputProcessor, Router $router, RequestValidator $requestValidator, WebapiInputParamsResolver $inputParamsResolver, $isBulk=false)
 
 resolve ()
 
 getRoute ()
 

Detailed Description

This class is responsible for retrieving resolved input data

Definition at line 21 of file InputParamsResolver.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( RestRequest  $request,
ParamsOverrider  $paramsOverrider,
ServiceInputProcessor  $inputProcessor,
Router  $router,
RequestValidator  $requestValidator,
WebapiInputParamsResolver  $inputParamsResolver,
  $isBulk = false 
)

Initialize dependencies.

Parameters
\Magento\Framework\Webapi\Rest\Request$request
\Magento\Webapi\Controller\Rest\ParamsOverrider$paramsOverrider
\Magento\Framework\Webapi\ServiceInputProcessor$inputProcessor
\Magento\Webapi\Controller\Rest\Router$router
\Magento\Webapi\Controller\Rest\RequestValidator$requestValidator
\Magento\Webapi\Controller\Rest\InputParamsResolver$inputParamsResolver
bool$isBulk

Definition at line 63 of file InputParamsResolver.php.

71  {
72  $this->request = $request;
73  $this->paramsOverrider = $paramsOverrider;
74  $this->serviceInputProcessor = $inputProcessor;
75  $this->router = $router;
76  $this->requestValidator = $requestValidator;
77  $this->inputParamsResolver = $inputParamsResolver;
78  $this->isBulk = $isBulk;
79  }

Member Function Documentation

◆ getRoute()

getRoute ( )

Detect route by input parameters

Returns
\Magento\Webapi\Controller\Rest\Router\Route

Definition at line 119 of file InputParamsResolver.php.

120  {
121  return $this->inputParamsResolver->getRoute();
122  }

◆ resolve()

resolve ( )

Process and resolve input parameters

Return array with validated input params or throw \Exception if at least one request entity params is not valid

Returns
array
Exceptions

Definition at line 92 of file InputParamsResolver.php.

93  {
94  if ($this->isBulk === false) {
95  return [$this->inputParamsResolver->resolve()];
96  }
97  $this->requestValidator->validate();
98  $webapiResolvedParams = [];
99  $inputData = $this->request->getRequestData();
100 
101  $httpMethod = $this->request->getHttpMethod();
102  if ($httpMethod == \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_DELETE) {
103  $requestBodyParams = $this->request->getBodyParams();
104  $inputData = array_merge($requestBodyParams, $inputData);
105  }
106 
107  foreach ($inputData as $key => $singleEntityParams) {
108  $webapiResolvedParams[$key] = $this->resolveBulkItemParams($singleEntityParams);
109  }
110 
111  return $webapiResolvedParams;
112  }

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