Address - Code Metrics - Antidot-be/bpost-api-library - Measure and Improve Code Quality continuously with Scrutinizer

Address B
last analyzed 2016-08-25 18:47 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	317
Duplicated Lines	15.14 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	51
lcom	1
cbo	1
dl	48
loc	317
ccs	166
cts	166
cp	1
rs	8.3206
c	0
b	0
f	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	setBox()	8	8	2
A	getBox()	0	4	1
A	setCountryCode()	8	8	2
A	getCountryCode()	0	4	1
A	setLocality()	8	8	2
A	getLocality()	0	4	1
A	setNumber()	8	8	2
A	getNumber()	0	4	1
A	setPostalCode()	8	8	2
A	getPostalCode()	0	4	1
A	setStreetName()	8	8	2
A	getStreetName()	0	4	1
C	__construct()	0	27	7
F	toXML()	0	81	13
C	createFromXML()	0	25	13

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Address often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Address, and based on these observations, apply Extract Interface, too.

<?php
namespace Bpost\BpostApiClient\Bpost\Order;

use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidLengthException;

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

    /**
     * @var string
     */
    private $streetName;

    /**
     * @var string
     */
    private $number;

    /**
     * @var string
     */
    private $box;

    /**
     * @var string
     */
    private $postalCode;

    /**
     * @var string
     */
    private $locality;

    /**
     * @var string
     */
    private $countryCode = 'BE';

    /**
     * @param string $box
     * @throws BpostInvalidLengthException
     */
    public function setBox($box)

    {
        $length = 8;
        if (mb_strlen($box) > $length) {
            throw new BpostInvalidLengthException('box', mb_strlen($box), $length);
        }
        $this->box = $box;
    }

    /**
     * @return string
     */
    public function getBox()
    {
        return $this->box;
    }

    /**
     * @param string $countryCode
     * @throws BpostInvalidLengthException
     */
    public function setCountryCode($countryCode)

    {
        $length = 2;
        if (mb_strlen($countryCode) > $length) {
            throw new BpostInvalidLengthException('countryCode', mb_strlen($countryCode), $length);
        }
        $this->countryCode = strtoupper($countryCode);
    }

    /**
     * @return string
     */
    public function getCountryCode()
    {
        return $this->countryCode;
    }

    /**
     * @param string $locality
     * @throws BpostInvalidLengthException
     */
    public function setLocality($locality)

    {
        $length = 40;
        if (mb_strlen($locality) > $length) {
            throw new BpostInvalidLengthException('locality', mb_strlen($locality), $length);
        }
        $this->locality = $locality;
    }

    /**
     * @return string
     */
    public function getLocality()
    {
        return $this->locality;
    }

    /**
     * @param string $number
     * @throws BpostInvalidLengthException
     */
    public function setNumber($number)

    {
        $length = 8;
        if (mb_strlen($number) > $length) {
            throw new BpostInvalidLengthException('number', mb_strlen($number), $length);
        }
        $this->number = $number;
    }

    /**
     * @return string
     */
    public function getNumber()
    {
        return $this->number;
    }

    /**
     * @param string $postalCode
     * @throws BpostInvalidLengthException
     */
    public function setPostalCode($postalCode)

    {
        $length = 40;
        if (mb_strlen($postalCode) > $length) {
            throw new BpostInvalidLengthException('postalCode', mb_strlen($postalCode), $length);
        }
        $this->postalCode = $postalCode;
    }

    /**
     * @return string
     */
    public function getPostalCode()
    {
        return $this->postalCode;
    }

    /**
     * @param string $streetName
     * @throws BpostInvalidLengthException
     */
    public function setStreetName($streetName)

    {
        $length = 40;
        if (mb_strlen($streetName) > $length) {
            throw new BpostInvalidLengthException('streetName', mb_strlen($streetName), $length);
        }
        $this->streetName = $streetName;
    }

    /**
     * @return string
     */
    public function getStreetName()
    {
        return $this->streetName;
    }

    /**
     * @param string $streetName

     * @param string $number

     * @param string $box

     * @param string $postalCode

     * @param string $locality

     * @param string $countryCode

     *
     * @throws BpostInvalidLengthException
     */
    public function __construct(
        $streetName = null,
        $number = null,
        $box = null,
        $postalCode = null,
        $locality = null,
        $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);
        }
    }

    /**
     * Return the object as an array for usage in the XML
     *
     * @param  \DOMDocument $document
     * @param  string       $prefix
     * @return \DOMElement
     */
    public function toXML(\DOMDocument $document, $prefix = 'common')
    {
        $tagName = static::TAG_NAME;
        $address = $document->createElement($tagName);
        $document->appendChild($address);

        if ($this->getStreetName() !== null) {
            $tagName = 'streetName';
            if ($prefix !== null) {
                $tagName = $prefix . ':' . $tagName;
            }
            $address->appendChild(
                $document->createElement(
                    $tagName,
                    $this->getStreetName()
                )
            );
        }
        if ($this->getNumber() !== null) {
            $tagName = 'number';
            if ($prefix !== null) {
                $tagName = $prefix . ':' . $tagName;
            }
            $address->appendChild(
                $document->createElement(
                    $tagName,
                    $this->getNumber()
                )
            );
        }
        if ($this->getBox() !== null) {
            $tagName = 'box';
            if ($prefix !== null) {
                $tagName = $prefix . ':' . $tagName;
            }
            $address->appendChild(
                $document->createElement(
                    $tagName,
                    $this->getBox()
                )
            );
        }
        if ($this->getPostalCode() !== null) {
            $tagName = 'postalCode';
            if ($prefix !== null) {
                $tagName = $prefix . ':' . $tagName;
            }
            $address->appendChild(
                $document->createElement(
                    $tagName,
                    $this->getPostalCode()
                )
            );
        }
        if ($this->getLocality() !== null) {
            $tagName = 'locality';
            if ($prefix !== null) {
                $tagName = $prefix . ':' . $tagName;
            }
            $address->appendChild(
                $document->createElement(
                    $tagName,
                    $this->getLocality()
                )
            );
        }
        if ($this->getCountryCode() !== null) {
            $tagName = 'countryCode';
            if ($prefix !== null) {
                $tagName = $prefix . ':' . $tagName;
            }
            $address->appendChild(
                $document->createElement(
                    $tagName,
                    $this->getCountryCode()
                )
            );
        }

        return $address;
    }

    /**
     * @param  \SimpleXMLElement $xml
     * @return Address
     */
    public static function createFromXML(\SimpleXMLElement $xml)
    {
        $address = new Address();

        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;
    }
}


