Inheritance diagram for Generator:

Public Member Functions
	__construct (\Magento\Webapi\Model\Cache\Type\Webapi $cache, \Magento\Framework\Reflection\TypeProcessor $typeProcessor, \Magento\Framework\Webapi\CustomAttribute\ServiceTypeListInterface $serviceTypeList, \Magento\Webapi\Model\ServiceMetadata $serviceMetadata, Authorization $authorization, WsdlFactory $wsdlFactory)

	getPortTypeName ($serviceName)

	getBindingName ($serviceName)

	getPortName ($serviceName)

	getServiceName ($serviceName)

	getInputMessageName ($operationName)

	getOutputMessageName ($operationName)

Public Member Functions inherited from AbstractSchemaGenerator
	__construct (Webapi $cache, \Magento\Framework\Reflection\TypeProcessor $typeProcessor, ServiceTypeListInterface $serviceTypeList, ServiceMetadata $serviceMetadata, Authorization $authorization, Json $serializer=null)

	getListOfServices ()

	generate ($requestedServices, $requestScheme, $requestHost, $endPointUrl)

	getElementComplexTypeName ($messageName)

Data Fields
const	WSDL_NAME = 'MagentoWSDL'

Protected Member Functions
	generateSchema ($requestedServiceMetadata, $requestScheme, $requestHost, $endPointUrl)

	addCustomAttributeTypes ($wsdl)

	_createOperationInput (Wsdl $wsdl, $operationName, $methodData)

	_createOperationOutput (Wsdl $wsdl, $operationName, $methodData)

	_addGenericFaultComplexTypeNodes ($wsdl)

	getServiceMetadata ($serviceName)

	getAllowedServicesMetadata ($requestedServices)

Protected Member Functions inherited from AbstractSchemaGenerator
	generateSchema ($requestedServiceMetadata, $requestScheme, $requestHost, $requestUri)

	getServiceMetadata ($serviceName)

	collectCallInfo ($requestedServiceMetadata)

	getAllowedServicesMetadata ($requestedServices)

	removeRestrictedRoutes (&$serviceMetadata)

Protected Attributes
	$_wsdlFactory

Protected Attributes inherited from AbstractSchemaGenerator
	$cache

	$typeProcessor

	$serviceTypeList

	$serviceMetadata

	$authorization

Detailed Description

WSDL generator.

Definition at line 21 of file Generator.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Webapi\Model\Cache\Type\Webapi	$cache,
		\Magento\Framework\Reflection\TypeProcessor	$typeProcessor,
		\Magento\Framework\Webapi\CustomAttribute\ServiceTypeListInterface	$serviceTypeList,
		\Magento\Webapi\Model\ServiceMetadata	$serviceMetadata,
		Authorization	$authorization,
		WsdlFactory	$wsdlFactory
	)

Initialize dependencies.

Parameters

\Magento\Webapi\Model\Cache\Type\Webapi	$cache
\Magento\Framework\Reflection\TypeProcessor	$typeProcessor
\Magento\Framework\Webapi\CustomAttribute\ServiceTypeListInterface	$serviceTypeList
\Magento\Webapi\Model\ServiceMetadata	$serviceMetadata
Authorization	$authorization
WsdlFactory	$wsdlFactory

Definition at line 43 of file Generator.php.

       {
         $this->_wsdlFactory = $wsdlFactory;
         parent::__construct(
             $cache,
             $typeProcessor,
             $serviceTypeList,
             $serviceMetadata,
             $authorization
         );
     }

Member Function Documentation

◆ _addGenericFaultComplexTypeNodes()

_addGenericFaultComplexTypeNodes ( $wsdl )

protected

Add WSDL elements related to generic SOAP fault, which are common for all operations: element, type and message.

Parameters

Wsdl $wsdl

Returns: string Default fault message name

