Soap Class Reference

Inheritance diagram for Soap:

Public Member Functions
	__construct (Request $request, \Magento\Framework\Webapi\Response $response, \Magento\Webapi\Model\Soap\Wsdl\Generator $wsdlGenerator, \Magento\Webapi\Model\Soap\Server $soapServer, ErrorProcessor $errorProcessor, \Magento\Framework\App\State $appState, \Magento\Framework\Locale\ResolverInterface $localeResolver, PathProcessor $pathProcessor, \Magento\Framework\Webapi\Rest\Response\RendererFactory $rendererFactory, \Magento\Framework\App\AreaList $areaList)
	dispatch (\Magento\Framework\App\RequestInterface $request)
Public Member Functions inherited from FrontControllerInterface
	dispatch (RequestInterface $request)

Data Fields
const	CONTENT_TYPE_SOAP_CALL = 'application/soap+xml'
const	CONTENT_TYPE_WSDL_REQUEST = 'text/xml'

Protected Member Functions
	_isWsdlRequest ()
	_isWsdlListRequest ()
	_prepareErrorResponse ($exception)
	_setResponseContentType ($contentType='text/xml')
	_setResponseBody ($responseBody)
	validateWsdlRequest ()

Protected Attributes
	$_soapServer
	$_wsdlGenerator
	$_request
	$_response
	$_errorProcessor
	$_appState
	$_localeResolver
	$_pathProcessor
	$areaList
	$rendererFactory

Detailed Description

SOAP Web API entry point.

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 20 of file Soap.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Request	$request,
		\Magento\Framework\Webapi\Response	$response,
		\Magento\Webapi\Model\Soap\Wsdl\Generator	$wsdlGenerator,
		\Magento\Webapi\Model\Soap\Server	$soapServer,
		ErrorProcessor	$errorProcessor,
		\Magento\Framework\App\State	$appState,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
		PathProcessor	$pathProcessor,
		\Magento\Framework\Webapi\Rest\Response\RendererFactory	$rendererFactory,
		\Magento\Framework\App\AreaList	$areaList
	)

Parameters

Request	$request
Response	$response
\Magento\Webapi\Model\Soap\Wsdl\Generator	$wsdlGenerator
\Magento\Webapi\Model\Soap\Server	$soapServer
ErrorProcessor	$errorProcessor
\Magento\Framework\App\State	$appState
\Magento\Framework\Locale\ResolverInterface	$localeResolver
PathProcessor	$pathProcessor
\Magento\Framework\Webapi\Rest\Response\RendererFactory	$rendererFactory
\Magento\Framework\App\AreaList	$areaList	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 92 of file Soap.php.

      {
        $this->_request = $request;
        $this->_response = $response;
        $this->_wsdlGenerator = $wsdlGenerator;
        $this->_soapServer = $soapServer;
        $this->_errorProcessor = $errorProcessor;
        $this->_appState = $appState;
        $this->_localeResolver = $localeResolver;
        $this->_pathProcessor = $pathProcessor;
        $this->areaList = $areaList;
        $this->rendererFactory = $rendererFactory;
    }

Member Function Documentation

_isWsdlListRequest()

_isWsdlListRequest ( )

protected

Check if current request is WSDL request. SOAP operation execution request is another type of requests.

Returns

bool

Definition at line 171 of file Soap.php.

    {
        return $this->_request->getParam(\Magento\Webapi\Model\Soap\Server::REQUEST_PARAM_LIST_WSDL) !== null;
    }

_isWsdlRequest()

_isWsdlRequest ( )

protected

Check if current request is WSDL request. SOAP operation execution request is another type of requests.

Returns

bool

Definition at line 161 of file Soap.php.

    {
        return $this->_request->getParam(\Magento\Webapi\Model\Soap\Server::REQUEST_PARAM_WSDL) !== null;
    }

_prepareErrorResponse()

_prepareErrorResponse (   $exception )

protected

Set body and status code to response using information extracted from provided exception.

Parameters

\Exception

$exception

Returns

void

Definition at line 182 of file Soap.php.

    {
        $maskedException = $this->_errorProcessor->maskException($exception);
        if ($this->_isWsdlRequest()) {
            $httpCode = $maskedException->getHttpCode();
            $contentType = self::CONTENT_TYPE_WSDL_REQUEST;
        } else {
            $httpCode = Response::HTTP_OK;
            $contentType = self::CONTENT_TYPE_SOAP_CALL;
        }
        $this->_setResponseContentType($contentType);
        $this->_response->setHttpResponseCode($httpCode);
        $soapFault = new \Magento\Webapi\Model\Soap\Fault(
            $this->_request,
            $this->_soapServer,
            $maskedException,
            $this->_localeResolver,
            $this->_appState
        );
        $this->_setResponseBody($soapFault->toXml());
    }

