orkhanahmadov / laravel-goldenpay

src/Traits/Payable.php

<?php

namespace Orkhanahmadov\LaravelGoldenpay\Traits;

use Illuminate\Container\Container;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Orkhanahmadov\Goldenpay\Enums\CardType;
use Orkhanahmadov\Goldenpay\Enums\Language;
use Orkhanahmadov\LaravelGoldenpay\Goldenpay;
use Orkhanahmadov\LaravelGoldenpay\Models\Payment;

/**
 * Trait Payable.
 *
 * @mixin Model
 */
trait Payable
{
    /**
     * Returns all related payments.
     *
     * @return MorphMany
     */
    public function payments(): MorphMany
    {
        return $this->morphMany(Payment::class, 'payable');

It seems like morphMany() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Returns all related successful payments.
     *
     * @return MorphMany
     */
    public function successfulPayments(): MorphMany
    {
        return $this->morphMany(Payment::class, 'payable')->whereSuccessful();
    }

    /**
     * @param CardType $cardType
     * @param int|null $amount
     * @param string|null $description
     * @param Language|null $lang
     *
     * @return Payment
     *
     * @throws \Illuminate\Contracts\Container\BindingResolutionException
     * @throws \Orkhanahmadov\Goldenpay\Exceptions\GoldenpayPaymentKeyException
     */
    public function createPayment(
        CardType $cardType,
        ?int $amount = null,
        ?string $description = null,
        ?Language $lang = null
    ): Payment {
        /** @var Goldenpay $goldenpay */
        $goldenpay = Container::getInstance()->make(Goldenpay::class);

        $payment = $goldenpay->payment(
            $amount ?: $this->amount(),
            $cardType,
            $description ?: $this->description(),
            $lang
        );

        $payment->payable_type = self::class;
        $payment->payable_id = $this->getKey();

It seems like getKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $payment->save();

        return $payment;
    }

    /**
     * Defines payment amount for this model's payments.
     *
     * @return int
     */
    abstract protected function amount(): int;

    /**
     * Defines description for this model's payments.
     *
     * @return string
     */
    abstract protected function description(): string;
}