Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/Illuminate/Database/Eloquent/Builder.php
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,19 @@ public function latest($column = null)
return $this;
}

/**
* Order the query by a column with a given set of priority values.
*
* @param array{string|\BackedEnum}|null $priorities
* @return $this
*/
public function orderByWithPriority(string $column, ?array $priorities = [], ?string $direction = 'asc')
{
$this->query->orderByWithPriority(...func_get_args());

return $this;
}

/**
* Add an "order by" clause for a timestamp to the query.
*
Expand Down
25 changes: 25 additions & 0 deletions src/Illuminate/Database/Query/Builder.php
Original file line number Diff line number Diff line change
Expand Up @@ -2704,6 +2704,31 @@ public function orderBy($column, $direction = 'asc')
return $this;
}

/**
* Order the query by a column with a given set of priority values.
*
* @param array{string|\BackedEnum}|null $priorities
* @return $this
*/
public function orderByWithPriority(string $column, ?array $priorities = [], ?string $direction = 'asc')
{
if (empty($priorities)) {
return $this->orderBy($column, $direction);
}

// Convert enums to their backing values if needed
$priorities = array_map(function ($value) {
return $value instanceof \UnitEnum
? ($value instanceof \BackedEnum ? $value->value : $value->name)
: $value;
}, $priorities);

$bindings = array_map(fn () => '?', $priorities);
$sql = "FIELD({$this->grammar->wrap($column)}, ".implode(',', $bindings).')';

return $this->orderByRaw($sql.' '.$direction, $priorities);
}

/**
* Add a descending "order by" clause to the query.
*
Expand Down
33 changes: 33 additions & 0 deletions tests/Database/DatabaseQueryBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -2077,6 +2077,39 @@ public function testOrderBys()
$this->assertEquals([1, 1, 'news', 'opinion'], $builder->getBindings());
}

public function test_order_by_with_priority_generates_expected_sql()
{
$properties = [
'done',
'pending',
];

$builder = $this->getBuilder();
$builder->select('*')->from('posts')->orderByWithPriority('status', $properties);

$this->assertSame(
'select * from "posts" order by FIELD("status", ?,?) asc',
$builder->toSql()
);

$this->assertEquals($properties, $builder->getBindings());

$properties = [
StringStatus::done,
StringStatus::pending,
];

$builder = $this->getBuilder();
$builder->select('*')->from('posts')->orderByWithPriority('status', $properties);

$this->assertSame(
'select * from "posts" order by FIELD("status", ?,?) asc',
$builder->toSql()
);

$this->assertEquals(array_map(fn (StringStatus $item) => $item->value, $properties), $builder->getBindings());
}

public function testLatest()
{
$builder = $this->getBuilder();
Expand Down