aboutsummaryrefslogtreecommitdiff
path: root/lib/Minz/Paginator.php
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2021-05-08 10:27:18 +0200
committerGravatar GitHub <noreply@github.com> 2021-05-08 10:27:18 +0200
commit607f7e725487ce0eb0339b288ce9e58036dad4a0 (patch)
tree5143afbcdcf15e22b70a93e1f4744cc85eea8517 /lib/Minz/Paginator.php
parent224b20edd16a6abd4879fe0e9e0f4c1608c9accf (diff)
Fix several comments syntaxes (#3615)
Mainly wrong `@return` types in comments
Diffstat (limited to 'lib/Minz/Paginator.php')
-rw-r--r--lib/Minz/Paginator.php24
1 files changed, 10 insertions, 14 deletions
diff --git a/lib/Minz/Paginator.php b/lib/Minz/Paginator.php
index ae506f1ae..7f5f0db8b 100644
--- a/lib/Minz/Paginator.php
+++ b/lib/Minz/Paginator.php
@@ -60,47 +60,43 @@ class Minz_Paginator {
/**
* Permet de retrouver la page d'un élément donné
* @param $item l'élément à retrouver
- * @return la page à laquelle se trouve l'élément (false si non trouvé)
+ * @return float|false la page à laquelle se trouve l’élément, false si non trouvé
*/
public function pageByItem ($item) {
- $page = false;
$i = 0;
do {
if ($item == $this->items[$i]) {
- $page = ceil (($i + 1) / $this->nbItemsPerPage);
+ return ceil(($i + 1) / $this->nbItemsPerPage);
}
-
$i++;
- } while (!$page && $i < $this->nbItems ());
+ } while ($i < $this->nbItems());
- return $page;
+ return false;
}
/**
* Permet de retrouver la position d'un élément donné (à partir de 0)
* @param $item l'élément à retrouver
- * @return la position à laquelle se trouve l'élément (false si non trouvé)
+ * @return float|false la position à laquelle se trouve l’élément, false si non trouvé
*/
public function positionByItem ($item) {
- $find = false;
$i = 0;
do {
if ($item == $this->items[$i]) {
- $find = true;
- } else {
- $i++;
+ return $i;
}
- } while (!$find && $i < $this->nbItems ());
+ $i++;
+ } while ($i < $this->nbItems ());
- return $i;
+ return false;
}
/**
* Permet de récupérer un item par sa position
* @param $pos la position de l'élément
- * @return l'item situé à $pos (dernier item si $pos<0, 1er si $pos>=count($items))
+ * @return mixed item situé à $pos (dernier item si $pos<0, 1er si $pos>=count($items))
*/
public function itemByPosition ($pos) {
if ($pos < 0) {