PaymentRequest::setIpnUrl() - Code Metrics - Inspection of "Allow callback data to be json encoded" - GloBee-Official/payment-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2)

by Bernhard

created 2018-04-23 15:17 UTC

PaymentRequest::setIpnUrl() A

↳ Parent: PaymentRequest

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

namespace GloBee\PaymentApi\Models;

/**
 * @property string $id
 * @property string $status
 * @property float $total
 * @property string $currency
 * @property string $customPaymentId
 * @property mixed $callbackData
 * @property string $customerName
 * @property string $customerEmail
 * @property string $redirectUrl
 * @property string $successUrl
 * @property string $cancelUrl
 * @property string $ipnUrl
 * @property string $notificationEmail
 * @property string $confirmationSpeed
 * @property string $expiresAt
 * @property string $createdAt
 */
class PaymentRequest extends Model
{
    use PropertyTrait;

    protected $total = 0.0;

    protected $currency = 'USD';

    protected $customPaymentId;

    protected $callbackData;

    protected $customerName;

    protected $customerEmail;

    protected $successUrl;

    protected $cancelUrl;

    protected $ipnUrl;

    protected $notificationEmail;

    protected $confirmationSpeed = 'medium';

    private $id;

    private $status;

    private $redirectUrl;

    private $expiresAt;

    private $createdAt;

    public static function fromResponse(array $data)
    {
        $self = new self();

        $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->total = $data['total'];
        $self->currency = $data['currency'];
        $self->customPaymentId = $data['custom_payment_id'];
        $self->callbackData = $callbackData;
        $self->customerName = $data['customer']['name'];
        $self->customerEmail = $data['customer']['email'];
        $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;
    }

    /**
     * @param float $total
     *
     * @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidArgumentException
     * @throws \GloBee\PaymentApi\Exceptions\Validation\BelowMinimumException
     */
    public function setTotal($total)
    {
        $this->validateNumberAboveMinimum('total', $total, 0);
        $this->total = $total;
    }

    /**
     * @param mixed $currency
     *
     * @throws \GloBee\PaymentApi\Exceptions\Validation\ValidationException
     * @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidArgumentException
     */
    public function setCurrency($currency)
    {
        $this->validateStringLength('currency', $currency, 3);
        $this->currency = strtoupper($currency);
    }

    /**
     * @param mixed $customerEmail
     *
     * @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidArgumentException
     * @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidEmailException
     */
    public function setCustomerEmail($customerEmail)
    {
        $this->validateEmail('customer.email', $customerEmail);
        $this->customerEmail = $customerEmail;
    }

    /**
     * @param mixed $successUrl
     *
     * @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidArgumentException
     * @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidUrlException
     */
    public function setSuccessUrl($successUrl)
    {
        if ($successUrl !== null) {
            $this->validateUrl('success_url', $successUrl);
        }
        $this->successUrl = $successUrl;
    }

    /**
     * @param mixed $cancelUrl
     */
    public function setCancelUrl($cancelUrl)
    {
        if ($cancelUrl !== null) {
            $this->validateUrl('cancel_url', $cancelUrl);
        }
        $this->cancelUrl = $cancelUrl;
    }

    /**
     * @param mixed $ipnUrl
     */
    public function setIpnUrl($ipnUrl)
    {
        if ($ipnUrl !== null) {
            $this->validateUrl('ipn_url', $ipnUrl);
        }
        $this->ipnUrl = $ipnUrl;
    }

    /**
     * @param mixed $notificationEmail
     */
    public function setNotificationEmail($notificationEmail)
    {
        if ($notificationEmail !== null) {
            $this->validateEmail('notification_email', $notificationEmail);
        }
        $this->notificationEmail = $notificationEmail;
    }

    /**
     * @param mixed $confirmationSpeed
     *
     * @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidSelectionException
     */
    public function setConfirmationSpeed($confirmationSpeed)
    {
        $this->validateOptions('confirmation_speed', $confirmationSpeed, ['low', 'medium', 'high']);
        $this->confirmationSpeed = $confirmationSpeed;
    }

    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,
        ];
    }

    public function isValid()
    {
        return $this->total > 0 && null !== $this->customerEmail;
    }

    public function exists()
    {
        return $this->id !== null;
    }
}


