ByTIC / payments

src/Models/Transactions/TransactionsTrait.php

<?php

namespace ByTIC\Payments\Models\Transactions;

use ByTIC\Payments\Models\AbstractModels\HasPaymentMethod\HasPaymentMethodRepository;
use ByTIC\Payments\Models\AbstractModels\HasToken\HasTokenRepository;
use ByTIC\Payments\Models\Purchase\Traits\IsPurchasableModelTrait;
use ByTIC\Payments\Models\Purchases\Purchase;
use ByTIC\Payments\Utility\PaymentsModels;
use Nip\MailModule\Models\EmailsTable\EmailTrait;

The type Nip\MailModule\Models\EmailsTable\EmailTrait was not found. Maybe you did not declare it correctly or list all dependencies?

use Nip\Records\AbstractModels\Record;
use Nip\Records\EventManager\Events\Event;

/**
 * Trait TransactionsTrait
 * @package ByTIC\Payments\Models\Transactions
 *
 * @method TransactionTrait getNew
 */
trait TransactionsTrait
{
    use \ByTIC\Models\SmartProperties\RecordsTraits\HasStatus\RecordsTrait;
    use HasTokenRepository;
    use HasPaymentMethodRepository;

    public function bootTransactionsTrait()
    {
        static::creating(function (Event $event) {

            /** @var EmailTrait|\Nip\Records\Record $record */
            $record = $event->getRecord();

            $record->setIf('metadata', '{}', function () use ($record) {
                return count($record->metadata) < 1;

It seems like $record->metadata can also be of type null; however, parameter $value of count() does only seem to accept Countable|array, maybe add an additional type check?

            });
        });
    }

    /**
     * @param Purchase|IsPurchasableModelTrait $purchase
     * @return TransactionTrait
     */
    public function findOrCreateForPurchase($purchase)
    {
        $transaction = $this->findForPurchase($purchase);
        if ($transaction instanceof Record) {
            return $transaction;

The expression return $transaction also could return the type Nip\Records\AbstractModels\Record which is incompatible with the documented return type ByTIC\Payments\Models\Transactions\TransactionTrait.

        }
        return $this->createForPurchase($purchase);
    }

    /**
     * @param Purchase|IsPurchasableModelTrait $purchase
     * @return TransactionTrait|null
     */
    public function findForPurchase($purchase)
    {
        return $this->findOneByField('id_purchase', $purchase->id);

The method findOneByField() does not exist on ByTIC\Payments\Models\Transactions\TransactionsTrait. Did you maybe mean findOneByQuery()?

    }

    /**
     * @return string
     */
    public function getStatusItemsRootNamespace()
    {
        return '\ByTIC\Payments\Models\Transactions\Statuses\\';
    }

    /**
     * @return string
     */
    public function getStatusItemsDirectory()
    {
        return __DIR__ . DIRECTORY_SEPARATOR . 'Statuses';
    }

    /**
     * @param Purchase|IsPurchasableModelTrait $purchase
     * @return TransactionTrait
     */
    protected function createForPurchase($purchase)
    {
        $transaction = $this->getNew();
        $transaction->populateFromPayment($purchase);
        $transaction->populateFromGateway($purchase->getPaymentMethod()->getType()->getGateway());
        $transaction->insert();

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

        return $transaction;
    }

    protected function initRelations()
    {
        parent::initRelations();
        $this->initRelationsCommon();
    }

    protected function initRelationsCommon()
    {
        $this->initRelationsPurchase();
        $this->initRelationsPaymentMethod();
        $this->initRelationsSubscription();
        $this->initRelationsToken();
    }

    protected function initRelationsPurchase()
    {
        $this->belongsTo('Purchase', ['class' => get_class(PaymentsModels::purchases()), 'fk' => 'id_purchase']);

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

    }

    protected function initRelationsSubscription()
    {
        $this->belongsTo('Subscription', ['class' => get_class(PaymentsModels::subscriptions())]);
    }

    /**
     * @param array $params
     */
    protected function injectParams(&$params = [])
    {
        $params['order'][] = ['created', 'desc'];

        parent::injectParams($params);
    }

    /**
     * @return mixed|\Nip\Config\Config
     * @throws \Exception
     */
    protected function generateTable()
    {
        return config('payments.tables.transactions', \ByTIC\Payments\Models\Transactions\Transactions::TABLE);
    }
}