umbrellio / laravel-ltree

src/Traits/LTreeModelTrait.php

<?php

declare(strict_types=1);

namespace Umbrellio\LTree\Traits;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\SoftDeletes;
use Umbrellio\LTree\Collections\LTreeCollection;
use Umbrellio\LTree\Interfaces\LTreeModelInterface;

/**
 * @mixin Model
 * @mixin LTreeModelInterface
 * @mixin SoftDeletes
 * @const string DELETED_AT
 */
trait LTreeModelTrait
{
    use LTreeTrait;

    public function newCollection(array $models = []): LTreeCollection
    {
        return new LTreeCollection($models);

$models of type array is incompatible with the type Illuminate\Contracts\Support\Arrayable expected by parameter $items of Umbrellio\LTree\Collections\LTreeCollection::__construct().

    }

    public function ltreeParent(): BelongsTo
    {
        return $this->belongsTo(static::class, $this->getLtreeParentColumn());

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

    }

    public function ltreeChildren(): HasMany
    {
        return $this->hasMany(static::class, $this->getLtreeParentColumn());

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

    }

    public function isParentOf(int $id): bool
    {
        return self::descendantsOf($this)->withoutSelf($this->getKey())->find($id) !== null;

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

    }

    public function scopeParentsOf(Builder $query, array $paths): Builder
    {
        return $query->whereRaw(sprintf(

The method whereRaw() does not exist on Illuminate\Database\Eloquent\Builder.

            "%s @> array['%s']::ltree[]",
            $this->getLtreePathColumn(),
            implode("', '", $paths)
        ));
    }

    public function scopeRoot(Builder $query): Builder
    {
        return $query->whereNull($this->getLtreeParentColumn());

The method whereNull() does not exist on Illuminate\Database\Eloquent\Builder.

    }

    public function scopeDescendantsOf(Builder $query, LTreeModelInterface $model, bool $reverse = true): Builder
    {
        return $query->whereRaw(sprintf(
            "({$this->getLtreePathColumn()} <@ text2ltree('%s')) = %s",
            $model->getLtreePath(LTreeModelInterface::AS_STRING),
            $reverse ? 'true' : 'false'
        ));
    }

    public function scopeAncestorsOf(Builder $query, LTreeModelInterface $model, bool $reverse = true): Builder
    {
        return $query->whereRaw(sprintf(
            "({$this->getLtreePathColumn()} @> text2ltree('%s')) = %s",
            $model->getLtreePath(LTreeModelInterface::AS_STRING),
            $reverse ? 'true' : 'false'
        ));
    }

    public function scopeWithoutSelf(Builder $query, int $id): Builder
    {
        return $query->whereRaw(sprintf('%s <> %s', $this->getKeyName(), $id));

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

    }

    public function getLtreeProxyUpdateColumns(): array
    {
        return [$this->getUpdatedAtColumn()];

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

    }

    public function getLtreeProxyDeleteColumns(): array
    {
        return [$this->getDeletedAtColumn()];

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

    }

    public function getAncestorByLevel(int $level = 1)
    {
        return static::ancestorByLevel($level)->first();
    }

    public function scopeAncestorByLevel(Builder $query, int $level = 1, ?string $path = null): Builder
    {
        return $query->whereRaw(sprintf(
            "({$this->getLtreePathColumn()} @> text2ltree('%s')) and nlevel({$this->getLtreePathColumn()}) = %d",
            $path ?: $this->getLtreePath(LTreeModelInterface::AS_STRING),

It seems like $path ?: $this->getLtreePath(Umbrellio\LTree\Interfaces\LTreeModelInterface::AS_STRING) can also be of type array and string[]; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

            $level
        ));
    }
}