[8.x] Allow shift() and pop() to take multiple items from a collection

[edgrosvenor]

This pull request adds an optional numeric argument, defaulting to 1, to the pop() and shift() methods of the Collection class. This allows the user to shift or pop x items from a collection in one pass. This PR was inspired by the following situation.

I have a collection of 98 records that I need to divide as evenly as possible into 4 groups. So the group sizes would be 25, 25, 24, and 24. In order to do this, I have to jump through some hoops using take() and skip()...

$groupSizes = [25, 25, 24, 24];
$skip = 0;

foreach ($groupSizes as $size) {
    $group = $collection->skip($skip)->take($size);
    $skip += $size;
   // Do something with the group
}

With this new argument, I have the option of simply doing

$groupSizes = [25, 25, 24, 24];


foreach ($groupSizes as $size) {
    $group = $collection->shift($size);
    // Do something with the group
}

Because the default value for each of the methods is 1, they continue to work exactly as they did before.

Alternatives

There are a couple other ways this problem could be solved. The first would be to create new methods for each. Something like popMany() and shiftMany(). Another would be to add an optional second parameter to take() that would remove the items returned from the original collection.

[edgrosvenor]

I'll send a PR to update the docs later today. Thanks Taylor!

[JosephSilber]

array_shift is an expensive operation (as it needs to re-key all items in the array). You don't really want to do that in a loop 😢