|
1
|
|
|
<?php declare (strict_types = 1); |
|
2
|
|
|
|
|
3
|
|
|
namespace Limoncello\Flute\Contracts\Models; |
|
4
|
|
|
|
|
5
|
|
|
/** |
|
6
|
|
|
* Copyright 2015-2019 [email protected] |
|
7
|
|
|
* |
|
8
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); |
|
9
|
|
|
* you may not use this file except in compliance with the License. |
|
10
|
|
|
* You may obtain a copy of the License at |
|
11
|
|
|
* |
|
12
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0 |
|
13
|
|
|
* |
|
14
|
|
|
* Unless required by applicable law or agreed to in writing, software |
|
15
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, |
|
16
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
17
|
|
|
* See the License for the specific language governing permissions and |
|
18
|
|
|
* limitations under the License. |
|
19
|
|
|
*/ |
|
20
|
|
|
|
|
21
|
|
|
/** |
|
22
|
|
|
* @package Limoncello\Flute |
|
23
|
|
|
*/ |
|
24
|
|
|
interface PaginatedDataInterface |
|
25
|
|
|
{ |
|
26
|
|
|
/** |
|
27
|
|
|
* @return mixed |
|
28
|
|
|
*/ |
|
29
|
|
|
public function getData(); |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* @return bool |
|
33
|
|
|
*/ |
|
34
|
|
|
public function isCollection(): bool; |
|
35
|
|
|
|
|
36
|
|
|
/** |
|
37
|
|
|
* @return self |
|
|
|
|
|
|
38
|
|
|
*/ |
|
39
|
|
|
public function markAsCollection(): self; |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* @return self |
|
|
|
|
|
|
43
|
|
|
*/ |
|
44
|
|
|
public function markAsSingleItem(): self; |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* @return bool |
|
48
|
|
|
*/ |
|
49
|
|
|
public function hasMoreItems(): bool; |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* @return self |
|
|
|
|
|
|
53
|
|
|
*/ |
|
54
|
|
|
public function markHasMoreItems(): self; |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* @return self |
|
|
|
|
|
|
58
|
|
|
*/ |
|
59
|
|
|
public function markHasNoMoreItems(): self; |
|
60
|
|
|
|
|
61
|
|
|
/** |
|
62
|
|
|
* @return int|null |
|
63
|
|
|
*/ |
|
64
|
|
|
public function getOffset(): ?int; |
|
65
|
|
|
|
|
66
|
|
|
/** |
|
67
|
|
|
* @param int|null $offset |
|
68
|
|
|
* |
|
69
|
|
|
* @return self |
|
|
|
|
|
|
70
|
|
|
*/ |
|
71
|
|
|
public function setOffset(int $offset = null): self; |
|
72
|
|
|
|
|
73
|
|
|
/** |
|
74
|
|
|
* @return int|null |
|
75
|
|
|
*/ |
|
76
|
|
|
public function getLimit(): ?int; |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* @param int|null $size |
|
80
|
|
|
* |
|
81
|
|
|
* @return self |
|
|
|
|
|
|
82
|
|
|
*/ |
|
83
|
|
|
public function setLimit(int $size = null): self; |
|
84
|
|
|
} |
|
85
|
|
|
|
limoncello-php-dist /
flute
Loading history...
This check compares the return type specified in the
@returnannotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.