Address::toXML() - Code Metrics - Inspection of "62528d1dddcb215496c54111843faaca8e7bd609" - zangra-dev/bpost-api-library - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Branch — master (62528d)

by Zangra

created 2025-09-12 10:40 UTC

Address::toXML() B

↳ Parent: Address

Complexity

Conditions	7
Paths	64

Size

Total Lines	48
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
eloc	27
c	3
b	0
f	0
dl	0
loc	48
rs	8.5546
cc	7
nc	64
nop	2

<?php
declare(strict_types=1);

namespace Bpost\BpostApiClient\Bpost\Order;

use Bpost\BpostApiClient\Common\XmlHelper;
use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidLengthException;
use DOMDocument;
use DOMElement;
use SimpleXMLElement;

/**
 * bPost Address class
 *
 * @author Tijs Verkoyen <[email protected]>
 */
class Address
{
    public const TAG_NAME = 'address';

    private ?string $streetName   = null;
    private ?string $number       = null;
    private ?string $box          = null;
    private ?string $postalCode   = null;
    private ?string $locality     = null;
    private ?string $countryCode  = 'BE';

    /**
     * @throws BpostInvalidLengthException
     */
    public function __construct(
        ?string $streetName = null,
        ?string $number = null,
        ?string $box = null,
        ?string $postalCode = null,
        ?string $locality = null,
        ?string $countryCode = null
    ) {
        if ($streetName   !== null) $this->setStreetName($streetName);
        if ($number       !== null) $this->setNumber($number);
        if ($box          !== null) $this->setBox($box);
        if ($postalCode   !== null) $this->setPostalCode($postalCode);
        if ($locality     !== null) $this->setLocality($locality);
        if ($countryCode  !== null) $this->setCountryCode($countryCode);
    }

    /**
     * @throws BpostInvalidLengthException
     */
    public function setBox(?string $box): void
    {
        if ($box === null) {
            $this->box = null;
            return;
        }

        $max = 8;
        if (mb_strlen($box) > $max) {
            throw new BpostInvalidLengthException('box', mb_strlen($box), $max);
        }
        $this->box = $box;
    }
    public function getBox(): ?string
    {
        return $this->box;
    }

    /**
     * @throws BpostInvalidLengthException
     */
    public function setCountryCode(string $countryCode): void
    {
        $max = 2;
        if (mb_strlen($countryCode) > $max) {
            throw new BpostInvalidLengthException('countryCode', mb_strlen($countryCode), $max);
        }
        $this->countryCode = strtoupper($countryCode);
    }
    public function getCountryCode(): ?string
    {
        return $this->countryCode;
    }

    /**
     * @throws BpostInvalidLengthException
     */
    public function setLocality(string $locality): void
    {
        $max = 40;
        if (mb_strlen($locality) > $max) {
            throw new BpostInvalidLengthException('locality', mb_strlen($locality), $max);
        }
        $this->locality = $locality;
    }
    public function getLocality(): ?string
    {
        return $this->locality;
    }

    /**
     * @throws BpostInvalidLengthException
     */
    public function setNumber(string $number): void
    {
        $max = 8;
        if (mb_strlen($number) > $max) {
            throw new BpostInvalidLengthException('number', mb_strlen($number), $max);
        }
        $this->number = $number;
    }
    public function getNumber(): ?string
    {
        return $this->number;
    }

    /**
     * @throws BpostInvalidLengthException
     */
    public function setPostalCode(string $postalCode): void
    {
        $max = 40;
        if (mb_strlen($postalCode) > $max) {
            throw new BpostInvalidLengthException('postalCode', mb_strlen($postalCode), $max);
        }
        $this->postalCode = $postalCode;
    }
    public function getPostalCode(): ?string
    {
        return $this->postalCode;
    }

    /**
     * @throws BpostInvalidLengthException
     */
    public function setStreetName(string $streetName): void
    {
        $max = 40;
        if (mb_strlen($streetName) > $max) {
            throw new BpostInvalidLengthException('streetName', mb_strlen($streetName), $max);
        }
        $this->streetName = $streetName;
    }
    public function getStreetName(): ?string
    {
        return $this->streetName;
    }

