Builder ignores Model custom Collection when getting data

[ziabice]

In my project I use a Model that returns a custom Collection subclass (I redefined the Model::newCollection() method).

The problem is that Scout Builder class completely ignores this new collection and instead returns a standard Eloquent\Collection: this breaks my code and seems to me the wrong behavior.

This issue affects Builder::paginate() and Engine::get().

The solution to this problem is very trivial: let Engine::map() return the right Collection type (it should already, because of it's signature that tells that the return type will be a \Illuminate\Database\Eloquent\Collection or a subclass), then pass as-is the collection.

This means that at a certain point into your Engine::map() method you'll do:

return $model->newCollection($results);

Attached there's a patch that should fix this annoying issue.

commit-f30d7bf.txt

[driesvints]

Hmm, I can see this being useful. @nunomaduro @taylorotwell do you guys want to weigh in here? I could send in a PR for this. Just replacing Collection::make with $model->newCollection where applicable could do the trick.

[nunomaduro]

@ziabice Thanks for bringing that up to our attention. @driesvints I also agree with the proposed solution. 👍