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

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

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	395
Duplicated Lines	17.47 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	48
lcom	1
cbo	3
dl	69
loc	395
rs	8.4864
c	0
b	0
f	0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	init()	12	12	3
B	toArray()	0	24	5
A	__toString()	0	12	2
B	get()	28	28	6
B	set()	29	29	6
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	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	setApplyFilters()	0	4	1
A	isFrontendApiCall()	0	12	3

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_Api_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_Api_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_Api
 * @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_Api
 * @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_Api_Request_Abstract
    implements Payone_Api_Request_Interface
{
    /**
     * @var int
     */
    protected $mid = NULL;

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

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

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

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

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

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

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

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

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

    /**
     * @var Payone_Protocol_Service_ApplyFilters
     */
    private $applyFilters = NULL;
    
    /**
     * @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;
            }

            if ($data instanceof Payone_Api_Request_Parameter_Interface) {
                /**
                 * @var Payone_Api_Request_Parameter_Interface $data
                 */
                $result = array_merge($result, $data->toArray());
            }
            elseif ($data instanceof Payone_Protocol_Service_ApplyFilters == false) {

                $result[$key] = $data;
            }
        }

        ksort($result);

        return $result;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        if($this->applyFilters) {
            $result = $this->applyFilters->apply($this->toArray());
        } else {
            $protocolFactory     = new Payone_Protocol_Factory();
            $defaultApplyFilters = $protocolFactory->buildServiceApplyFilters();
            $result = $defaultApplyFilters->apply($this->toArray());
        }

        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 (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->set($propertyName, $value);
            }
        }
        elseif (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;
    }

    /**
     * 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 Payone_Protocol_Service_ApplyFilters $applyFilters
     */
    public function setApplyFilters(Payone_Protocol_Service_ApplyFilters $applyFilters)
    {
        $this->applyFilters = $applyFilters;
    }
    
    public function isFrontendApiCall() 
    {
        if($this instanceof Payone_Api_Request_Authorization_Abstract) {
            $oOrder = Mage::getSingleton('checkout/session')->getQuote();
            $oPayment = $oOrder->getPayment();
            if($oPayment->getMethod() == 'payone_creditcard_iframe') {
                return true;
            }
        }

        return false;
    }
    
}


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_Api
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_Api
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
34
35		abstract class Payone_Api_Request_Abstract
36		implements Payone_Api_Request_Interface
37		{
38		/**
39		* @var int
40		*/
41		protected $mid = NULL;
42
43		/**
44		* @var int
45		*/
46		protected $portalid = NULL;
47
48		/**
49		* @var string
50		*/
51		protected $key = NULL;
52
53		/**
54		* @var string
55		*/
56		protected $mode = NULL;
57
58		/**
59		* @var string
60		*/
61		protected $request = NULL;
62
63		/**
64		* @var string
65		*/
66		protected $encoding = NULL;
67
68		/**
69		* name of the solution-partner (company)
70		*
71		* @var string
72		*/
73		protected $solution_name = NULL;
74
75		/**
76		* version of the solution-partner's app / extension / plugin / etc..
77		*
78		* @var string
79		*/
80		protected $solution_version = NULL;
81
82		/**
83		* system-name
84		*
85		* @var string
86		*/
87		protected $integrator_name = NULL;
88
89		/**
90		* system-version
91		*
92		* @var string
93		*/
94		protected $integrator_version = NULL;
95
96		/**
97		* @var Payone_Protocol_Service_ApplyFilters
98		*/
99		private $applyFilters = NULL;
100
101		/**
102		* @param array $data
103		*/
104		public function __construct(array $data = array())
105		{
106		if (count($data) > 0) {
107		$this->init($data);
108		}
109		}
110
111		/**
112		* @param array $data
113		*/
114	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...
115		{
116		foreach ($data as $key => $value)
117		{
118		$key = ucwords(str_replace('_', ' ', $key));
119		$method = 'set' . str_replace(' ', '', $key);
120
121		if (method_exists($this, $method)) {
122		$this->{$method}($value);
123		}
124		}
125		}
126
127		/**
128		* @return array
129		*/
130		public function toArray()
131		{
132		$result = array();
133		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_Api_Request_Abstract>` is not traversable. Loading history...
134		{
135		if ($data === null) {
136		continue;
137		}
138
139		if ($data instanceof Payone_Api_Request_Parameter_Interface) {
140		/**
141		* @var Payone_Api_Request_Parameter_Interface $data
142		*/
143		$result = array_merge($result, $data->toArray());
144		}
145		elseif ($data instanceof Payone_Protocol_Service_ApplyFilters == false) {
		0 ignored issues – show Coding Style Best Practice introduced 2016-07-12 11:33 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
146		$result[$key] = $data;
147		}
148		}
149
150		ksort($result);
151
152		return $result;
153		}
154
155		/**
156		* @return string
157		*/
158		public function __toString()
159		{
160		if($this->applyFilters) {
161		$result = $this->applyFilters->apply($this->toArray());
162		} else {
163		$protocolFactory = new Payone_Protocol_Factory();
164		$defaultApplyFilters = $protocolFactory->buildServiceApplyFilters();
165		$result = $defaultApplyFilters->apply($this->toArray());
166		}
167
168		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_Api_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...
169		}
170
171
172		/**
173		* @param $name
174		* @return null\|mixed
175		*/
176	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...
177		{
178		if (strpos($name, '/') !== false) {
179		$explodedName = explode('/', $name);
180		if (count($explodedName) != 2) {
181		return null;
182		}
183
184		$property = $explodedName[0];
185		$propertyName = $explodedName[1];
186		if (property_exists($this, $property)) {
187		$object = $this->$property;
188		/**
189		* @var $object Payone_Api_Request_Parameter_Interface
190		*/
191		if (!($object instanceof Payone_Api_Request_Parameter_Interface)) {
192		return null;
193		}
194
195		return $object->get($propertyName);
196		}
197		}
198		elseif (property_exists($this, $name)) {
199		return $this->$name;
200		}
201
202		return null;
203		}
204
205		/**
206		* @param string $name
207		* @param mixed $value
208		* @return boolean\|null
209		*/
210	View Code Duplication	public function set($name, $value)
		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...
211		{
212		if (strpos($name, '/') !== false) {
213		$explodedName = explode('/', $name);
214		if (count($explodedName) != 2) {
215		return null;
216		}
217
218		$property = $explodedName[0];
219		$propertyName = $explodedName[1];
220		if (property_exists($this, $property)) {
221		$object = $this->$property;
222		/**
223		* @var $object Payone_Api_Request_Parameter_Interface
224		*/
225		if (!($object instanceof Payone_Api_Request_Parameter_Interface)) {
226		return null;
227		}
228
229		return $object->set($propertyName, $value);
230		}
231		}
232		elseif (property_exists($this, $name)) {
233		$this->$name = $value;
234		return true;
235		}
236
237		return null;
238		}
239
240		/**
241		* @param string $encoding
242		*/
243		public function setEncoding($encoding)
244		{
245		$this->encoding = $encoding;
246		}
247
248		/**
249		* @return string
250		*/
251		public function getEncoding()
252		{
253		return $this->encoding;
254		}
255
256		/**
257		* @param string $key
258		*/
259		public function setKey($key)
260		{
261		$this->key = md5($key);
262		}
263
264		/**
265		* @return string
266		*/
267		public function getKey()
268		{
269		return $this->key;
270		}
271
272		/**
273		* @param int $mid
274		*/
275		public function setMid($mid)
276		{
277		$this->mid = $mid;
278		}
279
280		/**
281		* @return int
282		*/
283		public function getMid()
284		{
285		return $this->mid;
286		}
287
288		/**
289		* @param string $mode
290		*/
291		public function setMode($mode)
292		{
293		$this->mode = $mode;
294		}
295
296		/**
297		* @return string
298		*/
299		public function getMode()
300		{
301		return $this->mode;
302		}
303
304		/**
305		* @param int $portalid
306		*/
307		public function setPortalid($portalid)
308		{
309		$this->portalid = $portalid;
310		}
311
312		/**
313		* @return int
314		*/
315		public function getPortalid()
316		{
317		return $this->portalid;
318		}
319
320		/**
321		* @param string $request
322		*/
323		public function setRequest($request)
324		{
325		$this->request = $request;
326		}
327
328		/**
329		* @return string
330		*/
331		public function getRequest()
332		{
333		return $this->request;
334		}
335
336		/**
337		* set the system-Name
338		*
339		* @param string $integrator_name
340		*/
341		public function setIntegratorName($integrator_name)
342		{
343		$this->integrator_name = $integrator_name;
344		}
345
346		/**
347		* @return string
348		*/
349		public function getIntegratorName()
350		{
351		return $this->integrator_name;
352		}
353
354		/**
355		* set the system-version
356		*
357		* @param string $integrator_version
358		*/
359		public function setIntegratorVersion($integrator_version)
360		{
361		$this->integrator_version = $integrator_version;
362		}
363
364		/**
365		* @return string
366		*/
367		public function getIntegratorVersion()
368		{
369		return $this->integrator_version;
370		}
371
372		/**
373		* set the name of the solution-partner (company)
374		*
375		* @param string $solution_name
376		*/
377		public function setSolutionName($solution_name)
378		{
379		$this->solution_name = $solution_name;
380		}
381
382		/**
383		* @return string
384		*/
385		public function getSolutionName()
386		{
387		return $this->solution_name;
388		}
389
390		/**
391		* set the version of the solution-partner's app / extension / plugin / etc..
392		*
393		* @param string $solution_version
394		*/
395		public function setSolutionVersion($solution_version)
396		{
397		$this->solution_version = $solution_version;
398		}
399
400		/**
401		* @return string
402		*/
403		public function getSolutionVersion()
404		{
405		return $this->solution_version;
406		}
407
408		/**
409		* @param Payone_Protocol_Service_ApplyFilters $applyFilters
410		*/
411		public function setApplyFilters(Payone_Protocol_Service_ApplyFilters $applyFilters)
412		{
413		$this->applyFilters = $applyFilters;
414		}
415
416		public function isFrontendApiCall()
417		{
418		if($this instanceof Payone_Api_Request_Authorization_Abstract) {
419		$oOrder = Mage::getSingleton('checkout/session')->getQuote();
420		$oPayment = $oOrder->getPayment();
421		if($oPayment->getMethod() == 'payone_creditcard_iframe') {
422		return true;
423		}
424		}
425
426		return false;
427		}
428
429		}
430

fjbender / magento-1

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