staudenmeir / belongs-to-through

src/Traits/BelongsToThrough.php

<?php

namespace Znck\Eloquent\Traits;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Znck\Eloquent\Relations\BelongsToThrough as Relation;

trait BelongsToThrough
{
    /**
     * Define a belongs-to-through relationship.
     *
     * @template TRelatedModel of \Illuminate\Database\Eloquent\Model
     *
     * @param class-string<TRelatedModel> $related

The doc comment class-string<TRelatedModel> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<TRelatedModel>.

     * @param class-string<\Illuminate\Database\Eloquent\Model>[]|array{0: class-string<\Illuminate\Database\Eloquent\Model>, 1: string}[]|class-string<\Illuminate\Database\Eloquent\Model> $through
     * @param string|null $localKey
     * @param string $prefix
     * @param array<class-string<\Illuminate\Database\Eloquent\Model>, string> $foreignKeyLookup
     * @param array<class-string<\Illuminate\Database\Eloquent\Model>, string> $localKeyLookup
     * @return \Znck\Eloquent\Relations\BelongsToThrough<TRelatedModel, $this>
     */
    public function belongsToThrough(
        $related,
        $through,
        $localKey = null,
        $prefix = '',
        $foreignKeyLookup = [],
        array $localKeyLookup = []
    ) {
        /** @var TRelatedModel $relatedInstance */
        $relatedInstance = $this->newRelatedInstance($related);

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

        /** @var list<\Illuminate\Database\Eloquent\Model> $throughParents */
        $throughParents  = [];
        $foreignKeys     = [];

        foreach ((array) $through as $model) {
            $foreignKey = null;

            if (is_array($model)) {
                /** @var string $foreignKey */
                $foreignKey = $model[1];

                /** @var class-string<\Illuminate\Database\Eloquent\Model> $model */
                $model = $model[0];
            }

            $instance = $this->belongsToThroughParentInstance($model);

            if ($foreignKey) {
                $foreignKeys[$instance->getTable()] = $foreignKey;
            }

            $throughParents[] = $instance;
        }

        $foreignKeys = array_merge($foreignKeys, $this->mapKeys($foreignKeyLookup));

        $localKeys = $this->mapKeys($localKeyLookup);

        return $this->newBelongsToThrough(
            $relatedInstance->newQuery(),
            $this,

$this of type Znck\Eloquent\Traits\BelongsToThrough is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $parent of Znck\Eloquent\Traits\BelongsToThrough::newBelongsToThrough().

            $throughParents,

$throughParents of type Znck\Eloquent\Traits\list is incompatible with the type array expected by parameter $throughParents of Znck\Eloquent\Traits\BelongsToThrough::newBelongsToThrough().

            $localKey,
            $prefix,
            $foreignKeys,
            $localKeys
        );
    }

    /**
     * Map keys to an associative array where the key is the table name and the value is the key from the lookup.
     *
     * @param array<class-string<\Illuminate\Database\Eloquent\Model>, string> $keyLookup

The doc comment array<class-string<\Illuminate\Database\Eloquent\Model>, string> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array<class-string<\Illuminate\Database\Eloquent\Model>, string>.

     * @return array<string, string>
     */
    protected function mapKeys(array $keyLookup): array
    {
        $keys = [];

        // Iterate over each model and key in the key lookup
        foreach ($keyLookup as $model => $key) {
            // Create a new instance of the model
            $instance = new $model();

            // Add the table name and key to the keys array
            $keys[$instance->getTable()] = $key;
        }

        return $keys;
    }

    /**
     * Create a through parent instance for a belongs-to-through relationship.
     *
     * @template TModel of \Illuminate\Database\Eloquent\Model
     *
     * @param class-string<TModel> $model

The doc comment class-string<TModel> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<TModel>.

     * @return TModel
     */
    protected function belongsToThroughParentInstance($model)
    {
        /** @var array{0: class-string<TModel>, 1?: string} $segments */
        $segments = preg_split('/\s+as\s+/i', $model);

        /** @var TModel $instance */
        $instance = new $segments[0]();

        if (isset($segments[1])) {
            $instance->setTable($instance->getTable() . ' as ' . $segments[1]);
        }

        return $instance;
    }

    /**
     * Instantiate a new BelongsToThrough relationship.
     *
     * @template TRelatedModel of \Illuminate\Database\Eloquent\Model
     * @template TDeclaringModel of \Illuminate\Database\Eloquent\Model
     *
     * @param \Illuminate\Database\Eloquent\Builder<TRelatedModel> $query
     * @param TDeclaringModel $parent

The type Znck\Eloquent\Traits\TDeclaringModel was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param list<\Illuminate\Database\Eloquent\Model> $throughParents

The type Znck\Eloquent\Traits\list was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param string|null $localKey
     * @param string $prefix
     * @param array<string, string> $foreignKeyLookup
     * @param array<string, string> $localKeyLookup
     * @return \Znck\Eloquent\Relations\BelongsToThrough<TRelatedModel, TDeclaringModel>
     */
    protected function newBelongsToThrough(
        Builder $query,
        Model $parent,
        array $throughParents,
        $localKey,
        $prefix,
        array $foreignKeyLookup,
        array $localKeyLookup
    ) {
        return new Relation($query, $parent, $throughParents, $localKey, $prefix, $foreignKeyLookup, $localKeyLookup);
    }
}