Laravel PHP move collection item to the top of the collections - php

Question

This is just in case someone else has the same question and like me did not find a suitable answer to solve it.
I had a collection that had to be filtered so the active item comes first on the collections when a certain value was passed.
Illuminate\Database\Eloquent\Collection {
0 => array:2 [
"id" => 1
"name" => "Bogan, Weissnat and Jenkins"
]
1 => array:2 [
"id" => 4
"name" => "Grady-Barrows"
]
2 => array:2 [
"id" => 7
"name" => "Howe and Sons"
]
3 => array:2 [
"id" => 3
"name" => "Macejkovic-Altenwerth"
]
]
}
Needed to move an item top based on the id which is passed by URL

Answer 1

$activeId = 3; // Your active item id
$collection = $collection
->sortBy('id')
->sortBy(fn($item) => $item->id !== $activeId);
This will sort your collection by id and move a specific item to the top.
(PHP7.4+ for arrow function)

Answer 2

You can simply sort the collection by a custom function:
use Illuminate\Support\Collection;
$data = collect([
["id" => 1, "name" => "Bogan, Weissnat and Jenkins"],
["id" => 4, "name" => "Grady-Barrows"],
["id" => 7, "name" => "Howe and Sons"],
["id" => 3, "name" => "Macejkovic-Altenwerth"],
]);
$key = "name";
$value = "Grady-Barrows";
public function moveFirst(Collection $data, string $key, mixed $value): Collection
{
return $data->sortBy(fn($v) => $v[$key] !== $value);
}
It will return false (0) for the matching entry and true (1) for the rest, so the matching entry gets put on top. Using arrow functions makes for a much simpler syntax.

Answer 3

This is how I did solve it.
public function moveOtherToTop($collection, $key, $item)
{
return $collection->reject(function ($value) use ($item){
return $value[$key] == $item;
})->prepend($collection->filter(function ($value) use ($item) {
return $value[$key] == $item;
})[$item]);
}
Idea came out from Laracast and Stillat article.
In case there is a better solution to this answer am open to suggestions.

Answer 4

I run this in Laravel 5.8
use Illuminate\Support\Collection;
function moveItemToTopCollection(Collection $collection, String $key, $value) :Collection
{
$item_to_first = null;
// Search element to top
foreach ($collection as $item) {
if ($item->$key == $value){
$item_to_first = $item;
break;
}
}
// If element not found, return original collection
if (!$item_to_first){
return $collection;
}
// Element to top, first remove of collection, then insert to top
return $collection->reject(function ($value) use ($item_to_first){
return $value == $item_to_first;
})->prepend($item_to_first);
}

Answer 5

You can use the prioritize method from the great spatie/laravel-collection-macros package.