PaymentRequest::__construct() - Code Metrics - GloBee-Official/payment-api-php - Measure and Improve Code Quality continuously with Scrutinizer

PaymentRequest::__construct() A
last analyzed 2020-04-14 12:05 UTC

↳ Parent: PaymentRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

namespace GloBee\PaymentApi\Models;

use GloBee\PaymentApi\Exceptions\Validation\ValidationException;

class PaymentRequest extends Model
{
    protected $total;

    protected $currency;

    protected $customPaymentId;

    protected $callbackData;

    protected $customerName;

    protected $customerEmail;

    protected $successUrl;

    protected $cancelUrl;

    protected $ipnUrl;

    protected $notificationEmail;

    protected $confirmationSpeed = 'medium';

    protected $id;

    protected $status;

    protected $redirectUrl;

    protected $expiresAt;

    protected $createdAt;


    public function __construct($customerEmail, $total, $currency = 'USD', $customerName = null)

    {
        $this->setTotal($total);
        $this->setCurrency($currency);
        $this->setCustomer($customerEmail, $customerName);
    }

    protected function setTotal($total)

    {
        Validator::validateNumberAboveMinimum('total', $total, 0);
        $this->total = $total;

        return $this;
    }

    protected function setCurrency($currency)

    {
        Validator::validateStringLength('currency', $currency, 3);
        $this->currency = strtoupper($currency);

        return $this;
    }

    protected function setCustomer($customerEmail, $customerName = null)

    {
        Validator::validateEmail('customer.email', $customerEmail);
        $this->customerEmail = $customerEmail;
        $this->customerName = $customerName;

        return $this;
    }

    public function setSuccessUrl($successUrl)

    {
        if ($successUrl !== null) {
            Validator::validateUrl('success_url', $successUrl);
        }
        $this->successUrl = $successUrl;

        return $this;
    }

    public function setCancelUrl($cancelUrl)

    {
        if ($cancelUrl !== null) {
            Validator::validateUrl('cancel_url', $cancelUrl);
        }
        $this->cancelUrl = $cancelUrl;

        return $this;
    }

    public function setCallbackData($callbackData)

    {
        $callbackDataString = $callbackData;
        if (!is_string($callbackData)) {
            $callbackDataString = json_encode($callbackData);
        }
        if (strlen($callbackDataString) > 150) {
            throw new ValidationException([], 'Callback Data must be less than 150 characters long.');
        }
        $this->callbackData = $callbackData;

        return $this;
    }

    public function setIpnUrl($ipnUrl)

    {
        if ($ipnUrl !== null) {
            Validator::validateUrl('ipn_url', $ipnUrl);
        }
        $this->ipnUrl = $ipnUrl;

        return $this;
    }

    public function setCustomPaymentId($customPaymentId)

    {
        $this->customPaymentId = $customPaymentId;

        return $this;
    }

    public function setNotificationEmail($notificationEmail)

    {
        if ($notificationEmail !== null) {
            Validator::validateEmail('notification_email', $notificationEmail);
        }
        $this->notificationEmail = $notificationEmail;

        return $this;
    }

    public function setLowRiskConfirmation()

    {
        $this->confirmationSpeed = 'low';

        return $this;
    }

    public function setBalancedConfirmation()

    {
        $this->confirmationSpeed = 'medium';

        return $this;
    }

    public function setQuickConfirmation()

    {
        $this->confirmationSpeed = 'high';

        return $this;
    }

    public function setConfirmationSpeed($confirmationSpeed)

    {
        Validator::validateOptions('confirmation_speed', $confirmationSpeed, ['low', 'medium', 'high']);
        $this->confirmationSpeed = $confirmationSpeed;

        return $this;
    }

    public static function fromResponse(array $data)

    {
        $self = new self($data['customer']['email'], $data['total']);

        $callbackData = json_decode($data['callback_data'], true);
        if (json_last_error() !== JSON_ERROR_NONE) {
            $callbackData = $data['callback_data'];
        }
        $self->id = $data['id'];
        $self->status = $data['status'];
        $self->currency = $data['currency'];
        $self->customPaymentId = $data['custom_payment_id'];
        $self->callbackData = $callbackData;
        $self->customerName = $data['customer']['name'];
        $self->redirectUrl = $data['redirect_url'];
        $self->successUrl = $data['success_url'];
        $self->cancelUrl = $data['cancel_url'];
        $self->ipnUrl = $data['ipn_url'];
        $self->notificationEmail = $data['notification_email'];
        $self->confirmationSpeed = $data['confirmation_speed'];
        $self->expiresAt = $data['expires_at'];
        $self->createdAt = $data['created_at'];

        return $self;
    }