_setResponseBody()

_setResponseBody (   $responseBody )

protected

Replace WSDL xml encoding from config, if present, else default to UTF-8 and set it to the response object.

Parameters

string

$responseBody

Returns

$this

Definition at line 225 of file Soap.php.

    {
        $this->_response->setBody(
            preg_replace(
                '/<\?xml version="([^\"]+)"([^>]+)>/i',
                '<?xml version="$1" encoding="' . $this->_soapServer->getApiCharset() . '"?>',
                $responseBody
            )
        );
        return $this;
    }

_setResponseContentType()

_setResponseContentType (   $contentType = 'text/xml' )

protected

Set content type to response object.

Parameters

string

$contentType

Returns

$this

Definition at line 210 of file Soap.php.

    {
        $this->_response->clearHeaders()->setHeader(
            'Content-Type',
            "{$contentType}; charset={$this->_soapServer->getApiCharset()}"
        );
        return $this;
    }

dispatch()

dispatch

(

\Magento\Framework\App\RequestInterface

$request

)

Dispatch SOAP request.

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

\Magento\Framework\App\ResponseInterface

Definition at line 122 of file Soap.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 {
            if ($this->_isWsdlRequest()) {
                $this->validateWsdlRequest();
                $responseBody = $this->_wsdlGenerator->generate(
                    $this->_request->getRequestedServices(),
                    $this->_request->getScheme(),
                    $this->_request->getHttpHost(),
                    $this->_soapServer->generateUri()
                );
                $this->_setResponseContentType(self::CONTENT_TYPE_WSDL_REQUEST);
                $this->_setResponseBody($responseBody);
            } elseif ($this->_isWsdlListRequest()) {
                $servicesList = [];
                foreach ($this->_wsdlGenerator->getListOfServices() as $serviceName) {
                    $servicesList[$serviceName]['wsdl_endpoint'] = $this->_soapServer->getEndpointUri()
                        . '?' . \Magento\Webapi\Model\Soap\Server::REQUEST_PARAM_WSDL . '&services=' . $serviceName;
                }
                $renderer = $this->rendererFactory->get();
                $this->_setResponseContentType($renderer->getMimeType());
                $this->_setResponseBody($renderer->render($servicesList));
            } else {
                $this->_soapServer->handle();
            }
        } catch (\Exception $e) {
            $this->_prepareErrorResponse($e);
        }
        return $this->_response;
    }

validateWsdlRequest()

validateWsdlRequest ( )

protected

Validate wsdl request

Returns

void

Exceptions

Definition at line 243 of file Soap.php.

    {
        $wsdlParam = \Magento\Webapi\Model\Soap\Server::REQUEST_PARAM_WSDL;
        $servicesParam = Request::REQUEST_PARAM_SERVICES;
        $requestParams = array_keys($this->_request->getParams());
        $allowedParams = [$wsdlParam, $servicesParam];
        $notAllowedParameters = array_diff($requestParams, $allowedParams);
        if (count($notAllowedParameters)) {
            $notAllowed = implode(', ', $notAllowedParameters);
            $message = __(
                'Not allowed parameters: %1. Please use only %2 and %3.',
                $notAllowed,
                $wsdlParam,
                $servicesParam
            );
            throw new \Magento\Framework\Webapi\Exception($message);
        }
    }

Field Documentation

$_appState

$_appState

protected

Definition at line 57 of file Soap.php.

$_errorProcessor

$_errorProcessor

protected

Definition at line 52 of file Soap.php.

$_localeResolver

$_localeResolver

protected

Definition at line 62 of file Soap.php.

$_pathProcessor

$_pathProcessor

protected

Definition at line 67 of file Soap.php.

$_request

$_request

protected

Definition at line 42 of file Soap.php.

$_response

$_response

protected

Definition at line 47 of file Soap.php.

$_soapServer

$_soapServer

protected

#- #-

Definition at line 32 of file Soap.php.

$_wsdlGenerator

$_wsdlGenerator

protected

Definition at line 37 of file Soap.php.

$areaList

$areaList

protected

Definition at line 72 of file Soap.php.

$rendererFactory

$rendererFactory

protected

Definition at line 77 of file Soap.php.

CONTENT_TYPE_SOAP_CALL

const CONTENT_TYPE_SOAP_CALL = 'application/soap+xml'

#+ Content types used for responses processed by SOAP web API.

Definition at line 25 of file Soap.php.

CONTENT_TYPE_WSDL_REQUEST

const CONTENT_TYPE_WSDL_REQUEST = 'text/xml'

Definition at line 27 of file Soap.php.

---

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

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