1			<?php
2			namespace Bpost\BpostApiClient\Bpost\Order;
3
4			use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidLengthException;
5
6			/**
7			* bPost Address class
8			*
9			* @author Tijs Verkoyen <[email protected]>
10			*/
11			class Address
12			{
13			const TAG_NAME = 'common:address';
14
15			/**
16			* @var string
17			*/
18			private $streetName;
19
20			/**
21			* @var string
22			*/
23			private $number;
24
25			/**
26			* @var string
27			*/
28			private $box;
29
30			/**
31			* @var string
32			*/
33			private $postalCode;
34
35			/**
36			* @var string
37			*/
38			private $locality;
39
40			/**
41			* @var string
42			*/
43			private $countryCode = 'BE';
44
45			/**
46			* @param string $box
47			* @throws BpostInvalidLengthException
48			*/
49	16	View Code Duplication	public function setBox($box)
			0 ignored issues – show Duplication introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50			{
51	16		$length = 8;
52	16		if (mb_strlen($box) > $length) {
53	3		throw new BpostInvalidLengthException('box', mb_strlen($box), $length);
54			}
55	13		$this->box = $box;
56	13		}
57
58			/**
59			* @return string
60			*/
61	15		public function getBox()
62			{
63	15		return $this->box;
64			}
65
66			/**
67			* @param string $countryCode
68			* @throws BpostInvalidLengthException
69			*/
70	21	View Code Duplication	public function setCountryCode($countryCode)
			0 ignored issues – show Duplication introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
71			{
72	21		$length = 2;
73	21		if (mb_strlen($countryCode) > $length) {
74	3		throw new BpostInvalidLengthException('countryCode', mb_strlen($countryCode), $length);
75			}
76	18		$this->countryCode = strtoupper($countryCode);
77	18		}
78
79			/**
80			* @return string
81			*/
82	15		public function getCountryCode()
83			{
84	15		return $this->countryCode;
85			}
86
87			/**
88			* @param string $locality
89			* @throws BpostInvalidLengthException
90			*/
91	21	View Code Duplication	public function setLocality($locality)
			0 ignored issues – show Duplication introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
92			{
93	21		$length = 40;
94	21		if (mb_strlen($locality) > $length) {
95	3		throw new BpostInvalidLengthException('locality', mb_strlen($locality), $length);
96			}
97	18		$this->locality = $locality;
98	18		}
99
100			/**
101			* @return string
102			*/
103	15		public function getLocality()
104			{
105	15		return $this->locality;
106			}
107
108			/**
109			* @param string $number
110			* @throws BpostInvalidLengthException
111			*/
112	21	View Code Duplication	public function setNumber($number)
			0 ignored issues – show Duplication introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
113			{
114	21		$length = 8;
115	21		if (mb_strlen($number) > $length) {
116	3		throw new BpostInvalidLengthException('number', mb_strlen($number), $length);
117			}
118	18		$this->number = $number;
119	18		}
120
121			/**
122			* @return string
123			*/
124	15		public function getNumber()
125			{
126	15		return $this->number;
127			}
128
129			/**
130			* @param string $postalCode
131			* @throws BpostInvalidLengthException
132			*/
133	21	View Code Duplication	public function setPostalCode($postalCode)
			0 ignored issues – show Duplication introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
134			{
135	21		$length = 40;
136	21		if (mb_strlen($postalCode) > $length) {
137	3		throw new BpostInvalidLengthException('postalCode', mb_strlen($postalCode), $length);
138			}
139	18		$this->postalCode = $postalCode;
140	18		}
141
142			/**
143			* @return string
144			*/
145	15		public function getPostalCode()
146			{
147	15		return $this->postalCode;
148			}
149
150			/**
151			* @param string $streetName
152			* @throws BpostInvalidLengthException
153			*/
154	21	View Code Duplication	public function setStreetName($streetName)
			0 ignored issues – show Duplication introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
155			{
156	21		$length = 40;
157	21		if (mb_strlen($streetName) > $length) {
158	3		throw new BpostInvalidLengthException('streetName', mb_strlen($streetName), $length);
159			}
160	18		$this->streetName = $streetName;
161	18		}
162
163			/**
164			* @return string
165			*/
166	16		public function getStreetName()
167			{
168	16		return $this->streetName;
169			}
170
171			/**
172			* @param string $streetName
			0 ignored issues – show Documentation introduced 2016-03-24 12:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$streetName` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
173			* @param string $number
			0 ignored issues – show Documentation introduced 2016-03-24 12:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$number` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
174			* @param string $box
			0 ignored issues – show Documentation introduced 2016-03-24 12:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$box` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
175			* @param string $postalCode
			0 ignored issues – show Documentation introduced 2016-03-24 12:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$postalCode` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
176			* @param string $locality
			0 ignored issues – show Documentation introduced 2016-03-24 12:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$locality` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
177			* @param string $countryCode
			0 ignored issues – show Documentation introduced 2016-03-24 12:08 UTC by Report Bug Copy Issue Report Should the type for parameter `$countryCode` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
178			*
179			* @throws BpostInvalidLengthException
180			*/
181	21		public function __construct(
182			$streetName = null,
183			$number = null,
184			$box = null,
185			$postalCode = null,
186			$locality = null,
187			$countryCode = null
188			) {
189	21		if ($streetName != null) {
			0 ignored issues – show Bug introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$streetName` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
190	11		$this->setStreetName($streetName);
191	11		}
192	21		if ($number != null) {
			0 ignored issues – show Bug introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$number` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
193	11		$this->setNumber($number);
194	11		}
195	21		if ($box != null) {
			0 ignored issues – show Bug introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$box` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
196	10		$this->setBox($box);
197	10		}
198	21		if ($postalCode != null) {
			0 ignored issues – show Bug introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$postalCode` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
199	11		$this->setPostalCode($postalCode);
200	11		}
201	21		if ($locality != null) {
			0 ignored issues – show Bug introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$locality` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
202	11		$this->setLocality($locality);
203	11		}
204	21		if ($countryCode != null) {
			0 ignored issues – show Bug introduced 2016-03-24 10:55 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$countryCode` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
205	11		$this->setCountryCode($countryCode);
206	11		}
207	21		}
208
209			/**
210			* Return the object as an array for usage in the XML
211			*
212			* @param \DOMDocument $document
213			* @param string $prefix
214			* @return \DOMElement
215			*/
216	14		public function toXML(\DOMDocument $document, $prefix = 'common')
217			{
218	14		$tagName = static::TAG_NAME;
219	14		$address = $document->createElement($tagName);
220	14		$document->appendChild($address);
221
222	14		if ($this->getStreetName() !== null) {
223	14		$tagName = 'streetName';
224	14		if ($prefix !== null) {
225	11		$tagName = $prefix . ':' . $tagName;
226	11		}
227	14		$address->appendChild(
228	14		$document->createElement(
229	14		$tagName,
230	14		$this->getStreetName()
231	14		)
232	14		);
233	14		}
234	14		if ($this->getNumber() !== null) {
235	14		$tagName = 'number';
236	14		if ($prefix !== null) {
237	11		$tagName = $prefix . ':' . $tagName;
238	11		}
239	14		$address->appendChild(
240	14		$document->createElement(
241	14		$tagName,
242	14		$this->getNumber()
243	14		)
244	14		);
245	14		}
246	14		if ($this->getBox() !== null) {
247	11		$tagName = 'box';
248	11		if ($prefix !== null) {
249	8		$tagName = $prefix . ':' . $tagName;
250	8		}
251	11		$address->appendChild(
252	11		$document->createElement(
253	11		$tagName,
254	11		$this->getBox()
255	11		)
256	11		);
257	11		}
258	14		if ($this->getPostalCode() !== null) {
259	14		$tagName = 'postalCode';
260	14		if ($prefix !== null) {
261	11		$tagName = $prefix . ':' . $tagName;
262	11		}
263	14		$address->appendChild(
264	14		$document->createElement(
265	14		$tagName,
266	14		$this->getPostalCode()
267	14		)
268	14		);
269	14		}
270	14		if ($this->getLocality() !== null) {
271	14		$tagName = 'locality';
272	14		if ($prefix !== null) {
273	11		$tagName = $prefix . ':' . $tagName;
274	11		}
275	14		$address->appendChild(
276	14		$document->createElement(
277	14		$tagName,
278	14		$this->getLocality()
279	14		)
280	14		);
281	14		}
282	14		if ($this->getCountryCode() !== null) {
283	14		$tagName = 'countryCode';
284	14		if ($prefix !== null) {
285	11		$tagName = $prefix . ':' . $tagName;
286	11		}
287	14		$address->appendChild(
288	14		$document->createElement(
289	14		$tagName,
290	14		$this->getCountryCode()
291	14		)
292	14		);
293	14		}
294
295	14		return $address;
296			}
297
298			/**
299			* @param \SimpleXMLElement $xml
300			* @return Address
301			*/
302	4		public static function createFromXML(\SimpleXMLElement $xml)
303			{
304	4		$address = new Address();
305
306	4		if (isset($xml->streetName) && $xml->streetName != '') {
307	4		$address->setStreetName((string) $xml->streetName);
308	4		}
309	4		if (isset($xml->number) && $xml->number != '') {
310	4		$address->setNumber((string) $xml->number);
311	4		}
312	4		if (isset($xml->box) && $xml->box != '') {
313	2		$address->setBox((string) $xml->box);
314	2		}
315	4		if (isset($xml->postalCode) && $xml->postalCode != '') {
316	4		$address->setPostalCode((string) $xml->postalCode);
317	4		}
318	4		if (isset($xml->locality) && $xml->locality != '') {
319	4		$address->setLocality((string) $xml->locality);
320	4		}
321	4		if (isset($xml->countryCode) && $xml->countryCode != '') {
322	4		$address->setCountryCode((string) $xml->countryCode);
323	4		}
324
325	4		return $address;
326			}
327			}
328

Antidot-be / bpost-api-library

Address B last analyzed 2016-08-25 18:47 UTC