    public function toArray()

    {
        $callbackData = $this->callbackData;
        if (is_array($callbackData)) {
            $callbackData = json_encode($callbackData);
        }

        return [
            'id' => $this->id,
            'status' => $this->status,
            'total' => $this->total,
            'currency' => $this->currency,
            'custom_payment_id' => $this->customPaymentId,
            'callback_data' => $callbackData,
            'customer' => [
                'name' => $this->customerName,
                'email' => $this->customerEmail,
            ],
            'redirect_url' => $this->redirectUrl,
            'success_url' => $this->successUrl,
            'cancel_url' => $this->cancelUrl,
            'ipn_url' => $this->ipnUrl,
            'notification_email' => $this->notificationEmail,
            'confirmation_speed' => $this->confirmationSpeed,
            'expires_at' => $this->expiresAt,
            'created_at' => $this->createdAt,
        ];
    }

    // The below methods are deprecated ----------------------------------------------------------------------------- //

    /**

     * @deprecated
     */

    public function withSuccessUrl($successUrl)
    {
        return $this->setSuccessUrl($successUrl);
    }

    /**

     * @deprecated
     */

    public function withCancelUrl($cancelUrl)
    {
        return $this->setCancelUrl($cancelUrl);
    }

    /**

     * @deprecated
     */

    public function withCallbackData($callbackData)
    {
        return $this->setCallbackData($callbackData);
    }

    /**

     * @deprecated
     */

    public function withIpnUrl($ipnUrl)
    {
        return $this->setIpnUrl($ipnUrl);
    }

    /**

     * @deprecated
     */

    public function withCustomPaymentId($customPaymentId)
    {
        return $this->setCustomPaymentId($customPaymentId);
    }

    /**

     * @deprecated
     */

    public function withNotificationEmail($notificationEmail)
    {
        return $this->setNotificationEmail($notificationEmail);
    }

    /**
     * @deprecated
     */

    public function lowRiskConfirmation()
    {
        return $this->setLowRiskConfirmation();
    }

    /**
     * @deprecated
     */

    public function balancedConfirmation()
    {
        return $this->setBalancedConfirmation();
    }

    /**
     * @deprecated
     */

    public function quickConfirmation()
    {
        return $this->setQuickConfirmation();
    }

    /**

     * @deprecated
     */

    public function confirmationSpeed($confirmationSpeed)
    {
        return $this->setConfirmationSpeed($confirmationSpeed);
    }
}


