Payone_ClientApi_Request_Abstract - Code Metrics - fjbender/magento-1 - Measure and Improve Code Quality continuously with Scrutinizer

Payone_ClientApi_Request_Abstract B
last analyzed 2017-04-13 08:22 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	399
Duplicated Lines	9.77 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	44
lcom	1
cbo	1
dl	39
loc	399
rs	8.3396
c	0
b	0
f	0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	init()	11	11	3
A	toArray()	0	15	3
A	__toString()	0	10	2
B	get()	28	28	6
A	set()	0	9	2
A	setEncoding()	0	4	1
A	getEncoding()	0	4	1
A	setKey()	0	4	1
A	getKey()	0	4	1
A	setMid()	0	4	1
A	getMid()	0	4	1
A	setMode()	0	4	1
A	getMode()	0	4	1
A	setPortalid()	0	4	1
A	getPortalid()	0	4	1
A	setRequest()	0	4	1
A	getRequest()	0	4	1
A	setResponsetype()	0	4	1
A	getResponseType()	0	4	1
A	setIntegratorName()	0	4	1
A	getIntegratorName()	0	4	1
A	setIntegratorVersion()	0	4	1
A	getIntegratorVersion()	0	4	1
A	setSolutionName()	0	4	1
A	getSolutionName()	0	4	1
A	setSolutionVersion()	0	4	1
A	getSolutionVersion()	0	4	1
A	setHash()	0	4	1
A	getHash()	0	4	1
A	setLanguage()	0	4	1
A	getLanguage()	0	4	1

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 Payone_ClientApi_Request_Abstract 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 Payone_ClientApi_Request_Abstract, and based on these observations, apply Extract Interface, too.

<?php
/**
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the GNU General Public License (GPL 3)
 * that is bundled with this package in the file LICENSE.txt
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade Payone to newer
 * versions in the future. If you wish to customize Payone for your
 * needs please refer to http://www.payone.de for more information.
 *
 * @category        Payone
 * @package         Payone_ClientApi
 * @subpackage      Request
 * @copyright       Copyright (c) 2012 <[email protected]> - www.noovias.com
 * @author          Matthias Walter <[email protected]>
 * @license         <http://www.gnu.org/licenses/> GNU General Public License (GPL 3)
 * @link            http://www.noovias.com
 */

/**
 *
 * @category        Payone
 * @package         Payone_ClientApi
 * @subpackage      Request
 * @copyright       Copyright (c) 2012 <[email protected]> - www.noovias.com
 * @license         <http://www.gnu.org/licenses/> GNU General Public License (GPL 3)
 * @link            http://www.noovias.com
 */
abstract class Payone_ClientApi_Request_Abstract implements Payone_ClientApi_Request_Interface
{
    /**
     * @var int
     */
    protected $mid = 0;

    /**
     * @var int
     */
    protected $portalid = 0;

    /**
     * @var string
     */
    protected $key = '';

    /**
     * @var string
     */
    protected $mode = '';

    /**
     * @var string
     */
    protected $request = '';

    /**
     * @var string
     */
    protected $responsetype;

    /**
     * @var string
     */
    protected $encoding = '';

    /**
     * name of the solution-partner (company)
     *
     * @var string
     */
    protected $solution_name = '';

    /**
     * version of the solution-partner's app / extension / plugin / etc..
     *
     * @var string
     */
    protected $solution_version = '';

    /**
     * system-name
     *
     * @var string
     */
    protected $integrator_name = '';

    /**
     * system-version
     *
     * @var string
     */
    protected $integrator_version = '';

    /**
     * ISO 639
     * @var string
     */
    protected $language = '';

    /**
     * @var string
     */
    protected $hash = '';

    /**
     * @param array $data
     */
    public function __construct(array $data = array())
    {
        if (count($data) > 0) {
            $this->init($data);
        }
    }

    /**
     * @param array $data
     */
    public function init(array $data = array())

    {
        foreach ($data as $key => $value) {
            $key = ucwords(str_replace('_', ' ', $key));
            $method = 'set' . str_replace(' ', '', $key);

            if (method_exists($this, $method)) {
                $this->{$method}($value);
            }
        }
    }

