NovaSearchServicesMethod::createService() - Code Metrics - orca-services/nova-api-php - Measure and Improve Code Quality continuously with Scrutinizer

NovaSearchServicesMethod::createService() A
last analyzed 2023-06-07 09:39 UTC

↳ Parent: NovaSearchServicesMethod

Complexity

Conditions	2
Paths	2

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	10
c	2
b	0
f	0
nc	2
nop	2
dl	0
loc	19
ccs	11
cts	11
cp	1
crap	2
rs	9.9332

<?php

namespace OrcaServices\NovaApi\Method;

use DOMDocument;
use DOMElement;
use Exception;
use OrcaServices\NovaApi\Parameter\NovaSearchServicesParameter;
use OrcaServices\NovaApi\Parser\NovaApiErrorParser;
use OrcaServices\NovaApi\Parser\NovaMessageParser;
use OrcaServices\NovaApi\Result\NovaSearchServicesResult;
use OrcaServices\NovaApi\Result\NovaServiceResult;
use OrcaServices\NovaApi\Soap\NovaApiSoapAction;
use OrcaServices\NovaApi\Xml\XmlDocument;

/**
 * SOAP method.
 */
final class NovaSearchServicesMethod implements NovaMethod
{
    /**
     * @var NovaApiSoapAction
     */
    private $novaSoapAction;

    /**
     * @var NovaApiErrorParser
     */
    private $novaErrorParser;

    /**
     * @var NovaMessageParser
     */
    private $novaMessageParser;

    /**
     * NovaSearchPartnerMethod constructor.
     *
     * @param NovaApiSoapAction $novaSoapAction The novaSoapAction
     * @param NovaApiErrorParser $novaErrorParser The novaErrorParser
     * @param NovaMessageParser $novaMessageParser The message parser
     */
    public function __construct(
        NovaApiSoapAction $novaSoapAction,
        NovaApiErrorParser $novaErrorParser,
        NovaMessageParser $novaMessageParser
    ) {
        $this->novaSoapAction = $novaSoapAction;
        $this->novaErrorParser = $novaErrorParser;
        $this->novaMessageParser = $novaMessageParser;
    }

    /**
     * Search NOVA services (customer) for a customer.
     *
     * https://confluence-ext.sbb.ch/display/NOVAUG/sucheLeistungen
     *
     * @param NovaSearchServicesParameter $parameter The parameters
     *
     * @throws Exception
     *
     * @return NovaSearchServicesResult The services matching the search parameter
     */
    public function searchServices(NovaSearchServicesParameter $parameter): NovaSearchServicesResult
    {
        // The SOAP endpoint url
        $url = $this->novaSoapAction->getNovaSalesServiceUrl();

        // The SOAP action (http header)
        $soapAction = $this->novaSoapAction->getSoapAction('geschaeftspartner', 'sucheLeistungen');

        // The SOAP content (http body)
        $body = $this->createRequestBody($parameter);

        try {
            $xmlContent = $this->novaSoapAction->invokeSoapRequest($url, $soapAction, $body);
            $xml = XmlDocument::createFromXmlString($xmlContent);

            return $this->createResult($xml);
        } catch (Exception $exception) {
            throw $this->novaErrorParser->createGeneralException($exception);
        }
    }