    /**
     * @throws \DOMException
     */
    public function toXML(DOMDocument $document, ?string $prefix = 'common'): DOMElement
    {
        // <common:address>
        $address = $document->createElement(
            XmlHelper::getPrefixedTagName(self::TAG_NAME, $prefix)
        );

        // <common:streetName>, <common:number>, <common:box>
        if ($this->streetName !== null) {
            $address->appendChild($document->createElement(
                XmlHelper::getPrefixedTagName('streetName', $prefix),
                $this->streetName
            ));
        }
        if ($this->number !== null) {
            $address->appendChild($document->createElement(
                XmlHelper::getPrefixedTagName('number', $prefix),
                $this->number
            ));
        }
        if ($this->box !== null) {
            $address->appendChild($document->createElement(
                XmlHelper::getPrefixedTagName('box', $prefix),
                $this->box
            ));
        }

        // <common:postalCode>, <common:locality>, <common:countryCode>
        if ($this->postalCode !== null) {
            $address->appendChild($document->createElement(
                XmlHelper::getPrefixedTagName('postalCode', $prefix),
                $this->postalCode
            ));
        }
        if ($this->locality !== null) {
            $address->appendChild($document->createElement(
                XmlHelper::getPrefixedTagName('locality', $prefix),
                $this->locality
            ));
        }
        if ($this->countryCode !== null) {
            $address->appendChild($document->createElement(
                XmlHelper::getPrefixedTagName('countryCode', $prefix),
                $this->countryCode
            ));
        }

        return $address;
    }

    /**
     * @throws BpostInvalidLengthException
     */
    public static function createFromXML(SimpleXMLElement $xml): Address
    {
        $address = new static();
        if (isset($xml->streetName) && $xml->streetName != '') {
            $address->setStreetName((string) $xml->streetName);
        }
        if (isset($xml->number) && $xml->number != '') {
            $address->setNumber((string) $xml->number);
        }
        if (isset($xml->box) && $xml->box != '') {
            $address->setBox((string) $xml->box);
        }
        if (isset($xml->postalCode) && $xml->postalCode != '') {
            $address->setPostalCode((string) $xml->postalCode);
        }
        if (isset($xml->locality) && $xml->locality != '') {
            $address->setLocality((string) $xml->locality);
        }
        if (isset($xml->countryCode) && $xml->countryCode != '') {
            $address->setCountryCode((string) $xml->countryCode);
        }
        return $address;
    }

    /**
     * @throws \DOMException
     */
    private function streetToXML(DOMDocument $document, string $prefix, DOMElement $address): void

    {
        if ($this->streetName !== null) {
            $address->appendChild(
                $document->createElement(XmlHelper::getPrefixedTagName('streetName', $prefix), $this->streetName)
            );
        }
    }

    /**
     * @throws \DOMException
     */
    private function localityToXML(DOMDocument $document, string $prefix, DOMElement $address): void

    {
        if ($this->postalCode !== null) {
            $address->appendChild(
                $document->createElement(XmlHelper::getPrefixedTagName('postalCode', $prefix), $this->postalCode)
            );
        }
        if ($this->locality !== null) {
            $address->appendChild(
                $document->createElement(XmlHelper::getPrefixedTagName('locality', $prefix), $this->locality)
            );
        }
    }

    /**
     * @throws \DOMException
     */
    private function countryToXML(DOMDocument $document, string $prefix, DOMElement $address): void

    {
        if ($this->countryCode !== null) {
            $address->appendChild(
                $document->createElement(XmlHelper::getPrefixedTagName('countryCode', $prefix), $this->countryCode)
            );
        }
    }

    /**
     * @throws \DOMException
     */
    private function streetNumbersToXML(DOMDocument $document, string $prefix, DOMElement $address): void

    {
        if ($this->number !== null) {
            $address->appendChild(
                $document->createElement(XmlHelper::getPrefixedTagName('number', $prefix), $this->number)
            );
        }
        if ($this->box !== null) {
            $address->appendChild(
                $document->createElement(XmlHelper::getPrefixedTagName('box', $prefix), $this->box)
            );
        }
    }
}