    /**
     * @return array
     */
    public function toArray()
    {
        $result = array();
        foreach ($this as $key => $data) {

            if ($data === null) {
                continue;
            }

            $result[$key] = $data;
        }

        ksort($result);

        return $result;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        $stringArray = array();
        foreach ($this->toArray() as $key => $value) {
            $stringArray[] = $key . '=' . $value;
        }

        $result = implode('|', $stringArray);
        return $result;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @param $name
     * @return null|mixed
     */
    public function get($name)

    {
        if (strpos($name, '/') !== false) {
            $explodedName = explode('/', $name);
            if (count($explodedName) != 2) {
                return null;
            }

            $property = $explodedName[0];
            $propertyName = $explodedName[1];
            if (property_exists($this, $property)) {
                $object = $this->$property;
                /**
                 * @var $object Payone_Api_Request_Parameter_Interface
                 */
                if (!($object instanceof Payone_Api_Request_Parameter_Interface)) {
                    return null;
                }

                return $object->get($propertyName);
            }
        }
        elseif (property_exists($this, $name)) {
            return $this->$name;
        }

        return null;
    }

    /**
     * @param string $name
     * @param mixed $value
     * @return boolean|null
     */
    public function set($name, $value)
    {
        if (property_exists($this, $name)) {
            $this->$name = $value;
            return true;
        }

        return null;
    }

    /**
     * @param string $encoding
     */
    public function setEncoding($encoding)
    {
        $this->encoding = $encoding;
    }

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

    /**
     * @param string $key
     */
    public function setKey($key)
    {
        $this->key = md5($key);
    }

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

    /**
     * @param int $mid
     */
    public function setMid($mid)
    {
        $this->mid = $mid;
    }

    /**
     * @return int
     */
    public function getMid()
    {
        return $this->mid;
    }

    /**
     * @param string $mode
     */
    public function setMode($mode)
    {
        $this->mode = $mode;
    }

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

    /**
     * @param int $portalid
     */
    public function setPortalid($portalid)
    {
        $this->portalid = $portalid;
    }

    /**
     * @return int
     */
    public function getPortalid()
    {
        return $this->portalid;
    }

    /**
     * @param string $request
     */
    public function setRequest($request)
    {
        $this->request = $request;
    }

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

    /**
     * @param string $responseType
     */
    public function setResponsetype($responseType)
    {
        $this->responsetype = $responseType;
    }

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

    /**
     * set the system-Name
     *
     * @param string $integrator_name
     */
    public function setIntegratorName($integrator_name)
    {
        $this->integrator_name = $integrator_name;
    }

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

    /**
     * set the system-version
     *
     * @param string $integrator_version
     */
    public function setIntegratorVersion($integrator_version)
    {
        $this->integrator_version = $integrator_version;
    }

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

    /**
     * set the name of the solution-partner (company)
     *
     * @param string $solution_name
     */
    public function setSolutionName($solution_name)
    {
        $this->solution_name = $solution_name;
    }

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

    /**
     * set the version of the solution-partner's app / extension / plugin / etc..
     *
     * @param string $solution_version
     */
    public function setSolutionVersion($solution_version)
    {
        $this->solution_version = $solution_version;
    }

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

    /**
     * @param string $hash
     */
    public function setHash($hash)
    {
        $this->hash = $hash;
    }

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

    /**
     * @param string $language
     */
    public function setLanguage($language)
    {
        $this->language = $language;
    }

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

}


1		<?php
2		/**
3		*
4		* NOTICE OF LICENSE
5		*
6		* This source file is subject to the GNU General Public License (GPL 3)
7		* that is bundled with this package in the file LICENSE.txt
8		*
9		* DISCLAIMER
10		*
11		* Do not edit or add to this file if you wish to upgrade Payone to newer
12		* versions in the future. If you wish to customize Payone for your
13		* needs please refer to http://www.payone.de for more information.
14		*
15		* @category Payone
16		* @package Payone_ClientApi
17		* @subpackage Request
18		* @copyright Copyright (c) 2012 <[email protected]> - www.noovias.com
19		* @author Matthias Walter <[email protected]>
20		* @license <http://www.gnu.org/licenses/> GNU General Public License (GPL 3)
21		* @link http://www.noovias.com
22		*/
23
24		/**
25		*
26		* @category Payone
27		* @package Payone_ClientApi
28		* @subpackage Request
29		* @copyright Copyright (c) 2012 <[email protected]> - www.noovias.com
30		* @license <http://www.gnu.org/licenses/> GNU General Public License (GPL 3)
31		* @link http://www.noovias.com
32		*/
33		abstract class Payone_ClientApi_Request_Abstract implements Payone_ClientApi_Request_Interface
34		{
35		/**
36		* @var int
37		*/
38		protected $mid = 0;
39
40		/**
41		* @var int
42		*/
43		protected $portalid = 0;
44
45		/**
46		* @var string
47		*/
48		protected $key = '';
49
50		/**
51		* @var string
52		*/
53		protected $mode = '';
54
55		/**
56		* @var string
57		*/
58		protected $request = '';
59
60		/**
61		* @var string
62		*/
63		protected $responsetype;
64
65		/**
66		* @var string
67		*/
68		protected $encoding = '';
69
70		/**
71		* name of the solution-partner (company)
72		*
73		* @var string
74		*/
75		protected $solution_name = '';
76
77		/**
78		* version of the solution-partner's app / extension / plugin / etc..
79		*
80		* @var string
81		*/
82		protected $solution_version = '';
83
84		/**
85		* system-name
86		*
87		* @var string
88		*/
89		protected $integrator_name = '';
90
91		/**
92		* system-version
93		*
94		* @var string
95		*/
96		protected $integrator_version = '';
97
98		/**
99		* ISO 639
100		* @var string
101		*/
102		protected $language = '';
103
104		/**
105		* @var string
106		*/
107		protected $hash = '';
108
109		/**
110		* @param array $data
111		*/
112		public function __construct(array $data = array())
113		{
114		if (count($data) > 0) {
115		$this->init($data);
116		}
117		}
118
119		/**
120		* @param array $data
121		*/
122	View Code Duplication	public function init(array $data = array())
		0 ignored issues – show Duplication introduced 2016-07-12 11:33 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...
123		{
124		foreach ($data as $key => $value) {
125		$key = ucwords(str_replace('_', ' ', $key));
126		$method = 'set' . str_replace(' ', '', $key);
127
128		if (method_exists($this, $method)) {
129		$this->{$method}($value);
130		}
131		}
132		}
133
134		/**
135		* @return array
136		*/
137		public function toArray()
138		{
139		$result = array();
140		foreach ($this as $key => $data) {
		0 ignored issues – show Bug introduced 2016-07-12 11:33 UTC by Report Bug Copy Issue Report The expression `$this` of type `this<Payone_ClientApi_Request_Abstract>` is not traversable. Loading history...
141		if ($data === null) {
142		continue;
143		}
144
145		$result[$key] = $data;
146		}
147
148		ksort($result);
149
150		return $result;
151		}
152
153		/**
154		* @return string
155		*/
156		public function __toString()
157		{
158		$stringArray = array();
159		foreach ($this->toArray() as $key => $value) {
160		$stringArray[] = $key . '=' . $value;
161		}
162
163		$result = implode('\|', $stringArray);
164		return $result;
		0 ignored issues – show Bug Best Practice introduced 2016-07-12 11:33 UTC by Report Bug Copy Issue Report The return type of `return $result;` (`string`) is incompatible with the return type declared by the interface `Payone_ClientApi_Request_Interface::__toString` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
165		}
166
167		/**
168		* @param $name
169		* @return null\|mixed
170		*/
171	View Code Duplication	public function get($name)
		0 ignored issues – show Duplication introduced 2016-07-12 11:33 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...
172		{
173		if (strpos($name, '/') !== false) {
174		$explodedName = explode('/', $name);
175		if (count($explodedName) != 2) {
176		return null;
177		}
178
179		$property = $explodedName[0];
180		$propertyName = $explodedName[1];
181		if (property_exists($this, $property)) {
182		$object = $this->$property;
183		/**
184		* @var $object Payone_Api_Request_Parameter_Interface
185		*/
186		if (!($object instanceof Payone_Api_Request_Parameter_Interface)) {
187		return null;
188		}
189
190		return $object->get($propertyName);
191		}
192		}
193		elseif (property_exists($this, $name)) {
194		return $this->$name;
195		}
196
197		return null;
198		}
199
200		/**
201		* @param string $name
202		* @param mixed $value
203		* @return boolean\|null
204		*/
205		public function set($name, $value)
206		{
207		if (property_exists($this, $name)) {
208		$this->$name = $value;
209		return true;
210		}
211
212		return null;
213		}
214
215		/**
216		* @param string $encoding
217		*/
218		public function setEncoding($encoding)
219		{
220		$this->encoding = $encoding;
221		}
222
223		/**
224		* @return string
225		*/
226		public function getEncoding()
227		{
228		return $this->encoding;
229		}
230
231		/**
232		* @param string $key
233		*/
234		public function setKey($key)
235		{
236		$this->key = md5($key);
237		}
238
239		/**
240		* @return string
241		*/
242		public function getKey()
243		{
244		return $this->key;
245		}
246
247		/**
248		* @param int $mid
249		*/
250		public function setMid($mid)
251		{
252		$this->mid = $mid;
253		}
254
255		/**
256		* @return int
257		*/
258		public function getMid()
259		{
260		return $this->mid;
261		}
262
263		/**
264		* @param string $mode
265		*/
266		public function setMode($mode)
267		{
268		$this->mode = $mode;
269		}
270
271		/**
272		* @return string
273		*/
274		public function getMode()
275		{
276		return $this->mode;
277		}
278
279		/**
280		* @param int $portalid
281		*/
282		public function setPortalid($portalid)
283		{
284		$this->portalid = $portalid;
285		}
286
287		/**
288		* @return int
289		*/
290		public function getPortalid()
291		{
292		return $this->portalid;
293		}
294
295		/**
296		* @param string $request
297		*/
298		public function setRequest($request)
299		{
300		$this->request = $request;
301		}
302
303		/**
304		* @return string
305		*/
306		public function getRequest()
307		{
308		return $this->request;
309		}
310
311		/**
312		* @param string $responseType
313		*/
314		public function setResponsetype($responseType)
315		{
316		$this->responsetype = $responseType;
317		}
318
319		/**
320		* @return string
321		*/
322		public function getResponseType()
323		{
324		return $this->responsetype;
325		}
326
327		/**
328		* set the system-Name
329		*
330		* @param string $integrator_name
331		*/
332		public function setIntegratorName($integrator_name)
333		{
334		$this->integrator_name = $integrator_name;
335		}
336
337		/**
338		* @return string
339		*/
340		public function getIntegratorName()
341		{
342		return $this->integrator_name;
343		}
344
345		/**
346		* set the system-version
347		*
348		* @param string $integrator_version
349		*/
350		public function setIntegratorVersion($integrator_version)
351		{
352		$this->integrator_version = $integrator_version;
353		}
354
355		/**
356		* @return string
357		*/
358		public function getIntegratorVersion()
359		{
360		return $this->integrator_version;
361		}
362
363		/**
364		* set the name of the solution-partner (company)
365		*
366		* @param string $solution_name
367		*/
368		public function setSolutionName($solution_name)
369		{
370		$this->solution_name = $solution_name;
371		}
372
373		/**
374		* @return string
375		*/
376		public function getSolutionName()
377		{
378		return $this->solution_name;
379		}
380
381		/**
382		* set the version of the solution-partner's app / extension / plugin / etc..
383		*
384		* @param string $solution_version
385		*/
386		public function setSolutionVersion($solution_version)
387		{
388		$this->solution_version = $solution_version;
389		}
390
391		/**
392		* @return string
393		*/
394		public function getSolutionVersion()
395		{
396		return $this->solution_version;
397		}
398
399		/**
400		* @param string $hash
401		*/
402		public function setHash($hash)
403		{
404		$this->hash = $hash;
405		}
406
407		/**
408		* @return string
409		*/
410		public function getHash()
411		{
412		return $this->hash;
413		}
414
415		/**
416		* @param string $language
417		*/
418		public function setLanguage($language)
419		{
420		$this->language = $language;
421		}
422
423		/**
424		* @return string
425		*/
426		public function getLanguage()
427		{
428		return $this->language;
429		}
430
431		}
432

fjbender / magento-1

Payone_ClientApi_Request_Abstract B last analyzed 2017-04-13 08:22 UTC