    /**
     * Create SOAP body XML content.
     *
     * @param NovaSearchServicesParameter $parameter The parameters
     *
     * @return string The xml content
     */
    private function createRequestBody(NovaSearchServicesParameter $parameter): string
    {
        $dom = new DOMDocument('1.0', 'utf-8');
        $dom->formatOutput = true;

        $dom->appendChild($dom->createComment(' powered by Barakuda '));

        $envelope = $dom->createElement('soapenv:Envelope');
        $dom->appendChild($envelope);
        $envelope->setAttribute('xmlns:soapenv', 'http://schemas.xmlsoap.org/soap/envelope/');

        $soapHeader = $dom->createElement('soapenv:Header');
        $envelope->appendChild($soapHeader);

        $body = $dom->createElement('soapenv:Body');
        $envelope->appendChild($body);

        $method = $dom->createElement('sucheLeistungen');
        $body->appendChild($method);

        $searchQuery = $dom->createElement('leistungsSuchRequest');
        $this->novaSoapAction->appendDomClientIdentifier($dom, $searchQuery, $parameter, '');
        $this->novaSoapAction->appendDomCorrelationContext($dom, $searchQuery, $parameter, '');

        if ($parameter->serviceId) {
            $serviceKey = $dom->createElement('leistungsSchluessel');
            $searchQuery->appendChild($serviceKey);
            $serviceKey->appendChild($dom->createElement('leistungsId', $parameter->serviceId));
        }

        if ($parameter->tkId) {
            $service = $dom->createElement('leistung');

            $tkid = $dom->createElement('tkid');
            $tkid->appendChild($dom->createTextNode($parameter->tkId));
            $service->appendChild($tkid);

            if ($parameter->periodOfUseStart || $parameter->periodOfUseEnd) {
                $periodOfUse = $dom->createElement('nutzungsZeitraum');
                $service->appendChild($periodOfUse);
            }

            if ($parameter->periodOfUseStart && isset($periodOfUse)) {
                $periodOfUse->setAttribute('base:von', $parameter->periodOfUseStart->format('Y-m-d'));
            }

            if ($parameter->periodOfUseEnd && isset($periodOfUse)) {
                $periodOfUse->setAttribute('base:bis', $parameter->periodOfUseEnd->format('Y-m-d'));
            }

            $searchQuery->appendChild($service);
        }

        $method->appendChild($searchQuery);

        $this->novaSoapAction->appendMethodNamespaces($method);

        return (string)$dom->saveXML();
    }

    /**
     * Create result object.
     *
     * @param XmlDocument $xml The xml document
     *
     * @return NovaSearchServicesResult The mapped result
     */
    private function createResult(XmlDocument $xml): NovaSearchServicesResult
    {
        $result = new NovaSearchServicesResult();

        $xml = $xml->withoutNamespaces();

        // Find and append all messages
        foreach ($this->novaMessageParser->findNovaMessages($xml) as $message) {
            $result->addMessage($message);
        }

        // Root node
        $responseNode = $xml->queryFirstNode('/Envelope/Body/sucheLeistungenResponse/leistungsSuchResponse');
        $serviceNodes = $xml->queryNodes('leistungsSuchErgebnis/leistung', $responseNode);

        /** @var DOMElement $serviceNode */
        foreach ($serviceNodes as $serviceNode) {
            $result->services[] = $this->createService($serviceNode, $xml);
        }

        return $result;
    }

    /**
     * Map partner node to NovaPartner object.
     *
     * @param DOMElement $serviceNode The partnerNode
     * @param XmlDocument $xml The xml document
     *
     * @return NovaServiceResult The new NovaService instance
     */
    private function createService(DOMElement $serviceNode, XmlDocument $xml): NovaServiceResult
    {
        $service = new NovaServiceResult();

        $service->tkId = $xml->getNodeValue('verkaufsParameter/wert/tkid', $serviceNode);
        $service->validFrom = $xml->createChronosFromXsDateTime(
            $xml->getAttributeValue('nutzungsInfo/nutzungsZeitraum/tarifierbarerZeitraum/@von', $serviceNode)
        );
        $service->validTo = $xml->createChronosFromXsDateTime(
            $xml->getAttributeValue('nutzungsInfo/nutzungsZeitraum/tarifierbarerZeitraum/@bis', $serviceNode)
        );

        $service->productNumber = $xml->getAttributeValue('@produktNummer', $serviceNode);

        foreach ($xml->queryNodes('geltungsBereich/zonenGeltungsBereich/zonenBuendel/zonen', $serviceNode) as $zone) {
            $service->zones[] = $xml->getNodeValue('code', $zone);
        }

        return $service;
    }
}


