QueueInterface.php
1.22 KB
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
<?php
// Copyright (c) Lellys Informática. All rights reserved. See License.txt in the project root for license information.
namespace Easy\Collections;
use BadFunctionCallException;
/**
* Provides functionality to evaluate queries against a specific data source wherein the type of the data is not specified.
*/
interface QueueInterface
{
/**
* Adds an object to the end of the Queue.
* @param mixed $item The object to add to the Queue. The value can be null.
* @return Queue
*/
public function enqueue($item);
/**
* Adds multiples objects to the end of the Queue.
* @param CollectionInterface|array $items The objects to add to the Queue. The value can be null.
* @return Queue
*/
public function enqueueMultiple($items);
/**
* Removes and returns the object at the beginning of the Queue.
* @return mixed The object that is removed from the beginning of the Queue.
* @throws BadFunctionCallException
*/
public function dequeue();
/**
* Returns the object at the beginning of the Queue without removing it.
* @return mixed The object at the beginning of the Queue.
* @throws BadFunctionCallException
*/
public function peek();
}