Debian Codegraph @

vendor/ramsey/collection/src/ArrayInterface.php

raw
1 <?php
2
3 /**
4 * This file is part of the ramsey/collection library
5 *
6 * For the full copyright and license information, please view the LICENSE
7 * file that was distributed with this source code.
8 *
9 * @copyright Copyright (c) Ben Ramsey <[email protected]>
10 * @license http://opensource.org/licenses/MIT MIT
11 */
12
13 declare(strict_types=1);
14
15 namespace Ramsey\Collection;
16
17 use ArrayAccess;
18 use Countable;
19 use IteratorAggregate;
20
21 /**
22 * `ArrayInterface` provides traversable array functionality to data types.
23 *
24 * @template T
25 * @extends ArrayAccess<array-key, T>
26 * @extends IteratorAggregate<array-key, T>
27 */
28 interface ArrayInterface extends
29 ArrayAccess,
30 Countable,
31 IteratorAggregate
32 {
33 /**
34 * Removes all items from this array.
35 */
36 public function clear(): void;
37
38 /**
39 * Returns a native PHP array representation of this array object.
40 *
41 * @return array<array-key, T>
42 */
43 public function toArray(): array;
44
45 /**
46 * Returns `true` if this array is empty.
47 */
48 public function isEmpty(): bool;
49 }