orkhanahmadov/laravel-goldenpay

<?php

namespace Orkhanahmadov\LaravelGoldenpay\Models;

use Illuminate\Database\Query\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Crypt;
use Orkhanahmadov\Goldenpay\Response\PaymentKey;
use Orkhanahmadov\LaravelGoldenpay\QueryBuilders\PaymentQueryBuilder;

/**
 * Class Payment.
 *
 * @property int $id
 * @property string $payable_type
 * @property int $payable_id
 * @property string $payment_key
 * @property int $amount
 * @property string $card_type
 * @property string $language
 * @property string $description
 * @property int $status
 * @property string $message
 * @property string $reference_number
 * @property string $card_number
 * @property \Carbon\Carbon $payment_date
 * @property int $checks
 * @property \Carbon\Carbon $created_at
 * @property \Carbon\Carbon $updated_at
 * @property-read string|null $payment_url
 * @property-read float|int $formatted_amount
 * @property-read string|null $card_number_decrypted
 * @property-read bool $successful
 * @method static Payment first()
 * @method static Builder whereSuccessful()
 * @method static Builder wherePending()
 */
class Payment extends Model
{
    protected $guarded = [
        'status',
    ];

    protected $dates = [
        'payment_date',
    ];

    protected $hidden = [
        'card_number',
    ];

    protected $casts = [
        'amount' => 'int',
        'status' => 'int',
        'checks' => 'int',
    ];

    public const STATUS_SUCCESSFUL = 1;

    public const MINIMUM_REQUIRED_CHECKS = 3;

    /**
     * Payment constructor.
     *
     * @param array $attributes
     */
    public function __construct(array $attributes = [])
    {
        $this->setTable(Config::get('goldenpay.table_name'));

        parent::__construct($attributes);
    }

    /**
     * @param Builder $query
     *
     * @return PaymentQueryBuilder
     */
    public function newEloquentBuilder($query): PaymentQueryBuilder
    {
        return new PaymentQueryBuilder($query);
    }

    /**
     * Returns payment's related model.
     *
     * @return MorphTo
     */
    public function payable(): MorphTo
    {
        return $this->morphTo();
    }

    /**
     * "payment_url" accessor.
     * Used to get "Goldenpay payment page url" from Payment model instance.
     * Returns "null" if payment is considered successful.
     *
     * @return string|null
     */
    public function getPaymentUrlAttribute(): ?string
    {
        if ($this->successful) {
            return null;
        }

        return (new PaymentKey($this->payment_key))->paymentUrl();
    }

    /**
     * "successful" accessor.
     * Used on Payment model instances to get if payment considered successful.
     *
     * @return bool
     */
    public function getSuccessfulAttribute(): bool
    {
        return $this->status === self::STATUS_SUCCESSFUL;
    }

    /**
     * "formatted_amount" accessor.
     * Because all amount related values stored as integer,
     * this accessor is used to return values as decimal.
     *
     * @return float|int
     */
    public function getFormattedAmountAttribute()
    {
        return $this->amount / 100;
    }

    /**
     * "card_number_decrypted" accessor.
     * Returns decrypted value for "card_number".
     * Returns null if "encrypt_card_numbers" setting turned off or "card_number" is not available.
     *
     * @return string|null
     */
    public function getCardNumberDecryptedAttribute(): ?string
    {
        if (Config::get('goldenpay.encrypt_card_numbers') && $this->card_number) {
            return Crypt::decrypt($this->card_number);
        }

        return null;
    }

    /**
     * Mutator for encrypting "card_number" data.
     *
     * @param string|null $value
     */
    public function setCardNumberAttribute(?string $value): void
    {
        if (Config::get('goldenpay.encrypt_card_numbers') && $value) {
            $this->attributes['card_number'] = Crypt::encrypt($value);
        } else {
            $this->attributes['card_number'] = $value;
        }
    }
}