aboutsummaryrefslogtreecommitdiff
path: root/lib/Minz/Paginator.php
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2022-01-01 11:26:56 +0100
committerGravatar GitHub <noreply@github.com> 2022-01-01 11:26:56 +0100
commit3f6aa42b817145a3b00f4d615f87728b55c4413a (patch)
treee5b31941b0acc3a2f4c47e4846afcfe987b9852f /lib/Minz/Paginator.php
parent77e9877316fcfacb26799afdf32d94c8411da80e (diff)
Fix most PHPDocs errors (#4107)
Contributes to https://github.com/FreshRSS/FreshRSS/issues/4103 https://phpstan.org/writing-php-code/phpdoc-types
Diffstat (limited to 'lib/Minz/Paginator.php')
-rw-r--r--lib/Minz/Paginator.php27
1 files changed, 14 insertions, 13 deletions
diff --git a/lib/Minz/Paginator.php b/lib/Minz/Paginator.php
index 72eaafec1..7504bf4ce 100644
--- a/lib/Minz/Paginator.php
+++ b/lib/Minz/Paginator.php
@@ -9,33 +9,33 @@
*/
class Minz_Paginator {
/**
- * $items tableau des éléments à afficher/gérer
+ * @var array<Minz_Model> tableau des éléments à afficher/gérer
*/
private $items = array ();
/**
- * $nbItemsPerPage le nombre d'éléments par page
+ * @var int le nombre d'éléments par page
*/
private $nbItemsPerPage = 10;
/**
- * $currentPage page actuelle à gérer
+ * @var int page actuelle à gérer
*/
private $currentPage = 1;
/**
- * $nbPage le nombre de pages de pagination
+ * @var int le nombre de pages de pagination
*/
private $nbPage = 1;
/**
- * $nbItems le nombre d'éléments
+ * @var int le nombre d'éléments
*/
private $nbItems = 0;
/**
* Constructeur
- * @param $items les éléments à gérer
+ * @param array<Minz_Model> $items les éléments à gérer
*/
public function __construct ($items) {
$this->_items ($items);
@@ -46,11 +46,11 @@ class Minz_Paginator {
/**
* Permet d'afficher la pagination
- * @param $view nom du fichier de vue situé dans /app/views/helpers/
+ * @param string $view nom du fichier de vue situé dans /app/views/helpers/
* @param int $getteur variable de type $_GET[] permettant de retrouver la page
*/
public function render ($view, $getteur) {
- $view = APP_PATH . '/views/helpers/'.$view;
+ $view = APP_PATH . '/views/helpers/' . $view;
if (file_exists ($view)) {
include ($view);
@@ -59,7 +59,7 @@ class Minz_Paginator {
/**
* Permet de retrouver la page d'un élément donné
- * @param $item l'élément à retrouver
+ * @param Minz_Model $item l'élément à retrouver
* @return float|false la page à laquelle se trouve l’élément, false si non trouvé
*/
public function pageByItem ($item) {
@@ -77,7 +77,7 @@ class Minz_Paginator {
/**
* Permet de retrouver la position d'un élément donné (à partir de 0)
- * @param $item l'élément à retrouver
+ * @param Minz_Model $item l'élément à retrouver
* @return float|false la position à laquelle se trouve l’élément, false si non trouvé
*/
public function positionByItem ($item) {
@@ -95,7 +95,7 @@ class Minz_Paginator {
/**
* Permet de récupérer un item par sa position
- * @param $pos la position de l'élément
+ * @param int $pos la position de l'élément
* @return mixed item situé à $pos (dernier item si $pos<0, 1er si $pos>=count($items))
*/
public function itemByPosition ($pos) {
@@ -113,7 +113,8 @@ class Minz_Paginator {
* GETTEURS
*/
/**
- * @param $all si à true, retourne tous les éléments sans prendre en compte la pagination
+ * @param bool $all si à true, retourne tous les éléments sans prendre en compte la pagination
+ * @return array<Minz_Model>
*/
public function items ($all = false) {
$array = array ();
@@ -175,7 +176,7 @@ class Minz_Paginator {
$this->_nbPage ();
}
public function _currentPage ($page) {
- if($page < 1 || ($page > $this->nbPage && $this->nbPage > 0)) {
+ if ($page < 1 || ($page > $this->nbPage && $this->nbPage > 0)) {
throw new Minz_CurrentPagePaginationException($page);
}