BankAccount::__construct() - Code Metrics - Inspection of "Drop PHP 5.3 support and prepare for first product..." - gregoriohc/omnipay-spreedly - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (eebe0d)

by Gregorio

created 2018-03-06 15:43 UTC

BankAccount::__construct() A

↳ Parent: BankAccount

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php
/**
 * Bank Account class
 */

namespace Omnipay\Spreedly;

use Omnipay\Common\Helper;
use Omnipay\Spreedly\Concerns\HasOwnerData;
use Omnipay\Spreedly\Exception\InvalidPaymentMethodException;
use Symfony\Component\HttpFoundation\ParameterBag;

/**
 * Bank Account class
 *
 * This class defines and abstracts all of the bank account types used
 * throughout the Omnipay Spreedly system.
 *
 * Example:
 *
 * <code>
 *   // Define bank account parameters, which should look like this
 *   $parameters = array(
 *       'firstName' => 'Bobby',
 *       'lastName' => 'Tables',
 *       'number' => '9876543210',
 *       'routingNumber' => '021000021',
 *       'type' => 'checking',
 *       'holderType' => 'personal',
 *   );
 *
 *   // Create a bank account object
 *   $bankAccount = new BankAcount($parameters);
 * </code>
 *
 * The full list of bank account attributes that may be set via the parameter to
 * *new* is as follows:
 *
 * * firstName
 * * lastName
 * * number
 * * routingNumber
 * * type
 * * holderType
 *
 * If any unknown parameters are passed in, they will be ignored.  No error is thrown.
 */
class BankAccount
{
    use HasOwnerData;

    const TYPE_CHECKING = 'checking';

    const HOLDER_TYPE_PERSONAL = 'personal';

    /**
     * Internal storage of all of the bank account parameters.
     *
     * @var \Symfony\Component\HttpFoundation\ParameterBag
     */
    protected $parameters;

    /**
     * Create a new BankAccount object using the specified parameters
     *
     * @param array $parameters An array of parameters to set on the new object
     */
    public function __construct($parameters = null)
    {
        $this->initialize($parameters);
    }

    /**
     * Initialize the object with parameters.
     *
     * If any unknown parameters passed, they will be ignored.
     *
     * @param array $parameters An associative array of parameters
     * @return BankAccount provides a fluent interface.
     */
    public function initialize(array $parameters = null)
    {
        $this->parameters = new ParameterBag;

        Helper::initialize($this, $parameters);


        return $this;
    }

    /**
     * Get all parameters.
     *
     * @return array An associative array of parameters.
     */
    public function getParameters()
    {
        return $this->parameters->all();
    }

    /**
     * Get one parameter.
     *
     * @param string $key
     * @return mixed A single parameter value.
     */
    protected function getParameter($key)
    {
        return $this->parameters->get($key);
    }

    /**
     * Set one parameter.
     *
     * @param string $key Parameter key
     * @param mixed $value Parameter value
     * @return BankAccount provides a fluent interface.
     */
    protected function setParameter($key, $value)
    {
        $this->parameters->set($key, $value);

        return $this;
    }

    /**
     * Validate this bank account. If the bank account is invalid, InvalidBankAccountException is thrown.
     *
     * This method is called internally by gateways to avoid wasting time with an API call
     * when the bank account is clearly invalid.
     *
     * Generally if you want to validate the bank account yourself with custom error
     * messages, you should use your framework's validation library, not this method.
     *
     * @throws InvalidPaymentMethodException
     * @return void
     */
    public function validate()
    {
        $requiredParameters = array(
            'first_name' => 'bank account first name',
            'last_name' => 'bank account last name',
            'number' => 'bank account number',
            'routing_number' => 'bank account routing number',
        );

        foreach ($requiredParameters as $key => $val) {
            if (!$this->getParameter($key)) {
                throw new InvalidPaymentMethodException("The $val is required");
            }
        }
    }

    /**
     * Get Bank Account Number.
     *
     * @return string
     */
    public function getNumber()
    {
        return $this->getParameter('number');
    }

