Behat\SoapExtension\Utils\SoapManager

Complexity

Total Complexity

18

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	2

10 Methods

Rating	Name	Duplication	Size	Complexity
A	sendRequest()	0	20	2
A	extractResponseValueMatchingXPATH()	0	16	3
A	extractResponseProperty()	0	4	1
A	setWSDL()	0	4	1
A	setOptions()	0	10	3
A	setOption()	0	4	2
A	setNamespaces()	0	10	3
A	setNamespace()	0	4	1
A	getException()	0	3	1
A	setException()	0	3	1

<?php
/**
 * @author Sergii Bondarenko, <sb@firstvector.org>
 */
namespace Behat\SoapExtension\Utils;

/**
 * Trait SoapManager.
 *
 * @package Behat\SoapExtension\Utils
 */
trait SoapManager
{
    use ArrayManager;

    /**
     * URL of WSDL service to consume.
     *
     * @var string $wsdl
     */
    private $wsdl = '';
    /**
     * Set of options for SOAP request.
     *
     * @var array
     */
    private $options = [];
    /**
     * Response of SOAP method.
     *
     * @var mixed
     */
    private $response;
    /**
     * Last SOAP response.
     *
     * @var string
     */
    private $rawResponse = '';
    /**
     * The URIs of the namespaces.
     *
     * @var string[]
     */
    private $namespaces = [];

    /**
     * @var \SoapFault|null
     */
    private $exception;

    /**
     * Make SOAP call to a function with params.
     *
     * @param string $function
     *   SOAP function name to execute. Use MethodNameIsIgnored if function name is in the XML body.
     * @param array $arguments
     *   Arguments array to pass to soap call function.
     */
    protected function sendRequest($function, array $arguments)
    {
        // These values can be easily overridden inside of configuration file.
        $this->options += [
            // Important for raw response steps.
            'trace' => 1,
            'exceptions' => true,
            'cache_wsdl' => WSDL_CACHE_NONE,
        ];

        $client = new \SoapClient($this->wsdl, $this->options);

        try {
            $this->response = $client->__soapCall($function, $arguments);
            $this->rawResponse = $client->__getLastResponse();
        }
        catch (\SoapFault $e) {
            $this->exception = $e;
        }
    }

    /**
     * Extracts first value matching provided XPATH expression.
     *
     * @param string $query
     *   XPATH expression used to extract value from $this->rawResponse
     *
     * @return \DOMNode|bool
     */
    protected function extractResponseValueMatchingXPATH($query)
    {
        // @todo: Allow users to ignore namespaces via config or steps.
        // @example: $this->rawResponse = str_replace('xmlns=', 'ns=', $this->rawResponse);

50% of this comment could be valid code. Did you maybe forget this after debugging?

        $dom = new \DOMDocument();
        $dom->loadXML($this->rawResponse);
        $xpath = new \DOMXpath($dom);

        foreach ($this->namespaces as $prefix => $uri) {
            $xpath->registerNamespace($prefix, $uri);
        }

        $nodeList = $xpath->query($query);

        return $nodeList->length > 0 ? $nodeList->item(0)->nodeValue : false;
    }

    /**
     * Helper to extract a property value from the response.
     *
     * @param string $property
     *
     * @return mixed
     */
    protected function extractResponseProperty($property)
    {
        return static::arrayValue(static::objectToArray($this->response), explode('][', $property));
    }

    /**
     * @param string $wsdl
     */
    protected function setWSDL($wsdl)
    {
        $this->wsdl = $wsdl;
    }

    /**
     * @param array $options
     */
    protected function setOptions(array $options = null)
    {
        if (null === $options) {
            $this->options = [];
        } else {
            foreach ($options as $option => $value) {
                $this->setOption($option, $value);
            }
        }
    }

    /**
     * @param string $option
     * @param mixed $value
     */
    protected function setOption($option, $value)
    {
        $this->options[$option] = defined($value) ? constant($value) : $value;
    }

    /**
     * @param array $namespaces
     */
    protected function setNamespaces(array $namespaces = null)
    {
        if (null === $namespaces) {
            $this->namespaces = [];
        } else {
            foreach ($namespaces as $prefix => $uri) {
                $this->setNamespace($prefix, $uri);
            }
        }
    }

    /**
     * @param string $prefix
     * @param string $uri
     */
    protected function setNamespace($prefix, $uri)
    {
        $this->namespaces[$prefix] = $uri;
    }

    /**
     * @return \SoapFault
     */
    public function getException() {
        return $this->exception;
    }

    /**
     * @param \SoapFault $exception
     */
    public function setException(\SoapFault $exception = null) {
        $this->exception = $exception;
    }
}