GloBee-Official / payment-api-php

src/Models/PaymentRequest.php

<?php

namespace GloBee\PaymentApi\Models;

use GloBee\PaymentApi\Exceptions\Validation\ValidationException;

class PaymentRequest extends Model
{
    protected $total;

Missing member variable doc comment

    protected $currency;

Missing member variable doc comment

    protected $customPaymentId;

Missing member variable doc comment

    protected $callbackData;

Missing member variable doc comment

    protected $customerName;

Missing member variable doc comment

    protected $customerEmail;

Missing member variable doc comment

    protected $successUrl;

Missing member variable doc comment

    protected $cancelUrl;

Missing member variable doc comment

    protected $ipnUrl;

Missing member variable doc comment

    protected $notificationEmail;

Missing member variable doc comment

    protected $confirmationSpeed = 'medium';

Missing member variable doc comment

    protected $id;

Missing member variable doc comment

    protected $status;

Missing member variable doc comment

    protected $redirectUrl;

Missing member variable doc comment

    protected $expiresAt;

Missing member variable doc comment

    protected $createdAt;

Missing member variable doc comment

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

Missing function doc comment

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

    protected function setTotal($total)

Missing function doc comment

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

        return $this;
    }

    protected function setCurrency($currency)

Missing function doc comment

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

        return $this;
    }

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

Missing function doc comment

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

        return $this;
    }

    public function setSuccessUrl($successUrl)

Missing function doc comment

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

        return $this;
    }

    public function setCancelUrl($cancelUrl)

Missing function doc comment

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

        return $this;
    }

    public function setCallbackData($callbackData)

Missing function doc comment

    {
        $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)

Missing function doc comment

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

        return $this;
    }

    public function setCustomPaymentId($customPaymentId)

Missing function doc comment

    {
        $this->customPaymentId = $customPaymentId;

        return $this;
    }

    public function setNotificationEmail($notificationEmail)

Missing function doc comment

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

        return $this;
    }

    public function setLowRiskConfirmation()

Missing function doc comment

    {
        $this->confirmationSpeed = 'low';

        return $this;
    }

    public function setBalancedConfirmation()

Missing function doc comment

    {
        $this->confirmationSpeed = 'medium';

        return $this;
    }

    public function setQuickConfirmation()

Missing function doc comment

    {
        $this->confirmationSpeed = 'high';

        return $this;
    }

    public function setConfirmationSpeed($confirmationSpeed)

Missing function doc comment

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

        return $this;
    }

    public static function fromResponse(array $data)

Missing function doc comment

    {
        $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()

Missing function doc comment

    {
        $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 ----------------------------------------------------------------------------- //

    /**

Doc comment for parameter "$successUrl" missing

     * @deprecated
     */

Missing @return tag in function comment

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

    /**

Doc comment for parameter "$cancelUrl" missing

     * @deprecated
     */

Missing @return tag in function comment

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

    /**

Doc comment for parameter "$callbackData" missing

     * @deprecated
     */

Missing @return tag in function comment

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

    /**

Doc comment for parameter "$ipnUrl" missing

     * @deprecated
     */

Missing @return tag in function comment

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

    /**

Doc comment for parameter "$customPaymentId" missing

     * @deprecated
     */

Missing @return tag in function comment

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

    /**

Doc comment for parameter "$notificationEmail" missing

     * @deprecated
     */

Missing @return tag in function comment

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

    /**
     * @deprecated
     */

Missing @return tag in function comment

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

    /**
     * @deprecated
     */

Missing @return tag in function comment

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

    /**
     * @deprecated
     */

Missing @return tag in function comment

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

    /**

Doc comment for parameter "$confirmationSpeed" missing

     * @deprecated
     */

Missing @return tag in function comment

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