Order context

[wimski]

A lot of times I want models to be ordered within a certain context (a specific column or columns), usually within a BelongsTo relationship. The models will then be ordered within that context and also the order number will be determined within that context. I have done this in an extension of the trait (which I'm lugging around from project to project) like this:

trait SortableTrait
{
    /**
     * @return array<int, string>
     */
    protected function getScopeOrderContext(): array
    {
        return [];
    }

    // Existing method
    public function scopeOrdered(Builder $query, string $direction = 'asc')
    {
        // Added this ordering
        foreach ($this->getScopeOrderContext() as $contextColumnName) {
            $query->orderBy($contextColumnName, $direction);
        }

        return $query->orderBy($this->determineOrderColumnName(), $direction);
    }
   
    // Existing method
    public function buildSortQuery(): Builder
    {
        // Added everything up till the return
        $query = static::query();

        $orderContext = $this->getScopeOrderContext();

        if (empty($orderContext)) {
            return $query;
        }

        foreach ($orderContext as $contextColumnName) {
            $query->where($contextColumnName, $this->{$contextColumnName});
        }

        return $query;
    }
}

Example usage:

/**
 * @property int $other_model_id
 * @property-read OtherModel $otherModel
 */
class MyModel extends Model implements Sortable
{
    use SortableTrait;

    /**
     * @return BelongsTo<OtherModel, self>
     */
    public function otherModel(): BelongsTo
    {
        return $this->belongsTo(OtherModel::class);
    }

    /**
     * @return array<int, string>
     */
    protected function getScopeOrderContext(): array
    {
        return ['other_model_id'];
    }
}

Would this be something to include in the package? I'm happy to supply a PR, but I'm asking first before putting in the work.

[freekmurze]

Thanks for your suggestion, but probably we'll not introduce this in our package, as we like to keep it as simple as it can be.