    /**
     * Set Bank Account Number
     *
     * Non-numeric characters are stripped out of the bank account number, so
     * it's safe to pass in strings such as "4444-3333 2222 1111" etc.
     *
     * @param string $value Parameter value
     * @return BankAccount provides a fluent interface.
     */
    public function setNumber($value)
    {
        // strip non-numeric characters
        return $this->setParameter('number', preg_replace('/\D/', '', $value));
    }

    /**
     * Get Bank Account Routing Number.
     *
     * @return string
     */
    public function getRoutingNumber()
    {
        return $this->getParameter('routing_number');
    }

    /**
     * Set Bank Account Routing Number
     *
     * Non-numeric characters are stripped out of the bank account number, so
     * it's safe to pass in strings such as "4444-3333 2222 1111" etc.
     *
     * @param string $value Parameter value
     * @return BankAccount provides a fluent interface.
     */
    public function setRoutingNumber($value)
    {
        // strip non-numeric characters
        return $this->setParameter('routing_number', preg_replace('/\D/', '', $value));
    }

    /**
     * Get Bank Account Type.
     *
     * @return string
     */
    public function getType()
    {
        return $this->getParameter('type');
    }

    /**
     * Set Bank Account Type.
     *
     * @param string $value Parameter value
     * @return BankAccount provides a fluent interface.
     */
    public function setType($value)
    {
        return $this->setParameter('type', $value);
    }

    /**
     * Get Bank Account Holder Type.
     *
     * @return string
     */
    public function getHolderType()
    {
        return $this->getParameter('holder_type');
    }

    /**
     * Set Bank Account Holder Type.
     *
     * @param string $value Parameter value
     * @return BankAccount provides a fluent interface.
     */
    public function setHolderType($value)
    {
        return $this->setParameter('holder_type', $value);
    }
}