Definition at line 284 of file Generator.php.

     {
         $faultMessageName = Fault::NODE_DETAIL_WRAPPER;
         $complexTypeName = $this->getElementComplexTypeName($faultMessageName);
         $wsdl->addElement(
             [
                 'name' => $faultMessageName,
                 'type' => Wsdl::TYPES_NS . ':' . $complexTypeName,
             ]
         );
         $faultParamsComplexType = Fault::NODE_DETAIL_PARAMETER;
         $faultParamsData = [
             'parameters' => [
                 Fault::NODE_DETAIL_PARAMETER_KEY => [
                     'type' => 'string',
                     'required' => true,
                     'documentation' => '',
                 ],
                 Fault::NODE_DETAIL_PARAMETER_VALUE => [
                     'type' => 'string',
                     'required' => true,
                     'documentation' => '',
                 ],
             ],
         ];
         $wrappedErrorComplexType = Fault::NODE_DETAIL_WRAPPED_ERROR;
         $wrappedErrorData = [
             'parameters' => [
                 Fault::NODE_DETAIL_WRAPPED_ERROR_MESSAGE => [
                     'type' => 'string',
                     'required' => true,
                     'documentation' => '',
                 ],
                 Fault::NODE_DETAIL_WRAPPED_ERROR_PARAMETERS => [
                     'type' => "{$faultParamsComplexType}[]",
                     'required' => false,
                     'documentation' => 'Message parameters.',
                 ],
             ],
         ];
         $genericFaultTypeData = [
             'parameters' => [
                 Fault::NODE_DETAIL_TRACE => [
                     'type' => 'string',
                     'required' => false,
                     'documentation' => 'Exception calls stack trace.',
                 ],
                 Fault::NODE_DETAIL_PARAMETERS => [
                     'type' => "{$faultParamsComplexType}[]",
                     'required' => false,
                     'documentation' => 'Additional exception parameters.',
                 ],
                 Fault::NODE_DETAIL_WRAPPED_ERRORS => [
                     'type' => "{$wrappedErrorComplexType}[]",
                     'required' => false,
                     'documentation' => 'Additional wrapped errors.',
                 ],
             ],
         ];
         $this->typeProcessor->setTypeData($faultParamsComplexType, $faultParamsData);
         $this->typeProcessor->setTypeData($wrappedErrorComplexType, $wrappedErrorData);
         $this->typeProcessor->setTypeData($complexTypeName, $genericFaultTypeData);
         $wsdl->addComplexType($complexTypeName);
         $wsdl->addMessage(
             $faultMessageName,
             [
                 'messageParameters' => [
                     'element' => Wsdl::TYPES_NS . ':' . $faultMessageName,
                 ]
             ]
         );
 
         return Wsdl::TYPES_NS . ':' . $faultMessageName;
     }

◆ _createOperationInput()

_createOperationInput	(	Wsdl	$wsdl,
			$operationName,
			$methodData
	)

protected

Create input message and corresponding element and complex types in WSDL.

Parameters

Wsdl	$wsdl
string	$operationName
array	$methodData

Returns: string input message name

Definition at line 139 of file Generator.php.

     {
         $inputMessageName = $this->getInputMessageName($operationName);
         $complexTypeName = $this->getElementComplexTypeName($inputMessageName);
         $inputParameters = [];
         $elementData = [
             'name' => $inputMessageName,
             'type' => Wsdl::TYPES_NS . ':' . $complexTypeName,
         ];
         if (isset($methodData['interface']['in']['parameters'])) {
             $inputParameters = $methodData['interface']['in']['parameters'];
         } else {
             $elementData['nillable'] = 'true';
         }
         $wsdl->addElement($elementData);
         $callInfo = [];
         $callInfo['requiredInput']['yes']['calls'] = [$operationName];
         $typeData = [
             'documentation' => $methodData['documentation'],
             'parameters' => $inputParameters,
             'callInfo' => $callInfo,
         ];
         $this->typeProcessor->setTypeData($complexTypeName, $typeData);
         $wsdl->addComplexType($complexTypeName);
         $wsdl->addMessage(
             $inputMessageName,
             [
                 'messageParameters' => [
                     'element' => Wsdl::TYPES_NS . ':' . $inputMessageName,
                 ]
             ]
         );
         return Wsdl::TYPES_NS . ':' . $inputMessageName;
     }