1			<?php
2			declare(strict_types=1);
3
4			namespace Bpost\BpostApiClient\Bpost\Order;
5
6			use Bpost\BpostApiClient\Common\XmlHelper;
7			use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidLengthException;
8			use DOMDocument;
9			use DOMElement;
10			use SimpleXMLElement;
11
12			/**
13			* bPost Address class
14			*
15			* @author Tijs Verkoyen <[email protected]>
16			*/
17			class Address
18			{
19			public const TAG_NAME = 'address';
20
21			private ?string $streetName = null;
22			private ?string $number = null;
23			private ?string $box = null;
24			private ?string $postalCode = null;
25			private ?string $locality = null;
26			private ?string $countryCode = 'BE';
27
28			/**
29			* @throws BpostInvalidLengthException
30			*/
31			public function __construct(
32			?string $streetName = null,
33			?string $number = null,
34			?string $box = null,
35			?string $postalCode = null,
36			?string $locality = null,
37			?string $countryCode = null
38			) {
39			if ($streetName !== null) $this->setStreetName($streetName);
40			if ($number !== null) $this->setNumber($number);
41			if ($box !== null) $this->setBox($box);
42			if ($postalCode !== null) $this->setPostalCode($postalCode);
43			if ($locality !== null) $this->setLocality($locality);
44			if ($countryCode !== null) $this->setCountryCode($countryCode);
45			}
46
47			/**
48			* @throws BpostInvalidLengthException
49			*/
50			public function setBox(?string $box): void
51			{
52			if ($box === null) {
53			$this->box = null;
54			return;
55			}
56
57			$max = 8;
58			if (mb_strlen($box) > $max) {
59			throw new BpostInvalidLengthException('box', mb_strlen($box), $max);
60			}
61			$this->box = $box;
62			}
63			public function getBox(): ?string
64			{
65			return $this->box;
66			}
67
68			/**
69			* @throws BpostInvalidLengthException
70			*/
71			public function setCountryCode(string $countryCode): void
72			{
73			$max = 2;
74			if (mb_strlen($countryCode) > $max) {
75			throw new BpostInvalidLengthException('countryCode', mb_strlen($countryCode), $max);
76			}
77			$this->countryCode = strtoupper($countryCode);
78			}
79			public function getCountryCode(): ?string
80			{
81			return $this->countryCode;
82			}
83
84			/**
85			* @throws BpostInvalidLengthException
86			*/
87			public function setLocality(string $locality): void
88			{
89			$max = 40;
90			if (mb_strlen($locality) > $max) {
91			throw new BpostInvalidLengthException('locality', mb_strlen($locality), $max);
92			}
93			$this->locality = $locality;
94			}
95			public function getLocality(): ?string
96			{
97			return $this->locality;
98			}
99
100			/**
101			* @throws BpostInvalidLengthException
102			*/
103			public function setNumber(string $number): void
104			{
105			$max = 8;
106			if (mb_strlen($number) > $max) {
107			throw new BpostInvalidLengthException('number', mb_strlen($number), $max);
108			}
109			$this->number = $number;
110			}
111			public function getNumber(): ?string
112			{
113			return $this->number;
114			}
115
116			/**
117			* @throws BpostInvalidLengthException
118			*/
119			public function setPostalCode(string $postalCode): void
120			{
121			$max = 40;
122			if (mb_strlen($postalCode) > $max) {
123			throw new BpostInvalidLengthException('postalCode', mb_strlen($postalCode), $max);
124			}
125			$this->postalCode = $postalCode;
126			}
127			public function getPostalCode(): ?string
128			{
129			return $this->postalCode;
130			}
131
132			/**
133			* @throws BpostInvalidLengthException
134			*/
135			public function setStreetName(string $streetName): void
136			{
137			$max = 40;
138			if (mb_strlen($streetName) > $max) {
139			throw new BpostInvalidLengthException('streetName', mb_strlen($streetName), $max);
140			}
141			$this->streetName = $streetName;
142			}
143			public function getStreetName(): ?string
144			{
145			return $this->streetName;
146			}
147
148			/**
149			* @throws \DOMException
150			*/
151			public function toXML(DOMDocument $document, ?string $prefix = 'common'): DOMElement
152			{
153			// <common:address>
154			$address = $document->createElement(
155			XmlHelper::getPrefixedTagName(self::TAG_NAME, $prefix)
156			);
157
158			// <common:streetName>, <common:number>, <common:box>
159			if ($this->streetName !== null) {
160			$address->appendChild($document->createElement(
161			XmlHelper::getPrefixedTagName('streetName', $prefix),
162			$this->streetName
163			));
164			}
165			if ($this->number !== null) {
166			$address->appendChild($document->createElement(
167			XmlHelper::getPrefixedTagName('number', $prefix),
168			$this->number
169			));
170			}
171			if ($this->box !== null) {
172			$address->appendChild($document->createElement(
173			XmlHelper::getPrefixedTagName('box', $prefix),
174			$this->box
175			));
176			}
177
178			// <common:postalCode>, <common:locality>, <common:countryCode>
179			if ($this->postalCode !== null) {
180			$address->appendChild($document->createElement(
181			XmlHelper::getPrefixedTagName('postalCode', $prefix),
182			$this->postalCode
183			));
184			}
185			if ($this->locality !== null) {
186			$address->appendChild($document->createElement(
187			XmlHelper::getPrefixedTagName('locality', $prefix),
188			$this->locality
189			));
190			}
191			if ($this->countryCode !== null) {
192			$address->appendChild($document->createElement(
193			XmlHelper::getPrefixedTagName('countryCode', $prefix),
194			$this->countryCode
195			));
196			}
197
198			return $address;
199			}
200
201			/**
202			* @throws BpostInvalidLengthException
203			*/
204			public static function createFromXML(SimpleXMLElement $xml): Address
205			{
206			$address = new static();
207			if (isset($xml->streetName) && $xml->streetName != '') {
208			$address->setStreetName((string) $xml->streetName);
209			}
210			if (isset($xml->number) && $xml->number != '') {
211			$address->setNumber((string) $xml->number);
212			}
213			if (isset($xml->box) && $xml->box != '') {
214			$address->setBox((string) $xml->box);
215			}
216			if (isset($xml->postalCode) && $xml->postalCode != '') {
217			$address->setPostalCode((string) $xml->postalCode);
218			}
219			if (isset($xml->locality) && $xml->locality != '') {
220			$address->setLocality((string) $xml->locality);
221			}
222			if (isset($xml->countryCode) && $xml->countryCode != '') {
223			$address->setCountryCode((string) $xml->countryCode);
224			}
225			return $address;
226			}
227
228			/**
229			* @throws \DOMException
230			*/
231			private function streetToXML(DOMDocument $document, string $prefix, DOMElement $address): void
			0 ignored issues – show Unused Code introduced 2025-09-12 10:13 UTC by Report Bug Copy Issue Report The method `streetToXML()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
232			{
233			if ($this->streetName !== null) {
234			$address->appendChild(
235			$document->createElement(XmlHelper::getPrefixedTagName('streetName', $prefix), $this->streetName)
236			);
237			}
238			}
239
240			/**
241			* @throws \DOMException
242			*/
243			private function localityToXML(DOMDocument $document, string $prefix, DOMElement $address): void
			0 ignored issues – show Unused Code introduced 2025-09-12 10:13 UTC by Report Bug Copy Issue Report The method `localityToXML()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
244			{
245			if ($this->postalCode !== null) {
246			$address->appendChild(
247			$document->createElement(XmlHelper::getPrefixedTagName('postalCode', $prefix), $this->postalCode)
248			);
249			}
250			if ($this->locality !== null) {
251			$address->appendChild(
252			$document->createElement(XmlHelper::getPrefixedTagName('locality', $prefix), $this->locality)
253			);
254			}
255			}
256
257			/**
258			* @throws \DOMException
259			*/
260			private function countryToXML(DOMDocument $document, string $prefix, DOMElement $address): void
			0 ignored issues – show Unused Code introduced 2025-09-12 10:13 UTC by Report Bug Copy Issue Report The method `countryToXML()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
261			{
262			if ($this->countryCode !== null) {
263			$address->appendChild(
264			$document->createElement(XmlHelper::getPrefixedTagName('countryCode', $prefix), $this->countryCode)
265			);
266			}
267			}
268
269			/**
270			* @throws \DOMException
271			*/
272			private function streetNumbersToXML(DOMDocument $document, string $prefix, DOMElement $address): void
			0 ignored issues – show Unused Code introduced 2025-09-12 10:13 UTC by Report Bug Copy Issue Report The method `streetNumbersToXML()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
273			{
274			if ($this->number !== null) {
275			$address->appendChild(
276			$document->createElement(XmlHelper::getPrefixedTagName('number', $prefix), $this->number)
277			);
278			}
279			if ($this->box !== null) {
280			$address->appendChild(
281			$document->createElement(XmlHelper::getPrefixedTagName('box', $prefix), $this->box)
282			);
283			}
284			}
285			}

zangra-dev / bpost-api-library

Branch — master (62528d)

Address::toXML() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like