modernisation code

FossilOrigin-Name: 3f69a7f4de9baf3dec9ba1b83b2affdfaaa5337c424d31a5298dfc39913e1cd7

lib/Utils.php

@@ -9,9 +9,9 @@ class Utils
 {
     /**
      * @return tarifs demandés
-     * @param array $tarifs
+     * @param $tarifs
      */
-    public static function getTarifs($tarifs)
+    public static function getTarifs(array $tarifs) : array
     {
         $db = DB::getInstance();
         $sql = sprintf(
@@ -24,9 +24,9 @@ class Utils
 
     /**
      * @return activités correspondant aux tarifs demandés
-     * @param array $tarifs
+     * @param $tarifs
      */
-    public static function getActivites($tarifs)
+    public static function getActivites(array $tarifs) : array
     {
         $db = DB::getInstance();
         $sql = sprintf(
@@ -42,9 +42,9 @@ class Utils
     /**
      * @return versements correspondants à l'année donnée
      * @param $annee
-     * @param array $champsNom : liste non vide des champs de nom/prénom
+     * @param $champsNom : liste non vide des champs de nom/prénom
      */
-    public static function getVersementsPersonnes($annee, $champsNom)
+    public static function getVersementsPersonnes($annee, array $champsNom) : array
     {
         $db = DB::getInstance();
         $tri = Utils::combinerTri($champsNom);
@@ -74,10 +74,12 @@ class Utils
      * @return versements correspondants à l'année et aux tarifs donnés
      *         triés par tarif, nom, date
      * @param $annee
-     * @param array $tarifs
-     * @param array $champsNom : liste non vide des champs de nom/prénom
+     * @param $tarifs
+     * @param $champsNom : liste non vide des champs de nom/prénom
      */
-    public static function getVersementsTarifs($annee, $tarifs, $champsNom)
+    public static function getVersementsTarifs($annee,
+                                               array $tarifs,
+                                               array $champsNom) : array
     {
         $db = DB::getInstance();
         $tri = Utils::combinerTri($champsNom);
@@ -111,10 +113,12 @@ class Utils
     /**
      * @return versements correspondants à l'année et aux comptes donnés
      * @param $annee
-     * @param array $comptes
-     * @param array $champsNom : liste non vide des champs de nom/prénom
+     * @param $comptes
+     * @param $champsNom : liste non vide des champs de nom/prénom
      */
-    public static function getVersementsComptes($annee, $comptes, $champsNom)
+    public static function getVersementsComptes($annee,
+                                                array $comptes,
+                                                array $champsNom) : array
     {
         $db = DB::getInstance();
         $tri = Utils::combinerTri($champsNom);
@@ -147,9 +151,9 @@ class Utils
     /**
      * Versements totaux par personne pour une année donnée
      * @param année
-     * @param array $champsNom : liste non vide des champs de nom/prénom
+     * @param $champsNom : liste non vide des champs de nom/prénom
      */
-    public static function getVersementsTotaux($annee, $champsNom)
+    public static function getVersementsTotaux($annee, array $champsNom) : array
     {
         $tri = Utils::combinerTri($champsNom);
         $sql = sprintf(
@@ -181,10 +185,10 @@ class Utils
 
     /**
      * combiner les champs avec un opérateur
-     * @param array $champs : liste (non vide) de champs
+     * @param $champs : liste (non vide) de champs
      * @return chaîne combinée
      */
-    private static function combinerChamps($champs)
+    private static function combinerChamps(array $champs) : string
     {
         $op = ' || " " || ';
         $result = 'ifnull(membres.' . $champs[0] . ', "")';
@@ -195,7 +199,12 @@ class Utils
         return $result;
     }
 
-    private static function combinerTri($champs)
+    /**
+     * combiner les clés de tri
+     * @param clés de tri
+     * @return chaîne combinée
+     */
+    private static function combinerTri(array $champs) : string
     {
         $tri = 'membres.' . $champs[0];
         for ($i = 1; $i < count($champs); ++$i)
@@ -208,9 +217,9 @@ class Utils
     /**
      * @return personnes ayant versé des dons pour une année donnée
      * @param $annee
-     * @param array $champsNom : champs qui définissent le nom et le prénom d'une personne
+     * @param $champsNom : champs qui définissent le nom et le prénom d'une personne
      */
-    public static function getDonateurs($annee, $champsNom) : array
+    public static function getDonateurs($annee, array $champsNom) : array
     {
         // concaténer les champs nom/prénoms pour la sélection
         $nom = 'trim(' . Utils::combinerChamps($champsNom) . ') as nom,';
@@ -254,7 +263,10 @@ class Utils
         return $donateurs;
     }
 
-    public static function getLignesReduction($lesTaux)
+    /**
+     * renvoie un tableau avec les remarques de chaque taux de réduction
+     */
+    public static function getLignesReduction(array $lesTaux) : array
     {
         foreach ($lesTaux as $elem)
         {
@@ -269,13 +281,14 @@ class Utils
         }
         return $lignes;
     }
+
     public static function getLigneReduction($taux)
     {
         return $_SESSION['ligneReduction'][$taux];
     }
 
     /**
-     * @return liste de toutes les activités, tarifs et comptes associés
+     * @return array liste de toutes les activités, tarifs et comptes associés
      */
     public static function getActivitesTarifsEtComptes()
     {
@@ -297,7 +310,7 @@ class Utils
     }
 
     /**
-     * @return liste des années fiscales
+     * @return array liste des années fiscales
      */
     public static function getAnneesFiscales() : array
     {
@@ -317,7 +330,7 @@ class Utils
      * récupérer dans la config du plugin les champs des membres
      * utilisés pour le nom et le prénom ; ajouter/supprimer les
      * modifications par rapport à la config garradin
-     * @return tableau des champs : clé = nom, valeur = { titre, position }
+     * @return array tableau des champs : clé = nom, valeur = { titre, position }
      */
     public static function getChampsNom($config, $plugin) : array
     {