◆ _createOperationOutput()

_createOperationOutput	(	Wsdl	$wsdl,
			$operationName,
			$methodData
	)

protected

Create output message and corresponding element and complex types in WSDL.

Parameters

Wsdl	$wsdl
string	$operationName
array	$methodData

Returns: string output message name

Definition at line 182 of file Generator.php.

     {
         $outputMessageName = $this->getOutputMessageName($operationName);
         $complexTypeName = $this->getElementComplexTypeName($outputMessageName);
         $wsdl->addElement(
             [
                 'name' => $outputMessageName,
                 'type' => Wsdl::TYPES_NS . ':' . $complexTypeName,
             ]
         );
         $callInfo = [];
         $callInfo['returned']['always']['calls'] = [$operationName];
         $typeData = [
             'documentation' => sprintf('Response container for the %s call.', $operationName),
             'parameters' => $methodData['interface']['out']['parameters'],
             'callInfo' => $callInfo,
         ];
         $this->typeProcessor->setTypeData($complexTypeName, $typeData);
         $wsdl->addComplexType($complexTypeName);
         $wsdl->addMessage(
             $outputMessageName,
             [
                 'messageParameters' => [
                     'element' => Wsdl::TYPES_NS . ':' . $outputMessageName,
                 ]
             ]
         );
         return Wsdl::TYPES_NS . ':' . $outputMessageName;
     }

◆ addCustomAttributeTypes()

addCustomAttributeTypes ( $wsdl )

protected

Create and add WSDL Types for complex custom attribute classes

Parameters

\Magento\Webapi\Model\Soap\Wsdl $wsdl

Returns: \Magento\Webapi\Model\Soap\Wsdl

Definition at line 122 of file Generator.php.

     {
         foreach ($this->serviceTypeList->getDataTypes() as $customAttributeClass) {
             $typeName = $this->typeProcessor->register($customAttributeClass);
             $wsdl->addComplexType($this->typeProcessor->getArrayItemType($typeName));
         }
         return $wsdl;
     }

◆ generateSchema()

generateSchema	(	$requestedServiceMetadata,
		$requestScheme,
		$requestHost,
		$endPointUrl
	)

protected

{}

Definition at line 64 of file Generator.php.

     {
         $wsdl = $this->_wsdlFactory->create(self::WSDL_NAME, $endPointUrl);
         $wsdl->addSchemaTypeSection();
         $faultMessageName = $this->_addGenericFaultComplexTypeNodes($wsdl);
         $wsdl = $this->addCustomAttributeTypes($wsdl);
 
         foreach ($requestedServiceMetadata as $serviceClass => &$serviceData) {
             $portTypeName = $this->getPortTypeName($serviceClass);
             $bindingName = $this->getBindingName($serviceClass);
             $portType = $wsdl->addPortType($portTypeName);
             $binding = $wsdl->addBinding($bindingName, Wsdl::TYPES_NS . ':' . $portTypeName);
             $wsdl->addSoapBinding($binding, 'document', 'http://schemas.xmlsoap.org/soap/http', SOAP_1_2);
             $portName = $this->getPortName($serviceClass);
             $serviceName = $this->getServiceName($serviceClass);
             $wsdl->addService($serviceName, $portName, Wsdl::TYPES_NS . ':' . $bindingName, $endPointUrl, SOAP_1_2);
 
             foreach ($serviceData[ServiceMetadata::KEY_SERVICE_METHODS] as $methodName => $methodData) {
                 $operationName = $this->typeProcessor->getOperationName($serviceClass, $methodName);
                 $bindingDataPrototype = ['use' => 'literal'];
                 $inputBinding = $bindingDataPrototype;
                 $inputMessageName = $this->_createOperationInput($wsdl, $operationName, $methodData);
 
                 $outputMessageName = false;
                 $outputBinding = false;
                 if (isset($methodData['interface']['out']['parameters'])) {
                     $outputBinding = $bindingDataPrototype;
                     $outputMessageName = $this->_createOperationOutput($wsdl, $operationName, $methodData);
                 }
                 $faultBinding = ['name' => Fault::NODE_DETAIL_WRAPPER];
 
                 $wsdl->addPortOperation(
                     $portType,
                     $operationName,
                     $inputMessageName,
                     $outputMessageName,
                     ['message' => $faultMessageName, 'name' => Fault::NODE_DETAIL_WRAPPER]
                 );
                 $bindingOperation = $wsdl->addBindingOperation(
                     $binding,
                     $operationName,
                     $inputBinding,
                     $outputBinding,
                     $faultBinding,
                     SOAP_1_2
                 );
                 $wsdl->addSoapOperation($bindingOperation, $operationName, SOAP_1_2);
             }
         }
         return $wsdl->toXML();
     }

