mav3rick177 /
rapid-pagination
This project does not seem to handle request data directly as such no vulnerable execution paths were found.
include, or for example
via PHP's auto-loading mechanism.
These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
| 1 | <?php |
||
| 2 | |||
| 3 | namespace mav3rick177\RapidPagination\Base; |
||
| 4 | |||
| 5 | use mav3rick177\RapidPagination\Base\Contracts\Cursor; |
||
| 6 | use mav3rick177\RapidPagination\Base\Query\Order; |
||
| 7 | |||
| 8 | /** |
||
| 9 | * Class Paginator |
||
| 10 | */ |
||
| 11 | class Paginator |
||
| 12 | { |
||
| 13 | /** |
||
| 14 | * @var string[][] |
||
| 15 | */ |
||
| 16 | public $orders = []; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * @var int |
||
| 20 | */ |
||
| 21 | public $limit = 15; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @var bool |
||
| 25 | */ |
||
| 26 | public $backward = false; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * @var bool |
||
| 30 | */ |
||
| 31 | public $exclusive = false; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @var bool |
||
| 35 | */ |
||
| 36 | public $seekable = false; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * @var mixed |
||
| 40 | */ |
||
| 41 | public $builder; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Add cursor parameter name for ORDER BY statement. |
||
| 45 | * |
||
| 46 | * IMPORTANT: Last parameter MUST be a primary key |
||
| 47 | * |
||
| 48 | * e.g. $factory->orderBy('created_at')->orderBy('id') // <--- PRIMARY KEY |
||
| 49 | * |
||
| 50 | * @param string $column |
||
| 51 | * @param null|string $order |
||
| 52 | * @return $this |
||
| 53 | */ |
||
| 54 | 17 | public function orderBy($column, $order = Order::ASC) |
|
| 55 | { |
||
| 56 | 17 | $this->orders[] = [$column, $order]; |
|
| 57 | 17 | return $this; |
|
| 58 | } |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Add cursor parameter name for ORDER BY statement. |
||
| 62 | * |
||
| 63 | * @param string $column |
||
| 64 | * @return $this |
||
| 65 | */ |
||
| 66 | 6 | public function orderByDesc($column) |
|
| 67 | { |
||
| 68 | 6 | return $this->orderBy($column, Order::DESC); |
|
| 69 | } |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Clear all cursor parameters. |
||
| 73 | * |
||
| 74 | * @return $this |
||
| 75 | */ |
||
| 76 | public function clearOrderBy() |
||
| 77 | { |
||
| 78 | $this->orders = []; |
||
| 79 | return $this; |
||
| 80 | } |
||
| 81 | |||
| 82 | /** |
||
| 83 | * Define limit. |
||
| 84 | * |
||
| 85 | * @param int $limit |
||
| 86 | * @return $this |
||
| 87 | */ |
||
| 88 | 14 | public function limit($limit) |
|
| 89 | { |
||
| 90 | 14 | $this->limit = $limit; |
|
| 91 | 14 | return $this; |
|
| 92 | } |
||
| 93 | |||
| 94 | /** |
||
| 95 | * Define that the current pagination is going forward. |
||
| 96 | * |
||
| 97 | * @param bool $forward |
||
| 98 | * @return $this |
||
| 99 | */ |
||
| 100 | 8 | public function forward($forward = true) |
|
| 101 | { |
||
| 102 | 8 | $this->backward = !$forward; |
|
| 103 | 8 | return $this; |
|
| 104 | } |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Define that the current pagination is going backward. |
||
| 108 | * |
||
| 109 | * @param bool $backward |
||
| 110 | * @return $this |
||
| 111 | */ |
||
| 112 | 6 | public function backward($backward = true) |
|
| 113 | { |
||
| 114 | 6 | $this->backward = $backward; |
|
| 115 | 6 | return $this; |
|
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Define that the cursor value is not included in the previous/next result. |
||
| 120 | * |
||
| 121 | * @param bool $exclusive |
||
| 122 | * @return $this |
||
| 123 | */ |
||
| 124 | 4 | public function exclusive($exclusive = true) |
|
| 125 | { |
||
| 126 | 4 | $this->exclusive = $exclusive; |
|
| 127 | 4 | return $this; |
|
| 128 | } |
||
| 129 | |||
| 130 | /** |
||
| 131 | * Define that the cursor value is included in the previous/next result. |
||
| 132 | * |
||
| 133 | * @param bool $inclusive |
||
| 134 | * @return $this |
||
| 135 | */ |
||
| 136 | public function inclusive($inclusive = true) |
||
| 137 | { |
||
| 138 | $this->exclusive = !$inclusive; |
||
| 139 | return $this; |
||
| 140 | } |
||
| 141 | |||
| 142 | /** |
||
| 143 | * Define that the query can detect both "has_previous" and "has_next". |
||
| 144 | * |
||
| 145 | * @param bool $seekable |
||
| 146 | * @return $this |
||
| 147 | */ |
||
| 148 | 14 | public function seekable($seekable = true) |
|
| 149 | { |
||
| 150 | 14 | $this->seekable = $seekable; |
|
| 151 | 14 | return $this; |
|
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Define that the query can detect only either "has_previous" or "has_next". |
||
| 156 | * |
||
| 157 | * @param bool $unseekable |
||
| 158 | * @return $this |
||
| 159 | */ |
||
| 160 | public function unseekable($unseekable = true) |
||
| 161 | { |
||
| 162 | $this->seekable = !$unseekable; |
||
| 163 | return $this; |
||
| 164 | } |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Define options from an associative array. |
||
| 168 | * |
||
| 169 | * @param (bool|int|string[][])[] $options |
||
| 170 | * @return $this |
||
| 171 | */ |
||
| 172 | public function fromArray(array $options) |
||
| 173 | { |
||
| 174 | static $configurables = [ |
||
| 175 | 'limit', |
||
| 176 | 'forward', |
||
| 177 | 'backward', |
||
| 178 | 'exclusive', |
||
| 179 | 'inclusive', |
||
| 180 | 'seekable', |
||
| 181 | 'unseekable', |
||
| 182 | ]; |
||
| 183 | |||
| 184 | if (isset($options['orders'])) { |
||
| 185 | foreach ($options['orders'] as $order) { |
||
|
0 ignored issues
–
show
|
|||
| 186 | $this->orderBy(...$order); |
||
| 187 | } |
||
| 188 | } |
||
| 189 | |||
| 190 | foreach (array_intersect_key($options, array_flip($configurables)) as $key => $value) { |
||
| 191 | $this->$key($value); |
||
| 192 | } |
||
| 193 | |||
| 194 | return $this; |
||
| 195 | } |
||
| 196 | |||
| 197 | /** |
||
| 198 | * Build Query instance. |
||
| 199 | * |
||
| 200 | * @param Cursor|int[]|string[] $cursor |
||
| 201 | * @return Query |
||
| 202 | */ |
||
| 203 | 17 | public function configure($cursor = []) |
|
| 204 | { |
||
| 205 | 17 | return Query::create($this->orders, $cursor, $this->limit, $this->backward, $this->exclusive, $this->seekable, $this->builder); |
|
| 206 | } |
||
| 207 | } |
||
| 208 |
There are different options of fixing this problem.
If you want to be on the safe side, you can add an additional type-check:
If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:
Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.