Soap Class Reference

Inheritance diagram for Soap:

Public Member Functions
	call ($serviceInfo, $arguments=[], $storeCode=null, $integration=null)
	instantiateSoapClient ($wsdlUrl, $token=null)
	generateWsdlUrl ($services, $storeCode=null)

Data Fields
const	WSDL_BASE_PATH = '/soap'

Protected Member Functions
	_getSoapClient ($serviceInfo, $storeCode=null)
	_getSoapOperation ($serviceInfo)
	_getSoapServiceVersion ($serviceInfo)
	_getSoapServiceName ($serviceInfo)
	toSnakeCase (array $objectData)

Protected Attributes
	$_soapClients = []
	$_soapConfig
	$_converter

Detailed Description

Test client for SOAP API testing.

Definition at line 15 of file Soap.php.

Member Function Documentation

_getSoapClient()

_getSoapClient (   $serviceInfo,   $storeCode = null  )

protected

Get proper SOAP client instance that is initialized with WSDL corresponding to requested service interface.

Parameters

string	$serviceInfo	PHP service interface name, should include version if present
string | null	$storeCode

Returns

\Zend\Soap\Client

Check if there is SOAP client initialized with requested WSDL available

Definition at line 72 of file Soap.php.

    {
        $wsdlUrl = $this->generateWsdlUrl(
            [$this->_getSoapServiceName($serviceInfo) . $this->_getSoapServiceVersion($serviceInfo)],
            $storeCode
        );
        if (!isset($this->_soapClients[$wsdlUrl])) {
            $token = isset($serviceInfo['soap']['token']) ? $serviceInfo['soap']['token'] : null;
            $this->_soapClients[$wsdlUrl] = $this->instantiateSoapClient($wsdlUrl, $token);
        }
        return $this->_soapClients[$wsdlUrl];
    }

_getSoapOperation()

_getSoapOperation (   $serviceInfo )

protected

Retrieve SOAP operation name from available service info.

Parameters

array

$serviceInfo

Returns

string

Exceptions

Definition at line 148 of file Soap.php.

    {
        if (isset($serviceInfo['soap']['operation'])) {
            $soapOperation = $serviceInfo['soap']['operation'];
        } elseif (isset($serviceInfo['serviceInterface']) && isset($serviceInfo['method'])) {
            $soapOperation = $this->_soapConfig->getSoapOperation(
                $serviceInfo['serviceInterface'],
                $serviceInfo['method']
            );
        } else {
            throw new \LogicException("SOAP operation cannot be identified.");
        }
        return $soapOperation;
    }

_getSoapServiceName()

_getSoapServiceName (   $serviceInfo )

protected

Retrieve service name from available service info.

Parameters

array

$serviceInfo

Returns

string

Exceptions

Definition at line 206 of file Soap.php.

    {
        if (isset($serviceInfo['soap']['service'])) {
            $serviceName = $serviceInfo['soap']['service'];
        } elseif (isset($serviceInfo['serviceInterface'])) {
            $serviceName = $this->_soapConfig->getServiceName($serviceInfo['serviceInterface'], false);
        } else {
            throw new \LogicException("Service name cannot be identified.");
        }
        return $serviceName;
    }

_getSoapServiceVersion()

_getSoapServiceVersion (   $serviceInfo )

protected

Retrieve service version from available service info.

Parameters

array

$serviceInfo

Returns

string

Exceptions

Normalize version

Definition at line 170 of file Soap.php.

    {
        if (isset($serviceInfo['soap']['operation'])) {
            /*
                TODO: Need to rework this to remove version call for serviceInfo array with 'operation' key
                since version will be part of the service name
            */
            return '';
        } elseif (isset($serviceInfo['serviceInterface'])) {
            preg_match(
                \Magento\Webapi\Model\Config::SERVICE_CLASS_PATTERN,
                $serviceInfo['serviceInterface'],
                $matches
            );
            if (isset($matches[3])) {
                $version = $matches[3];
            } else {
                //TODO: Need to add this temporary version until version is added back for new MSC based services
                $version = 1;
                //throw new \LogicException("Service interface name is invalid.");
            }
        } else {
            throw new \LogicException("Service version cannot be identified.");
        }
        $version = 'V' . ltrim($version, 'vV');
        return $version;
    }

call()

call	(		$serviceInfo,
			$arguments = [],
			$storeCode = null,
			$integration = null
	)