1		<?php
2
3		namespace GloBee\PaymentApi\Models;
4
5		/**
6		* @property string $id
7		* @property string $status
8		* @property float $total
9		* @property string $currency
10		* @property string $customPaymentId
11		* @property mixed $callbackData
12		* @property string $customerName
13		* @property string $customerEmail
14		* @property string $redirectUrl
15		* @property string $successUrl
16		* @property string $cancelUrl
17		* @property string $ipnUrl
18		* @property string $notificationEmail
19		* @property string $confirmationSpeed
20		* @property string $expiresAt
21		* @property string $createdAt
22		*/
23		class PaymentRequest extends Model
24		{
25		use PropertyTrait;
26
27		protected $total = 0.0;
28
29		protected $currency = 'USD';
30
31		protected $customPaymentId;
32
33		protected $callbackData;
34
35		protected $customerName;
36
37		protected $customerEmail;
38
39		protected $successUrl;
40
41		protected $cancelUrl;
42
43		protected $ipnUrl;
44
45		protected $notificationEmail;
46
47		protected $confirmationSpeed = 'medium';
48
49		private $id;
50
51		private $status;
52
53		private $redirectUrl;
54
55		private $expiresAt;
56
57		private $createdAt;
58
59	7	public static function fromResponse(array $data)
60		{
61	7	$self = new self();
62
63	7	$callbackData = json_decode($data['callback_data'], true);
64	7	if (json_last_error() !== JSON_ERROR_NONE) {
65	6	$callbackData = $data['callback_data'];
66		}
67	7	$self->id = $data['id'];
68	7	$self->status = $data['status'];
69	7	$self->total = $data['total'];
70	7	$self->currency = $data['currency'];
71	7	$self->customPaymentId = $data['custom_payment_id'];
72	7	$self->callbackData = $callbackData;
73	7	$self->customerName = $data['customer']['name'];
74	7	$self->customerEmail = $data['customer']['email'];
75	7	$self->redirectUrl = $data['redirect_url'];
76	7	$self->successUrl = $data['success_url'];
77	7	$self->cancelUrl = $data['cancel_url'];
78	7	$self->ipnUrl = $data['ipn_url'];
79	7	$self->notificationEmail = $data['notification_email'];
80	7	$self->confirmationSpeed = $data['confirmation_speed'];
81	7	$self->expiresAt = $data['expires_at'];
82	7	$self->createdAt = $data['created_at'];
83
84	7	return $self;
85		}
86
87		/**
88		* @param float $total
89		*
90		* @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidArgumentException
91		* @throws \GloBee\PaymentApi\Exceptions\Validation\BelowMinimumException
92		*/
93	7	public function setTotal($total)
94		{
95	7	$this->validateNumberAboveMinimum('total', $total, 0);
96	5	$this->total = $total;
97	5	}
98
99		/**
100		* @param mixed $currency
101		*
102		* @throws \GloBee\PaymentApi\Exceptions\Validation\ValidationException
103		* @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidArgumentException
104		*/
105	5	public function setCurrency($currency)
106		{
107	5	$this->validateStringLength('currency', $currency, 3);
108	3	$this->currency = strtoupper($currency);
109	3	}
110
111		/**
112		* @param mixed $customerEmail
113		*
114		* @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidArgumentException
115		* @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidEmailException
116		*/
117	6	public function setCustomerEmail($customerEmail)
118		{
119	6	$this->validateEmail('customer.email', $customerEmail);
120	5	$this->customerEmail = $customerEmail;
121	5	}
122
123		/**
124		* @param mixed $successUrl
125		*
126		* @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidArgumentException
127		* @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidUrlException
128		*/
129	4	public function setSuccessUrl($successUrl)
130		{
131	4	if ($successUrl !== null) {
132	3	$this->validateUrl('success_url', $successUrl);
133		}
134	3	$this->successUrl = $successUrl;
135	3	}
136
137		/**
138		* @param mixed $cancelUrl
139		*/
140	4	public function setCancelUrl($cancelUrl)
141		{
142	4	if ($cancelUrl !== null) {
143	3	$this->validateUrl('cancel_url', $cancelUrl);
144		}
145	3	$this->cancelUrl = $cancelUrl;
146	3	}
147
148		/**
149		* @param mixed $ipnUrl
150		*/
151	4	public function setIpnUrl($ipnUrl)
152		{
153	4	if ($ipnUrl !== null) {
154	3	$this->validateUrl('ipn_url', $ipnUrl);
155		}
156	3	$this->ipnUrl = $ipnUrl;
157	3	}
158
159		/**
160		* @param mixed $notificationEmail
161		*/
162	4	public function setNotificationEmail($notificationEmail)
163		{
164	4	if ($notificationEmail !== null) {
165	3	$this->validateEmail('notification_email', $notificationEmail);
166		}
167	3	$this->notificationEmail = $notificationEmail;
168	3	}
169
170		/**
171		* @param mixed $confirmationSpeed
172		*
173		* @throws \GloBee\PaymentApi\Exceptions\Validation\InvalidSelectionException
174		*/
175	3	public function setConfirmationSpeed($confirmationSpeed)
176		{
177	3	$this->validateOptions('confirmation_speed', $confirmationSpeed, ['low', 'medium', 'high']);
178	2	$this->confirmationSpeed = $confirmationSpeed;
179	2	}
180
181	3	public function toArray()
182		{
183	3	$callbackData = $this->callbackData;
184	3	if (is_array($callbackData)) {
185	1	$callbackData = json_encode($callbackData);
186		}
187
188		return [
189	3	'id' => $this->id,
190	3	'status' => $this->status,
191	3	'total' => $this->total,
192	3	'currency' => $this->currency,
193	3	'custom_payment_id' => $this->customPaymentId,
194	3	'callback_data' => $callbackData,
195		'customer' => [
196	3	'name' => $this->customerName,
197	3	'email' => $this->customerEmail,
198		],
199	3	'redirect_url' => $this->redirectUrl,
200	3	'success_url' => $this->successUrl,
201	3	'cancel_url' => $this->cancelUrl,
202	3	'ipn_url' => $this->ipnUrl,
203	3	'notification_email' => $this->notificationEmail,
204	3	'confirmation_speed' => $this->confirmationSpeed,
205	3	'expires_at' => $this->expiresAt,
206	3	'created_at' => $this->createdAt,
207		];
208		}
209
210	3	public function isValid()
211		{
212	3	return $this->total > 0 && null !== $this->customerEmail;
213		}
214
215	4	public function exists()
216		{
217	4	return $this->id !== null;
218		}
219		}
220

GloBee-Official / payment-api-php

Pull Request — master (#2)

PaymentRequest::setIpnUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like