[5.4] Always return a collection when calling Collection::random with a parameter

[sebastiandedeyne]

See laravel/ideas#304

Currently, if you call $collection->random(1), you'll get a single item back. This makes sense if there isn't a parameter set, but if 1 is explicitly passed through, it should return a new collection instance. This keeps it consistent with passing in any other integer.

[GrahamCampbell]

👎 from me. Very confusing behaviour to have passing null behaving differently to if you don't pass anything, even though the default for arg 1 is null.

[sebastiandedeyne]

Hmm that's actually a mistake in my PR, not in the underlying idea. If the default parameter would be null instead of 1, that wouldn't be an issue, right? Then ->random(null) would behave the same as ->random().

[GrahamCampbell]

I don't like the premise of the idea entirely anyway.

[sebastiandedeyne]

Doesn't random() behaving differently than random(int) make more sense that random(int = 1) behaving differently than random(int = >1)?

[GrahamCampbell]

Doesn't random() behaving differently than random(int) make more sense that random(int = 1) behaving differently than random(int = >1)?

No, because PHP doesn't have a concept of multiple function definitions like Java.

[GrahamCampbell]

I think the current behaviour is fine, though if we are going to change it, we should just break it to always return a collection, instead of the confusing mess of maybe returning one.

[taylorotwell]

I think this makes fairly good sense... if I'm passing an argument to that method, that argument could be a variable. If it's a variable it could be 1, in which in my own code I would be forced to have an if statement to know whether I have a collection or a single item. With this PR I can know for sure which one I will have just by asking if I am passing an argument to the method.