{Perform call to the specified service method.

Parameters

array	$serviceInfo	array( 'rest' => array( 'resourcePath' => $resourcePath, // e.g. /products/:id 'httpMethod' => $httpMethod, // e.g. GET 'token' => '21hasbtlaqy8t3mj73kjh71cxxkqj4aq' // optional : for token based Authentication. Will override default Oauth based authentication provided by test framework ), 'soap' => array( 'service' => $soapService, // soap service name with Version suffix e.g. catalogProductV1, customerV2 'operation' => $operation // soap operation name e.g. catalogProductCreate 'token' => '21hasbtlaqy8t3mj73kjh71cxxkqj4aq' // optional : for token based Authentication. Will override default Oauth based authentication provided by test framework ), OR 'serviceInterface' => $phpServiceInterfaceName, // e.g. \Magento\Catalog\Api\ProductInterface 'method' => $serviceMethodName // e.g. create 'entityId' => $entityId // is used in REST route placeholder (if applicable) );
array	$arguments
string | null	$storeCode	if store code not provided, default store code will be used
\Magento\Integration\Model\Integration | null	$integration

Returns

array|string|int|float|bool

}

Remove result wrappers

Implements AdapterInterface.

Definition at line 51 of file Soap.php.

    {
        $soapOperation = $this->_getSoapOperation($serviceInfo);
        $arguments = $this->_converter->convertKeysToCamelCase($arguments);
        $soapResponse = $this->_getSoapClient($serviceInfo, $storeCode)->$soapOperation($arguments);
        //Convert to snake case for tests to use same assertion data for both SOAP and REST tests
        $result = (is_array($soapResponse) || is_object($soapResponse))
            ? $this->toSnakeCase($this->_converter->convertStdObjectToArray($soapResponse, true))
            : $soapResponse;
        $result = isset($result[SoapHandler::RESULT_NODE_NAME]) ? $result[SoapHandler::RESULT_NODE_NAME] : $result;
        return $result;
    }

generateWsdlUrl()

generateWsdlUrl	(		$services,
			$storeCode = null
	)

Generate WSDL URL.

Parameters

array	$services	e.g. array( 'catalogProductV1', 'customerV2' );
string | null	$storeCode

Returns

string

Sort list of services to avoid having different WSDL URLs for the identical lists of services.

TESTS_BASE_URL is initialized in PHPUnit configuration

Definition at line 120 of file Soap.php.

    {
        //TODO: This may change since same resource of multiple versions may be allowed after namespace changes
        ksort($services);
        if ($storeCode == null) {
            $storeCode = Bootstrap::getObjectManager()
                ->get(\Magento\Store\Model\StoreManagerInterface::class)
                ->getStore()
                ->getCode();
        }

        $wsdlUrl = rtrim(TESTS_BASE_URL, '/') . self::WSDL_BASE_PATH . '/' . $storeCode . '?wsdl=1&services=';
        $wsdlResourceArray = [];
        foreach ($services as $serviceName) {
            $wsdlResourceArray[] = $serviceName;
        }
        return $wsdlUrl . implode(",", $wsdlResourceArray);
    }

instantiateSoapClient()

instantiateSoapClient	(		$wsdlUrl,
			$token = null
	)

Create SOAP client instance and initialize it with provided WSDL URL.

Parameters

string	$wsdlUrl
string	$token	Authentication token

Returns

\Zend\Soap\Client

Definition at line 93 of file Soap.php.

    {
        $accessCredentials = $token
            ? $token
            : \Magento\TestFramework\Authentication\OauthHelper::getApiAccessCredentials()['key'];
        $opts = ['http' => ['header' => "Authorization: Bearer " . $accessCredentials]];
        $context = stream_context_create($opts);
        $soapClient = new \Zend\Soap\Client($wsdlUrl);
        $soapClient->setSoapVersion(SOAP_1_2);
        $soapClient->setStreamContext($context);
        if (TESTS_XDEBUG_ENABLED) {
            $soapClient->setCookie('XDEBUG_SESSION', 1);
        }
        return $soapClient;
    }

toSnakeCase()

toSnakeCase ( array  $objectData )

protected

Recursively transform array keys from camelCase to snake_case.

Utility method for converting SOAP responses. Webapi framework's SOAP processing outputs snake case Data Object properties(ex. item_id) as camel case(itemId) to adhere to the WSDL. This method allows tests to use the same data for asserting both SOAP and REST responses.

Parameters

array

$objectData

An array of data.

Returns

array The array with all camelCase keys converted to snake_case.

Definition at line 228 of file Soap.php.

    {
        $data = [];
        foreach ($objectData as $key => $value) {
            $key = strtolower(preg_replace("/(?<=\\w)(?=[A-Z])/", "_$1", $key));
            if (is_array($value)) {
                $data[$key] = $this->toSnakeCase($value);
            } else {
                $data[$key] = $value;
            }
        }
        return $data;
    }

Field Documentation

$_converter

$_converter

protected

Definition at line 34 of file Soap.php.

$_soapClients

$_soapClients = []

protected

Definition at line 24 of file Soap.php.

$_soapConfig

$_soapConfig

protected

Definition at line 29 of file Soap.php.

WSDL_BASE_PATH

const WSDL_BASE_PATH = '/soap'

Definition at line 17 of file Soap.php.

---

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

• vendor/magento/magento2-base/dev/tests/api-functional/framework/Magento/TestFramework/TestCase/Webapi/Adapter/Soap.php