init

2026-05-12 21:10:38 +02:00
commit ab96d82fcf
2544 changed files with 721700 additions and 0 deletions
@@ -0,0 +1,95 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @since         5.0.0
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Cake\Datasource\Paging;
+
+use Countable;
+use Traversable;
+
+/**
+ * This interface describes the methods for pagination instance.
+ *
+ * @template TKey
+ * @template-covariant TValue
+ * @template-extends \Traversable<TKey, TValue>
+ * @method array<mixed> toArray() Get the paginated items as an array
+ */
+interface PaginatedInterface extends Countable, Traversable
+{
+    /**
+     * Get current page number.
+     *
+     * @return int
+     */
+    public function currentPage(): int;
+
+    /**
+     * Get items per page.
+     *
+     * @return int
+     */
+    public function perPage(): int;
+
+    /**
+     * Get Total items counts.
+     *
+     * @return int|null
+     */
+    public function totalCount(): ?int;
+
+    /**
+     * Get total page count.
+     *
+     * @return int|null
+     */
+    public function pageCount(): ?int;
+
+    /**
+     * Get whether there's a previous page.
+     *
+     * @return bool
+     */
+    public function hasPrevPage(): bool;
+
+    /**
+     * Get whether there's a next page.
+     *
+     * @return bool
+     */
+    public function hasNextPage(): bool;
+
+    /**
+     * Get paginated items.
+     *
+     * @return iterable<TKey, TValue>
+     */
+    public function items(): iterable;
+
+    /**
+     * Get paging param.
+     *
+     * @param string $name
+     * @return mixed
+     */
+    public function pagingParam(string $name): mixed;
+
+    /**
+     * Get all paging params.
+     *
+     * @return array
+     */
+    public function pagingParams(): array;
+}