◆ getAllowedServicesMetadata()

getAllowedServicesMetadata ( $requestedServices )

protected

{}

Definition at line 373 of file Generator.php.

     {
         $allowedServicesMetadata = parent::getAllowedServicesMetadata($requestedServices);
         if (!$allowedServicesMetadata) {
             throw new AuthorizationException(
                 __(
                     "The consumer isn't authorized to access %resources.",
                     ['resources' => implode(', ', $requestedServices)]
                 )
             );
         }
         return $allowedServicesMetadata;
     }

◆ getBindingName()

getBindingName ( $serviceName )

Get name for service binding node.

Parameters

string $serviceName

Returns: string

Definition at line 229 of file Generator.php.

     {
         return $serviceName . 'Binding';
     }

◆ getInputMessageName()

getInputMessageName ( $operationName )

Get input message node name for operation.

Parameters

string $operationName

Returns: string

Definition at line 262 of file Generator.php.

     {
         return $operationName . 'Request';
     }

◆ getOutputMessageName()

getOutputMessageName ( $operationName )

Get output message node name for operation.

Parameters

string $operationName

Returns: string

Definition at line 273 of file Generator.php.

     {
         return $operationName . 'Response';
     }

◆ getPortName()

getPortName ( $serviceName )

Get name for service port node.

Parameters

string $serviceName

Returns: string

Definition at line 240 of file Generator.php.

     {
         return $serviceName . 'Port';
     }

◆ getPortTypeName()

getPortTypeName ( $serviceName )

Get name for service portType node.

Parameters

string $serviceName

Returns: string

Definition at line 218 of file Generator.php.

     {
         return $serviceName . 'PortType';
     }

◆ getServiceMetadata()

getServiceMetadata ( $serviceName )

protected

Get service metadata

Parameters

string $serviceName

Returns: array

Definition at line 365 of file Generator.php.

     {
         return $this->serviceMetadata->getServiceMetadata($serviceName);
     }

◆ getServiceName()

getServiceName ( $serviceName )

Get name for service service.

Parameters

string $serviceName

Returns: string

Definition at line 251 of file Generator.php.

     {
         return $serviceName . 'Service';
     }

Field Documentation

◆ $_wsdlFactory

$_wsdlFactory

protected

Definition at line 31 of file Generator.php.

◆ WSDL_NAME

const WSDL_NAME = 'MagentoWSDL'

WSDL name

Definition at line 24 of file Generator.php.

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

vendor/magento/module-webapi/Model/Soap/Wsdl/Generator.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addGenericFaultComplexTypeNodes()

◆ _createOperationInput()

◆ _createOperationOutput()

◆ addCustomAttributeTypes()

◆ generateSchema()

◆ getAllowedServicesMetadata()

◆ getBindingName()

◆ getInputMessageName()

◆ getOutputMessageName()

◆ getPortName()

◆ getPortTypeName()

◆ getServiceMetadata()

◆ getServiceName()

Field Documentation

◆ $_wsdlFactory

◆ WSDL_NAME