Rest Class Reference

Inheritance diagram for Rest:

Public Member Functions
	__construct (RestRequest $request, RestResponse $response, Router $router, \Magento\Framework\ObjectManagerInterface $objectManager, \Magento\Framework\App\State $appState, Authorization $authorization, ServiceInputProcessor $serviceInputProcessor, ErrorProcessor $errorProcessor, PathProcessor $pathProcessor, \Magento\Framework\App\AreaList $areaList, ParamsOverrider $paramsOverrider, StoreManagerInterface $storeManager, RequestProcessorPool $requestProcessorPool)
	dispatch (\Magento\Framework\App\RequestInterface $request)
Public Member Functions inherited from FrontControllerInterface
	dispatch (RequestInterface $request)

Data Fields
const	SCHEMA_PATH = '/schema'

Protected Member Functions
	isSchemaRequest ()
	getCurrentRoute ()
	checkPermissions ()
	validateRequest ()

Protected Attributes
	$_router
	$_route
	$_request
	$_response
	$_objectManager
	$_appState
	$authorization
	$serviceInputProcessor
	$_errorProcessor
	$_pathProcessor
	$areaList
	$session
	$paramsOverrider
	$requestProcessorPool

Detailed Description

Front controller for WebAPI REST area.

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields)

Definition at line 31 of file Rest.php.

Constructor & Destructor Documentation

__construct()

__construct	(	RestRequest	$request,
		RestResponse	$response,
		Router	$router,
		\Magento\Framework\ObjectManagerInterface	$objectManager,
		\Magento\Framework\App\State	$appState,
		Authorization	$authorization,
		ServiceInputProcessor	$serviceInputProcessor,
		ErrorProcessor	$errorProcessor,
		PathProcessor	$pathProcessor,
		\Magento\Framework\App\AreaList	$areaList,
		ParamsOverrider	$paramsOverrider,
		StoreManagerInterface	$storeManager,
		RequestProcessorPool	$requestProcessorPool
	)

Initialize dependencies

Parameters

RestRequest	$request
RestResponse	$response
Router	$router
\Magento\Framework\ObjectManagerInterface	$objectManager
\Magento\Framework\App\State	$appState
Authorization	$authorization
ServiceInputProcessor	$serviceInputProcessor
ErrorProcessor	$errorProcessor
PathProcessor	$pathProcessor
\Magento\Framework\App\AreaList	$areaList
ParamsOverrider	$paramsOverrider
StoreManagerInterface	$storeManager
RequestProcessorPool	$requestProcessorPool	TODO: Consider removal of warning suppression @SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 141 of file Rest.php.

      {
        $this->_router = $router;
        $this->_request = $request;
        $this->_response = $response;
        $this->_objectManager = $objectManager;
        $this->_appState = $appState;
        $this->authorization = $authorization;
        $this->serviceInputProcessor = $serviceInputProcessor;
        $this->_errorProcessor = $errorProcessor;
        $this->_pathProcessor = $pathProcessor;
        $this->areaList = $areaList;
        $this->paramsOverrider = $paramsOverrider;
        $this->storeManager = $storeManager;
        $this->requestProcessorPool = $requestProcessorPool;
    }

Member Function Documentation

checkPermissions()

checkPermissions ( )

protected

Perform authentication and authorization.

Exceptions

Definition at line 231 of file Rest.php.

    {
        $route = $this->getCurrentRoute();
        if (!$this->authorization->isAllowed($route->getAclResources())) {
            $params = ['resources' => implode(', ', $route->getAclResources())];
            throw new AuthorizationException(
                __("The consumer isn't authorized to access %resources.", $params)
            );
        }
    }

dispatch()

dispatch

(

\Magento\Framework\App\RequestInterface

$request

)

Handle REST request

Based on request decide is it schema request or API request and process accordingly. Throws Exception in case if cannot be processed properly.

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

\Magento\Framework\App\ResponseInterface

Definition at line 180 of file Rest.php.

    {
        $path = $this->_pathProcessor->process($request->getPathInfo());
        $this->_request->setPathInfo($path);
        $this->areaList->getArea($this->_appState->getAreaCode())
            ->load(\Magento\Framework\App\Area::PART_TRANSLATE);
        try {
            $processor = $this->requestProcessorPool->getProcessor($this->_request);
            $processor->process($this->_request);
        } catch (\Exception $e) {
            $maskedException = $this->_errorProcessor->maskException($e);
            $this->_response->setException($maskedException);
        }

        return $this->_response;
    }

getCurrentRoute()

getCurrentRoute ( )

protected

Retrieve current route.

Returns

Route

Deprecated:

100.1.0

See also

\Magento\Webapi\Controller\Rest\InputParamsResolver::getRoute

Definition at line 214 of file Rest.php.

    {
        if (!$this->_route) {
            $this->_route = $this->_router->match($this->_request);
        }

        return $this->_route;
    }

isSchemaRequest()

isSchemaRequest ( )

protected

Check if current request is schema request.

Returns

bool

Definition at line 202 of file Rest.php.

    {
        return $this->_request->getPathInfo() === self::SCHEMA_PATH;
    }

validateRequest()

validateRequest ( )

protected

Validate request

Exceptions

AuthorizationException

Definition at line 251 of file Rest.php.

    {
        $this->checkPermissions();
        if ($this->getCurrentRoute()->isSecure() && !$this->_request->isSecure()) {
            throw new \Magento\Framework\Webapi\Exception(__('Operation allowed only in HTTPS'));
        }
        if ($this->storeManager->getStore()->getCode() === Store::ADMIN_CODE
            && strtoupper($this->_request->getMethod()) === RestRequest::HTTP_METHOD_GET
        ) {
            throw new \Magento\Framework\Webapi\Exception(__('Cannot perform GET operation with store code \'all\''));
        }
    }

Field Documentation

$_appState

$_appState

protected

Definition at line 70 of file Rest.php.

$_errorProcessor

$_errorProcessor

protected

Definition at line 87 of file Rest.php.

$_objectManager

$_objectManager

protected

Definition at line 65 of file Rest.php.

$_pathProcessor

$_pathProcessor

protected

Definition at line 92 of file Rest.php.

$_request

$_request

protected

Definition at line 55 of file Rest.php.

$_response

$_response

protected

Definition at line 60 of file Rest.php.

$_route

$_route

protected

Definition at line 50 of file Rest.php.

$_router

$_router

protected

Definition at line 44 of file Rest.php.

$areaList

$areaList

protected

Definition at line 97 of file Rest.php.

$authorization

$authorization

protected

Definition at line 76 of file Rest.php.

$paramsOverrider

$paramsOverrider

protected

Definition at line 108 of file Rest.php.

$requestProcessorPool

$requestProcessorPool

protected

Definition at line 113 of file Rest.php.

$serviceInputProcessor

$serviceInputProcessor

protected

Definition at line 82 of file Rest.php.

$session

$session

protected

Definition at line 102 of file Rest.php.

SCHEMA_PATH

const SCHEMA_PATH = '/schema'

Path for accessing REST API schema

Deprecated:

100.3.0

Definition at line 38 of file Rest.php.

---

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

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