LaravelFreelancerNL / laravel-arangodb

src/Eloquent/Concerns/IsAranguentModel.php

<?php

declare(strict_types=1);

namespace LaravelFreelancerNL\Aranguent\Eloquent\Concerns;

use Illuminate\Database\Eloquent\Builder as IlluminateEloquentBuilder;
use Illuminate\Support\Str;
use LaravelFreelancerNL\Aranguent\Connection;
use LaravelFreelancerNL\Aranguent\Eloquent\Builder;
use LaravelFreelancerNL\Aranguent\Query\Builder as QueryBuilder;

trait IsAranguentModel
{
    use HasAttributes;
    use HasAranguentRelationships;

    /**
     * Insert the given attributes and set the ID on the model.
     *
     * @param  array<mixed>  $attributes
     * @return void
     */
    protected function insertAndSetId(IlluminateEloquentBuilder $query, $attributes)
    {
        assert($query instanceof Builder);

        $keyName = $this->getKeyName();

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

        $id = (string) $query->insertGetId($attributes, $keyName);

The method insertGetId() does not exist on LaravelFreelancerNL\Aranguent\Eloquent\Builder. Since you implemented __call, consider adding a @method annotation.

        $this->setAttribute($keyName, $id);

The method setAttribute() does not exist on LaravelFreelancerNL\Aranguent\Eloquent\Concerns\IsAranguentModel. Did you maybe mean setKeyAttribute()?

        if ($keyName === '_id') {
            $matches = [];
            preg_match('/\/(.*)$/', $id, $matches);

            // We know the exact string format for $matches when the attribute is _id
            /** @var array{0: string, 1: string} $matches */
            $this->setAttribute('id', $matches[1]); // @phpstan-ignore arrayUnpacking.stringOffset
        }
        if ($keyName === 'id' || $keyName === '_key') {
            $this->updateIdWithKey($id);
        }
    }

    /**
     * @override
     * Create a new Eloquent query builder for the model.
     *
     * @param  QueryBuilder  $query
     * @return Builder
     */
    public function newEloquentBuilder($query)
    {
        return new Builder($query);
    }

    /**
     * Get a new query builder instance for the connection.
     *
     * @return \Illuminate\Database\Query\Builder
     */
    protected function newBaseQueryBuilder()
    {
        return $this->getConnection()->query();
    }

    /**
     * Dynamically set attributes on the model.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return void
     */
    public function __set($key, $value)
    {
        // Laravel's mutators don't differentiate between id and _id, so we catch ArangoDB's _id here.
        if ($key === 'id') {
            $this->updateIdWithKey($value);
        }

        if ($key === '_id') {
            $this->attributes['id'] = explode('/', $value)[1];

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }

        $this->setAttribute($key, $value);
    }

    /**
     * Map the id attribute commonly used in Laravel to the primary key for third-party compatibility.
     * In ArangoDB '_key' is the equivalent of 'id' in sql databases.
     *
     * @param  string  $value
     * @return void
     */
    public function setKeyAttribute($value)
    {
        $this->attributes['_key'] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->updateIdWithKey($value);
    }

    protected function updateIdWithKey(string $key): void
    {
        $this->attributes['_id'] = $this->getTable() . '/' . $key;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

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

    }

    /**
     * Qualify the given column name by the model's table.
     *
     * @param  string  $column
     * @return string
     */
    public function qualifyColumn($column)
    {
        $tableReferer = Str::singular($this->getTable()) . 'Doc';

        if (Str::startsWith($column, $tableReferer . '.')) {
            return $column;
        }

        return $tableReferer . '.' . $column;
    }

    /**
     * Get the default foreign key name for the model.
     *
     * @return string
     */
    public function getForeignKey()
    {
        $keyName = $this->getKeyName();

        if ($keyName[0] != '_') {
            $keyName = '_' . $keyName;
        }

        return Str::snake(class_basename($this)) . $keyName;
    }

    /**
     * Get the database connection for the model.
     *
     * @return Connection
     */
    public function getConnection()
    {
        $connection = static::resolveConnection($this->getConnectionName());

The method getConnectionName() does not exist on LaravelFreelancerNL\Aranguent\Eloquent\Concerns\IsAranguentModel. Did you maybe mean getConnection()?

        assert($connection instanceof Connection);

        return $connection;
    }
}