[RFC] Introduce AddressCollection class

[willdurand]

I think that this could be interesting since we always return a set of results rather than only one result. Moreover, having a class rather than relying on the array primitive type seems a bit more robust, and makes the API more fluent:

// Before:
$addresses = $geocoder->geocode('foobar');
$address   = empty($addresses) ? null : reset($addresses);

// After:
$address = $geocoder->geocode('foobar')->first();

WDYT?

[willdurand]

Should we return null here? IIRC we can't get 0 results as it would lead to a NoResult exception earlier in the execution flow:

try {
    $address = $geocoder->geocode('foobar')->first();
} catch (NoResult $e) {
    $address = null;
}

[toin0u]

Yes I think we can remove null here. We always have at least one Address in the collection.

[willdurand]

To be honest, I would not remove it since the class might be used elsewhere.

[toin0u]

I didn't thought it could used somewhere else :S

[pyrech]

I like the idea. What about implementing also the ArrayAccess interface to ease the migration?

[toin0u]

It's awesome ! :) It's a great improvement 👍

@willdurand I think we can implement the \Countable interface, I see the count method :)
@pyrech IMHO the \IteratorAggregate is enough but yes the ArrayAccess is very handy :)

[willdurand]

cool!

👍 for Countable
👎 for ArrayAccess