ArangoClient\Transactions\SupportsTransactions

Complexity

Total Complexity

12

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Test Coverage

Coverage

96.15%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	commit()	0	3	1
A	abort()	0	3	1
A	transactions()	0	7	2
A	setTransactionManager()	0	3	1
A	transactionAwareRequest()	0	17	3
A	getTransactionManager()	0	3	1
A	rollBack()	0	3	1
A	begin()	0	3	1
A	beginTransaction()	0	3	1

<?php

declare(strict_types=1);

namespace ArangoClient\Transactions;

use ArangoClient\Exceptions\ArangoException;
use ArangoClient\Http\HttpRequestOptions;
use stdClass;

trait SupportsTransactions
{
    /**
     * @var TransactionManager|null
     */
    protected ?TransactionManager $transactionManager = null;

    /**
     * @return TransactionManager
     */
    public function transactions(): TransactionManager
    {
        if (! isset($this->transactionManager)) {
            $this->transactionManager = new TransactionManager($this);
        }

        return $this->transactionManager;

The expression return $this->transactionManager could return the type null which is incompatible with the type-hinted return ArangoClient\Transactions\TransactionManager. Consider adding an additional type-check to rule them out.

    }

    /**
     * Shortcut to begin() on the transactionManager
     *
     * @param  array<string, array<string>>  $collections
     * @param  array<mixed>  $options
     * @return string
     *
     * @throws ArangoException
     */
    public function begin(array $collections = [], array $options = []): string
    {
        return $this->transactions()->begin($collections, $options);
    }

    /**
     * Shortcut to begin() on the transactionManager
     *
     * @param  array<string, array<string>>  $collections
     * @param  array<mixed>  $options
     * @return string
     *
     * @throws ArangoException
     */
    public function beginTransaction(array $collections = [], array $options = []): string
    {
        return $this->transactions()->begin($collections, $options);
    }

    /**
     * Shortcut to abort() on the transactionManager
     *
     * @param  string|null  $id
     * @return bool
     *
     * @throws ArangoException
     */
    public function abort(string $id = null): bool
    {
        return $this->transactions()->abort($id);
    }

    /**
     * Shortcut to abort() on the transactionManager
     *
     * @param  string|null  $id
     * @return bool
     *
     * @throws ArangoException
     */
    public function rollBack(string $id = null): bool
    {
        return $this->transactions()->abort($id);
    }

    /**
     * Shortcut to commit() on the transactionManager
     *
     * @param  string|null  $id
     * @return bool
     *
     * @throws ArangoException
     */
    public function commit(string $id = null): bool
    {
        return $this->transactions()->commit($id);
    }

    /**
     * @psalm-suppress MixedReturnStatement
     *
     * @param  string  $method
     * @param  string  $uri
     * @param  array<mixed>|HttpRequestOptions  $options
     * @param  string|null  $database
     * @param  int|null  $transactionId
     * @return stdClass
     *
     * @throws ArangoException
     */
    public function transactionAwareRequest(
        string $method,
        string $uri,
        $options = [],
        ?string $database = null,
        ?int $transactionId = null
    ): stdClass {
        if (is_array($options)) {
            $options = $this->prepareRequestOptions($options);

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

        }
        try {
            if (! isset($transactionId)) {
                $transactionId = $this->transactions()->getTransaction();
            }
            $options->addHeader('x-arango-trx-id', $transactionId);
        } finally {
            return $this->request($method, $uri, $options, $database);

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

        }
    }

    public function setTransactionManager(TransactionManager $transactionManager): void
    {
        $this->transactionManager = $transactionManager;
    }

    /**
     * @return TransactionManager|null
     */
    public function getTransactionManager(): ?TransactionManager
    {
        return $this->transactionManager;
    }
}