1		<?php
2
3		namespace GloBee\PaymentApi\Models;
4
5		use GloBee\PaymentApi\Exceptions\Validation\ValidationException;
6
7		class PaymentRequest extends Model
8		{
9		protected $total;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
10		protected $currency;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
11		protected $customPaymentId;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
12		protected $callbackData;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
13		protected $customerName;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
14		protected $customerEmail;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
15		protected $successUrl;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
16		protected $cancelUrl;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
17		protected $ipnUrl;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
18		protected $notificationEmail;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
19		protected $confirmationSpeed = 'medium';
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
20		protected $id;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
21		protected $status;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
22		protected $redirectUrl;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
23		protected $expiresAt;
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
24		protected $createdAt;
		0 ignored issues – show Coding Style Documentation introduced 2019-10-28 08:07 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
25
26	22	public function __construct($customerEmail, $total, $currency = 'USD', $customerName = null)
		0 ignored issues – show Coding Style Documentation introduced 2019-10-28 08:07 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
27		{
28	22	$this->setTotal($total);
29	20	$this->setCurrency($currency);
30	18	$this->setCustomer($customerEmail, $customerName);
31	17	}
32
33	22	protected function setTotal($total)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
34		{
35	22	Validator::validateNumberAboveMinimum('total', $total, 0);
36	20	$this->total = $total;
37
38	20	return $this;
39		}
40
41	20	protected function setCurrency($currency)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
42		{
43	20	Validator::validateStringLength('currency', $currency, 3);
44	18	$this->currency = strtoupper($currency);
45
46	18	return $this;
47		}
48
49	18	protected function setCustomer($customerEmail, $customerName = null)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
50		{
51	18	Validator::validateEmail('customer.email', $customerEmail);
52	17	$this->customerEmail = $customerEmail;
53	17	$this->customerName = $customerName;
54
55	17	return $this;
56		}
57
58	3	public function setSuccessUrl($successUrl)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-09 13:38 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
59		{
60	3	if ($successUrl !== null) {
61	3	Validator::validateUrl('success_url', $successUrl);
62		}
63	2	$this->successUrl = $successUrl;
64
65	2	return $this;
66		}
67
68	3	public function setCancelUrl($cancelUrl)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-09 13:38 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
69		{
70	3	if ($cancelUrl !== null) {
71	3	Validator::validateUrl('cancel_url', $cancelUrl);
72		}
73	2	$this->cancelUrl = $cancelUrl;
74
75	2	return $this;
76		}
77
78	3	public function setCallbackData($callbackData)
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
79		{
80	3	$callbackDataString = $callbackData;
81	3	if (!is_string($callbackData)) {
82	1	$callbackDataString = json_encode($callbackData);
83		}
84	3	if (strlen($callbackDataString) > 150) {
85		throw new ValidationException([], 'Callback Data must be less than 150 characters long.');
86		}
87	3	$this->callbackData = $callbackData;
88
89	3	return $this;
90		}
91
92	3	public function setIpnUrl($ipnUrl)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-09 13:38 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
93		{
94	3	if ($ipnUrl !== null) {
95	3	Validator::validateUrl('ipn_url', $ipnUrl);
96		}
97	2	$this->ipnUrl = $ipnUrl;
98
99	2	return $this;
100		}
101
102	2	public function setCustomPaymentId($customPaymentId)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
103		{
104	2	$this->customPaymentId = $customPaymentId;
105
106	2	return $this;
107		}
108
109	3	public function setNotificationEmail($notificationEmail)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
110		{
111	3	if ($notificationEmail !== null) {
112	3	Validator::validateEmail('notification_email', $notificationEmail);
113		}
114	2	$this->notificationEmail = $notificationEmail;
115
116	2	return $this;
117		}
118
119	1	public function setLowRiskConfirmation()
		0 ignored issues – show Coding Style Documentation introduced 2020-04-09 13:38 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
120		{
121	1	$this->confirmationSpeed = 'low';
122
123	1	return $this;
124		}
125
126		public function setBalancedConfirmation()
		0 ignored issues – show Coding Style Documentation introduced 2020-04-09 13:38 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
127		{
128		$this->confirmationSpeed = 'medium';
129
130		return $this;
131		}
132
133	1	public function setQuickConfirmation()
		0 ignored issues – show Coding Style Documentation introduced 2020-04-09 13:38 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
134		{
135	1	$this->confirmationSpeed = 'high';
136
137	1	return $this;
138		}
139
140	1	public function setConfirmationSpeed($confirmationSpeed)
		0 ignored issues – show Coding Style Documentation introduced 2018-12-28 12:56 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
141		{
142	1	Validator::validateOptions('confirmation_speed', $confirmationSpeed, ['low', 'medium', 'high']);
143		$this->confirmationSpeed = $confirmationSpeed;
144
145		return $this;
146		}
147
148	6	public static function fromResponse(array $data)
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
149		{
150	6	$self = new self($data['customer']['email'], $data['total']);
151
152	6	$callbackData = json_decode($data['callback_data'], true);
153	6	if (json_last_error() !== JSON_ERROR_NONE) {
154	5	$callbackData = $data['callback_data'];
155		}
156	6	$self->id = $data['id'];
157	6	$self->status = $data['status'];
158	6	$self->currency = $data['currency'];
159	6	$self->customPaymentId = $data['custom_payment_id'];
160	6	$self->callbackData = $callbackData;
161	6	$self->customerName = $data['customer']['name'];
162	6	$self->redirectUrl = $data['redirect_url'];
163	6	$self->successUrl = $data['success_url'];
164	6	$self->cancelUrl = $data['cancel_url'];
165	6	$self->ipnUrl = $data['ipn_url'];
166	6	$self->notificationEmail = $data['notification_email'];
167	6	$self->confirmationSpeed = $data['confirmation_speed'];
168	6	$self->expiresAt = $data['expires_at'];
169	6	$self->createdAt = $data['created_at'];
170
171	6	return $self;
172		}
173
174	3	public function toArray()
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
175		{
176	3	$callbackData = $this->callbackData;
177	3	if (is_array($callbackData)) {
178	1	$callbackData = json_encode($callbackData);
179		}
180
181		return [
182	3	'id' => $this->id,
183	3	'status' => $this->status,
184	3	'total' => $this->total,
185	3	'currency' => $this->currency,
186	3	'custom_payment_id' => $this->customPaymentId,
187	3	'callback_data' => $callbackData,
188		'customer' => [
189	3	'name' => $this->customerName,
190	3	'email' => $this->customerEmail,
191		],
192	3	'redirect_url' => $this->redirectUrl,
193	3	'success_url' => $this->successUrl,
194	3	'cancel_url' => $this->cancelUrl,
195	3	'ipn_url' => $this->ipnUrl,
196	3	'notification_email' => $this->notificationEmail,
197	3	'confirmation_speed' => $this->confirmationSpeed,
198	3	'expires_at' => $this->expiresAt,
199	3	'created_at' => $this->createdAt,
200		];
201		}
202
203		// The below methods are deprecated ----------------------------------------------------------------------------- //
204
205		/**
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Doc comment for parameter "$successUrl" missing Loading history...
206		* @deprecated
207		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
208	3	public function withSuccessUrl($successUrl)
209		{
210	3	return $this->setSuccessUrl($successUrl);
211		}
212
213		/**
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Doc comment for parameter "$cancelUrl" missing Loading history...
214		* @deprecated
215		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
216	3	public function withCancelUrl($cancelUrl)
217		{
218	3	return $this->setCancelUrl($cancelUrl);
219		}
220
221		/**
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Doc comment for parameter "$callbackData" missing Loading history...
222		* @deprecated
223		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
224	3	public function withCallbackData($callbackData)
225		{
226	3	return $this->setCallbackData($callbackData);
227		}
228
229		/**
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Doc comment for parameter "$ipnUrl" missing Loading history...
230		* @deprecated
231		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
232	3	public function withIpnUrl($ipnUrl)
233		{
234	3	return $this->setIpnUrl($ipnUrl);
235		}
236
237		/**
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Doc comment for parameter "$customPaymentId" missing Loading history...
238		* @deprecated
239		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
240	2	public function withCustomPaymentId($customPaymentId)
241		{
242	2	return $this->setCustomPaymentId($customPaymentId);
243		}
244
245		/**
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Doc comment for parameter "$notificationEmail" missing Loading history...
246		* @deprecated
247		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
248	3	public function withNotificationEmail($notificationEmail)
249		{
250	3	return $this->setNotificationEmail($notificationEmail);
251		}
252
253		/**
254		* @deprecated
255		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
256	1	public function lowRiskConfirmation()
257		{
258	1	return $this->setLowRiskConfirmation();
259		}
260
261		/**
262		* @deprecated
263		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
264		public function balancedConfirmation()
265		{
266		return $this->setBalancedConfirmation();
267		}
268
269		/**
270		* @deprecated
271		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
272	1	public function quickConfirmation()
273		{
274	1	return $this->setQuickConfirmation();
275		}
276
277		/**
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Doc comment for parameter "$confirmationSpeed" missing Loading history...
278		* @deprecated
279		*/
		0 ignored issues – show Coding Style Documentation introduced 2020-04-08 14:06 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
280	1	public function confirmationSpeed($confirmationSpeed)
281		{
282	1	return $this->setConfirmationSpeed($confirmationSpeed);
283		}
284		}
285

GloBee-Official / payment-api-php

PaymentRequest::__construct() A last analyzed 2020-04-14 12:05 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

PaymentRequest::__construct() A
last analyzed 2020-04-14 12:05 UTC