AbstractRequest::__construct() - Code Metrics - Inspection of "Direct Plus requests" - nexylan/paybox-direct - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#22)

by Sullivan

created 2016-04-24 16:21 UTC

AbstractRequest::__construct() A

↳ Parent: AbstractRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

namespace Nexy\PayboxDirect\Request;

use Nexy\PayboxDirect\Enum\Activity;

/**
 * @author Sullivan Senechal <[email protected]>
 */
abstract class AbstractRequest implements RequestInterface
{
    /**
     * @var int
     */
    private $activity = Activity::WEB_REQUEST;

    /**
     * @var \DateTime
     */
    private $date = null;

    /**
     * @var bool
     */
    private $showCountry = false;

    /**
     * @var string|null
     */
    private $subscriberRef = null;

    /**
     * @param null|string $subscriberRef
     */
    public function __construct($subscriberRef = null)
    {
        $this->subscriberRef = $subscriberRef;
    }

    /**
     * @param int $activity
     *
     * @return $this
     */
    final public function setActivity($activity)
    {
        $this->activity = $activity;

        return $this;
    }

    /**
     * @param \DateTime|null $date
     *
     * @return $this
     */
    final public function setDate(\DateTime $date = null)
    {
        $this->date = $date;

        return $this;
    }

    /**
     * @param bool $showCountry
     */
    final public function setShowCountry($showCountry)
    {
        $this->showCountry = $showCountry;
    }

    /**
     * @return null|string
     */
    final protected function getSubscriberRef()
    {
        return $this->subscriberRef;
    }

    /**
     * {@inheritdoc}
     */
    public function getParameters()
    {
        $parameters = [
            'ACTIVITE' => $this->activity,
            'DATEQ' => $this->date instanceof \DateTime ? $this->date->format('dmYHis') : null,
        ];

        if ($this->showCountry) {
            $parameters['PAYS'] = '';
        }

        if (method_exists($this, 'getTransactionNumber')) {
            $parameters['NUMTRANS'] = $this->getTransactionNumber();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
        if (method_exists($this, 'getCallNumber')) {
            $parameters['NUMAPPEL'] = $this->getCallNumber();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        // Direct Plus requests special case.
        if (null !== $this->getSubscriberRef()) {
            $parameters['REFABONNE'] = $this->getSubscriberRef();
        }

        return $parameters;
    }
}


1			<?php
2
3			namespace Nexy\PayboxDirect\Request;
4
5			use Nexy\PayboxDirect\Enum\Activity;
6
7			/**
8			* @author Sullivan Senechal <[email protected]>
9			*/
10			abstract class AbstractRequest implements RequestInterface
11			{
12			/**
13			* @var int
14			*/
15			private $activity = Activity::WEB_REQUEST;
16
17			/**
18			* @var \DateTime
19			*/
20			private $date = null;
21
22			/**
23			* @var bool
24			*/
25			private $showCountry = false;
26
27			/**
28			* @var string\|null
29			*/
30			private $subscriberRef = null;
31
32			/**
33			* @param null\|string $subscriberRef
34			*/
35			public function __construct($subscriberRef = null)
36			{
37			$this->subscriberRef = $subscriberRef;
38			}
39
40			/**
41			* @param int $activity
42			*
43			* @return $this
44			*/
45			final public function setActivity($activity)
46			{
47			$this->activity = $activity;
48
49			return $this;
50			}
51
52			/**
53			* @param \DateTime\|null $date
54			*
55			* @return $this
56			*/
57			final public function setDate(\DateTime $date = null)
58			{
59			$this->date = $date;
60
61			return $this;
62			}
63
64			/**
65			* @param bool $showCountry
66			*/
67			final public function setShowCountry($showCountry)
68			{
69			$this->showCountry = $showCountry;
70			}
71
72			/**
73			* @return null\|string
74			*/
75			final protected function getSubscriberRef()
76			{
77			return $this->subscriberRef;
78			}
79
80			/**
81			* {@inheritdoc}
82			*/
83			public function getParameters()
84			{
85			$parameters = [
86			'ACTIVITE' => $this->activity,
87			'DATEQ' => $this->date instanceof \DateTime ? $this->date->format('dmYHis') : null,
88			];
89
90			if ($this->showCountry) {
91			$parameters['PAYS'] = '';
92			}
93
94			if (method_exists($this, 'getTransactionNumber')) {
95			$parameters['NUMTRANS'] = $this->getTransactionNumber();
			0 ignored issues – show Bug introduced 2016-04-24 15:41 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Nexy\PayboxDirect\Request\AbstractRequest` as the method `getTransactionNumber()` does only exist in the following sub-classes of `Nexy\PayboxDirect\Request\AbstractRequest`: `Nexy\PayboxDirect\Reques...encedTransactionRequest`, `Nexy\PayboxDirect\Reques...beredTransactionRequest`, `Nexy\PayboxDirect\Request\CancelRequest`, `Nexy\PayboxDirect\Request\DebitRequest`, `Nexy\PayboxDirect\Request\InquiryRequest`, `Nexy\PayboxDirect\Request\RefundRequest`, `Nexy\PayboxDirect\Reques...ancelTransactionRequest`, `Nexy\PayboxDirect\Request\UpdateAmountRequest`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
96			}
97			if (method_exists($this, 'getCallNumber')) {
98			$parameters['NUMAPPEL'] = $this->getCallNumber();
			0 ignored issues – show Bug introduced 2016-04-24 15:41 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Nexy\PayboxDirect\Request\AbstractRequest` as the method `getCallNumber()` does only exist in the following sub-classes of `Nexy\PayboxDirect\Request\AbstractRequest`: `Nexy\PayboxDirect\Reques...encedTransactionRequest`, `Nexy\PayboxDirect\Reques...beredTransactionRequest`, `Nexy\PayboxDirect\Request\CancelRequest`, `Nexy\PayboxDirect\Request\DebitRequest`, `Nexy\PayboxDirect\Request\InquiryRequest`, `Nexy\PayboxDirect\Request\RefundRequest`, `Nexy\PayboxDirect\Reques...ancelTransactionRequest`, `Nexy\PayboxDirect\Request\UpdateAmountRequest`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
99			}
100
101			// Direct Plus requests special case.
102			if (null !== $this->getSubscriberRef()) {
103			$parameters['REFABONNE'] = $this->getSubscriberRef();
104			}
105
106			return $parameters;
107			}
108			}
109

nexylan / paybox-direct

Pull Request — master (#22)

AbstractRequest::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like