1		<?php
2		/**
3		* Bank Account class
4		*/
5
6		namespace Omnipay\Spreedly;
7
8		use Omnipay\Common\Helper;
9		use Omnipay\Spreedly\Concerns\HasOwnerData;
10		use Omnipay\Spreedly\Exception\InvalidPaymentMethodException;
11		use Symfony\Component\HttpFoundation\ParameterBag;
12
13		/**
14		* Bank Account class
15		*
16		* This class defines and abstracts all of the bank account types used
17		* throughout the Omnipay Spreedly system.
18		*
19		* Example:
20		*
21		* <code>
22		* // Define bank account parameters, which should look like this
23		* $parameters = array(
24		* 'firstName' => 'Bobby',
25		* 'lastName' => 'Tables',
26		* 'number' => '9876543210',
27		* 'routingNumber' => '021000021',
28		* 'type' => 'checking',
29		* 'holderType' => 'personal',
30		* );
31		*
32		* // Create a bank account object
33		* $bankAccount = new BankAcount($parameters);
34		* </code>
35		*
36		* The full list of bank account attributes that may be set via the parameter to
37		* new is as follows:
38		*
39		* * firstName
40		* * lastName
41		* * number
42		* * routingNumber
43		* * type
44		* * holderType
45		*
46		* If any unknown parameters are passed in, they will be ignored. No error is thrown.
47		*/
48		class BankAccount
49		{
50		use HasOwnerData;
51
52		const TYPE_CHECKING = 'checking';
53
54		const HOLDER_TYPE_PERSONAL = 'personal';
55
56		/**
57		* Internal storage of all of the bank account parameters.
58		*
59		* @var \Symfony\Component\HttpFoundation\ParameterBag
60		*/
61		protected $parameters;
62
63		/**
64		* Create a new BankAccount object using the specified parameters
65		*
66		* @param array $parameters An array of parameters to set on the new object
67		*/
68	6	public function __construct($parameters = null)
69		{
70	6	$this->initialize($parameters);
71	6	}
72
73		/**
74		* Initialize the object with parameters.
75		*
76		* If any unknown parameters passed, they will be ignored.
77		*
78		* @param array $parameters An associative array of parameters
79		* @return BankAccount provides a fluent interface.
80		*/
81	6	public function initialize(array $parameters = null)
82		{
83	6	$this->parameters = new ParameterBag;
84
85	6	Helper::initialize($this, $parameters);
		0 ignored issues – show Bug introduced 2018-03-06 12:58 UTC by Report Bug Copy Issue Report It seems like `$parameters` defined by parameter `$parameters` on line 81 can also be of type `null`; however, `Omnipay\Common\Helper::initialize()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
86
87	6	return $this;
88		}
89
90		/**
91		* Get all parameters.
92		*
93		* @return array An associative array of parameters.
94		*/
95		public function getParameters()
96		{
97		return $this->parameters->all();
98		}
99
100		/**
101		* Get one parameter.
102		*
103		* @param string $key
104		* @return mixed A single parameter value.
105		*/
106	6	protected function getParameter($key)
107		{
108	6	return $this->parameters->get($key);
109		}
110
111		/**
112		* Set one parameter.
113		*
114		* @param string $key Parameter key
115		* @param mixed $value Parameter value
116		* @return BankAccount provides a fluent interface.
117		*/
118	6	protected function setParameter($key, $value)
119		{
120	6	$this->parameters->set($key, $value);
121
122	6	return $this;
123		}
124
125		/**
126		* Validate this bank account. If the bank account is invalid, InvalidBankAccountException is thrown.
127		*
128		* This method is called internally by gateways to avoid wasting time with an API call
129		* when the bank account is clearly invalid.
130		*
131		* Generally if you want to validate the bank account yourself with custom error
132		* messages, you should use your framework's validation library, not this method.
133		*
134		* @throws InvalidPaymentMethodException
135		* @return void
136		*/
137	6	public function validate()
138		{
139		$requiredParameters = array(
140	6	'first_name' => 'bank account first name',
141	6	'last_name' => 'bank account last name',
142	6	'number' => 'bank account number',
143	6	'routing_number' => 'bank account routing number',
144	6	);
145
146	6	foreach ($requiredParameters as $key => $val) {
147	6	if (!$this->getParameter($key)) {
148		throw new InvalidPaymentMethodException("The $val is required");
149		}
150	6	}
151	6	}
152
153		/**
154		* Get Bank Account Number.
155		*
156		* @return string
157		*/
158	6	public function getNumber()
159		{
160	6	return $this->getParameter('number');
161		}
162
163		/**
164		* Set Bank Account Number
165		*
166		* Non-numeric characters are stripped out of the bank account number, so
167		* it's safe to pass in strings such as "4444-3333 2222 1111" etc.
168		*
169		* @param string $value Parameter value
170		* @return BankAccount provides a fluent interface.
171		*/
172	6	public function setNumber($value)
173		{
174		// strip non-numeric characters
175	6	return $this->setParameter('number', preg_replace('/\D/', '', $value));
176		}
177
178		/**
179		* Get Bank Account Routing Number.
180		*
181		* @return string
182		*/
183	6	public function getRoutingNumber()
184		{
185	6	return $this->getParameter('routing_number');
186		}
187
188		/**
189		* Set Bank Account Routing Number
190		*
191		* Non-numeric characters are stripped out of the bank account number, so
192		* it's safe to pass in strings such as "4444-3333 2222 1111" etc.
193		*
194		* @param string $value Parameter value
195		* @return BankAccount provides a fluent interface.
196		*/
197	6	public function setRoutingNumber($value)
198		{
199		// strip non-numeric characters
200	6	return $this->setParameter('routing_number', preg_replace('/\D/', '', $value));
201		}
202
203		/**
204		* Get Bank Account Type.
205		*
206		* @return string
207		*/
208	6	public function getType()
209		{
210	6	return $this->getParameter('type');
211		}
212
213		/**
214		* Set Bank Account Type.
215		*
216		* @param string $value Parameter value
217		* @return BankAccount provides a fluent interface.
218		*/
219	6	public function setType($value)
220		{
221	6	return $this->setParameter('type', $value);
222		}
223
224		/**
225		* Get Bank Account Holder Type.
226		*
227		* @return string
228		*/
229	6	public function getHolderType()
230		{
231	6	return $this->getParameter('holder_type');
232		}
233
234		/**
235		* Set Bank Account Holder Type.
236		*
237		* @param string $value Parameter value
238		* @return BankAccount provides a fluent interface.
239		*/
240	6	public function setHolderType($value)
241		{
242	6	return $this->setParameter('holder_type', $value);
243		}
244		}

gregoriohc / omnipay-spreedly

Branch — master (eebe0d)

BankAccount::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like