1		<?php
2
3		namespace OrcaServices\NovaApi\Method;
4
5		use DOMDocument;
6		use DOMElement;
7		use Exception;
8		use OrcaServices\NovaApi\Parameter\NovaSearchServicesParameter;
9		use OrcaServices\NovaApi\Parser\NovaApiErrorParser;
10		use OrcaServices\NovaApi\Parser\NovaMessageParser;
11		use OrcaServices\NovaApi\Result\NovaSearchServicesResult;
12		use OrcaServices\NovaApi\Result\NovaServiceResult;
13		use OrcaServices\NovaApi\Soap\NovaApiSoapAction;
14		use OrcaServices\NovaApi\Xml\XmlDocument;
15
16		/**
17		* SOAP method.
18		*/
19		final class NovaSearchServicesMethod implements NovaMethod
20		{
21		/**
22		* @var NovaApiSoapAction
23		*/
24		private $novaSoapAction;
25
26		/**
27		* @var NovaApiErrorParser
28		*/
29		private $novaErrorParser;
30
31		/**
32		* @var NovaMessageParser
33		*/
34		private $novaMessageParser;
35
36		/**
37		* NovaSearchPartnerMethod constructor.
38		*
39		* @param NovaApiSoapAction $novaSoapAction The novaSoapAction
40		* @param NovaApiErrorParser $novaErrorParser The novaErrorParser
41		* @param NovaMessageParser $novaMessageParser The message parser
42		*/
43	13	public function __construct(
44		NovaApiSoapAction $novaSoapAction,
45		NovaApiErrorParser $novaErrorParser,
46		NovaMessageParser $novaMessageParser
47		) {
48	13	$this->novaSoapAction = $novaSoapAction;
49	13	$this->novaErrorParser = $novaErrorParser;
50	13	$this->novaMessageParser = $novaMessageParser;
51	13	}
52
53		/**
54		* Search NOVA services (customer) for a customer.
55		*
56		* https://confluence-ext.sbb.ch/display/NOVAUG/sucheLeistungen
57		*
58		* @param NovaSearchServicesParameter $parameter The parameters
59		*
60		* @throws Exception
61		*
62		* @return NovaSearchServicesResult The services matching the search parameter
63		*/
64	2	public function searchServices(NovaSearchServicesParameter $parameter): NovaSearchServicesResult
65		{
66		// The SOAP endpoint url
67	2	$url = $this->novaSoapAction->getNovaSalesServiceUrl();
68
69		// The SOAP action (http header)
70	2	$soapAction = $this->novaSoapAction->getSoapAction('geschaeftspartner', 'sucheLeistungen');
71
72		// The SOAP content (http body)
73	2	$body = $this->createRequestBody($parameter);
74
75		try {
76	2	$xmlContent = $this->novaSoapAction->invokeSoapRequest($url, $soapAction, $body);
77	2	$xml = XmlDocument::createFromXmlString($xmlContent);
78
79	2	return $this->createResult($xml);
80		} catch (Exception $exception) {
81		throw $this->novaErrorParser->createGeneralException($exception);
82		}
83		}
84
85		/**
86		* Create SOAP body XML content.
87		*
88		* @param NovaSearchServicesParameter $parameter The parameters
89		*
90		* @return string The xml content
91		*/
92	2	private function createRequestBody(NovaSearchServicesParameter $parameter): string
93		{
94	2	$dom = new DOMDocument('1.0', 'utf-8');
95	2	$dom->formatOutput = true;
96
97	2	$dom->appendChild($dom->createComment(' powered by Barakuda '));
98
99	2	$envelope = $dom->createElement('soapenv:Envelope');
100	2	$dom->appendChild($envelope);
101	2	$envelope->setAttribute('xmlns:soapenv', 'http://schemas.xmlsoap.org/soap/envelope/');
102
103	2	$soapHeader = $dom->createElement('soapenv:Header');
104	2	$envelope->appendChild($soapHeader);
105
106	2	$body = $dom->createElement('soapenv:Body');
107	2	$envelope->appendChild($body);
108
109	2	$method = $dom->createElement('sucheLeistungen');
110	2	$body->appendChild($method);
111
112	2	$searchQuery = $dom->createElement('leistungsSuchRequest');
113	2	$this->novaSoapAction->appendDomClientIdentifier($dom, $searchQuery, $parameter, '');
114	2	$this->novaSoapAction->appendDomCorrelationContext($dom, $searchQuery, $parameter, '');
115
116	2	if ($parameter->serviceId) {
117	1	$serviceKey = $dom->createElement('leistungsSchluessel');
118	1	$searchQuery->appendChild($serviceKey);
119	1	$serviceKey->appendChild($dom->createElement('leistungsId', $parameter->serviceId));
120		}
121
122	2	if ($parameter->tkId) {
123	1	$service = $dom->createElement('leistung');
124
125	1	$tkid = $dom->createElement('tkid');
126	1	$tkid->appendChild($dom->createTextNode($parameter->tkId));
127	1	$service->appendChild($tkid);
128
129	1	if ($parameter->periodOfUseStart \|\| $parameter->periodOfUseEnd) {
130	1	$periodOfUse = $dom->createElement('nutzungsZeitraum');
131	1	$service->appendChild($periodOfUse);
132		}
133
134	1	if ($parameter->periodOfUseStart && isset($periodOfUse)) {
135	1	$periodOfUse->setAttribute('base:von', $parameter->periodOfUseStart->format('Y-m-d'));
136		}
137
138	1	if ($parameter->periodOfUseEnd && isset($periodOfUse)) {
139	1	$periodOfUse->setAttribute('base:bis', $parameter->periodOfUseEnd->format('Y-m-d'));
140		}
141
142	1	$searchQuery->appendChild($service);
143		}
144
145	2	$method->appendChild($searchQuery);
146
147	2	$this->novaSoapAction->appendMethodNamespaces($method);
148
149	2	return (string)$dom->saveXML();
150		}
151
152		/**
153		* Create result object.
154		*
155		* @param XmlDocument $xml The xml document
156		*
157		* @return NovaSearchServicesResult The mapped result
158		*/
159	2	private function createResult(XmlDocument $xml): NovaSearchServicesResult
160		{
161	2	$result = new NovaSearchServicesResult();
162
163	2	$xml = $xml->withoutNamespaces();
164
165		// Find and append all messages
166	2	foreach ($this->novaMessageParser->findNovaMessages($xml) as $message) {
167		$result->addMessage($message);
168		}
169
170		// Root node
171	2	$responseNode = $xml->queryFirstNode('/Envelope/Body/sucheLeistungenResponse/leistungsSuchResponse');
172	2	$serviceNodes = $xml->queryNodes('leistungsSuchErgebnis/leistung', $responseNode);
173
174		/** @var DOMElement $serviceNode */
175	2	foreach ($serviceNodes as $serviceNode) {
176	2	$result->services[] = $this->createService($serviceNode, $xml);
177		}
178
179	2	return $result;
180		}
181
182		/**
183		* Map partner node to NovaPartner object.
184		*
185		* @param DOMElement $serviceNode The partnerNode
186		* @param XmlDocument $xml The xml document
187		*
188		* @return NovaServiceResult The new NovaService instance
189		*/
190	2	private function createService(DOMElement $serviceNode, XmlDocument $xml): NovaServiceResult
191		{
192	2	$service = new NovaServiceResult();
193
194	2	$service->tkId = $xml->getNodeValue('verkaufsParameter/wert/tkid', $serviceNode);
195	2	$service->validFrom = $xml->createChronosFromXsDateTime(
196	2	$xml->getAttributeValue('nutzungsInfo/nutzungsZeitraum/tarifierbarerZeitraum/@von', $serviceNode)
197		);
198	2	$service->validTo = $xml->createChronosFromXsDateTime(
199	2	$xml->getAttributeValue('nutzungsInfo/nutzungsZeitraum/tarifierbarerZeitraum/@bis', $serviceNode)
200		);
201
202	2	$service->productNumber = $xml->getAttributeValue('@produktNummer', $serviceNode);
203
204	2	foreach ($xml->queryNodes('geltungsBereich/zonenGeltungsBereich/zonenBuendel/zonen', $serviceNode) as $zone) {
205	1	$service->zones[] = $xml->getNodeValue('code', $zone);
206		}
207
208	2	return $service;
209		}
210		}
211

orca-services / nova-api-php

NovaSearchServicesMethod::createService() A last analyzed 2023-06-07 09:39 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

NovaSearchServicesMethod::createService() A
last analyzed 2023-06-07 09:39 UTC