blob: 64f4ec997694f5cf3355d673d8374b6fa1431c28 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
<?php
declare(strict_types=1);
/*
* This file is part of the Geocoder package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
namespace Geocoder;
use Geocoder\Exception\CollectionIsEmpty;
use Geocoder\Exception\OutOfBounds;
/**
* This is the interface that is always return from a Geocoder.
*
* @author William Durand <william.durand1@gmail.com>
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
*/
interface Collection extends \IteratorAggregate, \Countable
{
/**
* @return Location
*
* @throws CollectionIsEmpty
*/
public function first(): Location;
/**
* @return bool
*/
public function isEmpty(): bool;
/**
* @return Location[]
*/
public function slice(int $offset, int $length = null);
/**
* @return bool
*/
public function has(int $index): bool;
/**
* @return Location
*
* @throws OutOfBounds
*/
public function get(int $index): Location;
/**
* @return Location[]
*/
public function all(): array;
}
|
