animethemes-server/app/Concerns/Actions/GraphQL/SortsModels.php

<?php

declare(strict_types=1);

namespace App\Concerns\Actions\GraphQL;

use App\Enums\GraphQL\SortType;
use App\GraphQL\Schema\Enums\SortableColumns;
use App\GraphQL\Schema\Types\BaseType;
use App\GraphQL\Schema\Unions\BaseUnion;
use App\GraphQL\Support\Argument\SortArgument;
use App\GraphQL\Support\Sort\RandomSort;
use App\GraphQL\Support\Sort\Sort;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use InvalidArgumentException;

trait SortsModels
{
    public function sort(Builder $builder, array $args, BaseType|BaseUnion $type): Builder
    {
        $sorts = Arr::get($args, SortArgument::ARGUMENT);

        if (blank($sorts)) {
            return $builder;
        }

        $resolvers = Arr::get(new SortableColumns($type)->getAttributes(), 'resolvers');

        $this->applySort($builder, $sorts, $resolvers);

        return $builder;
    }

    /**
     * @param  array<string, string>  $sorts
     * @param  array<string, array<string, mixed>>  $resolvers
     *
     * @throws InvalidArgumentException
     */
    protected function applySort(Builder $builder, array $sorts, array $resolvers): Builder
    {
        foreach ($sorts as $sort) {
            if ($sort === RandomSort::CASE) {
                $builder->inRandomOrder();
                continue;
            }

            $resolver = Arr::get($resolvers, Str::remove('_DESC', $sort));

            $direction = Sort::resolveFromEnumCase($sort);

            $column = Arr::get($resolver, SortableColumns::RESOLVER_COLUMN);
            $sortType = Arr::get($resolver, SortableColumns::RESOLVER_SORT_TYPE);

            if ($sortType === SortType::ROOT) {
                $builder->orderBy($column, $direction);
            }

            $relation = Arr::get($resolver, SortableColumns::RESOLVER_RELATION);
            if ($sortType === SortType::AGGREGATE) {
                throw_if($relation === null, InvalidArgumentException::class, "The 'relation' argument is required for the {$column} column with aggregate sort type.");

                $builder->withAggregate([
                    "$relation as {$relation}_value" => function ($query) use ($direction): void {
                        $query->orderBy('value', $direction);
                    },
                ], 'value');

                $builder->orderBy("{$relation}_value", $direction);
            }

            if ($sortType === SortType::RELATION) {
                throw_if($relation === null, InvalidArgumentException::class, "The 'relation' argument is required for the {$column} column with aggregate sort type.");

                $builder->withAggregate([
                    "$relation as {$relation}_$column" => function ($query) use ($column, $direction): void {
                        $query->orderBy($column, $direction);
                    },
                ], $column);

                $builder->orderBy("{$relation}_$column", $direction);
            }

            if ($sortType === SortType::COUNT_RELATION) {
                throw_if($relation === null, InvalidArgumentException::class, "The 'relation' argument is required for the {$column} column with relation sort type.");

                $builder->withCount($relation)->orderBy("{$relation}_count", $direction);
            }
        }

        return $builder;
    }
}