Fix style and add config file to php-cs-fixer

controllers/internals/User.php

@@ -1,5 +1,16 @@
 <?php
-    namespace controllers\internals;
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace controllers\internals;
 
     class User extends \descartes\InternalController
     {
@@ -13,19 +24,24 @@
         }
 
         /**
-         * Return list of users as an array
+         * Return list of users as an array.
+         *
          * @param mixed(int|bool) $nb_entry : Number of entry to return
-         * @param mixed(int|bool) $page : Numero of page
+         * @param mixed(int|bool) $page     : Numero of page
+         *
          * @return array|bool : List of user or false
          */
         public function list(?int $nb_entry = null, ?int $page = null)
         {
             return $this->model_user->list($nb_entry, $page);
         }
-        
+
         /**
-         * Cette fonction va supprimer une liste de users
+         * Cette fonction va supprimer une liste de users.
+         *
          * @param array $ids : Les id des useres à supprimer
+         * @param mixed $id
+         *
          * @return int : Le nombre de useres supprimées;
          */
         public function delete($id)
@@ -34,19 +50,23 @@
         }
 
         /**
-         * Cette fonction vérifie s'il existe un utilisateur qui corresponde à ce couple login/password
-         * @param string $email : L'eamil de l'utilisateur
+         * Cette fonction vérifie s'il existe un utilisateur qui corresponde à ce couple login/password.
+         *
+         * @param string $email    : L'eamil de l'utilisateur
          * @param string $password : Le mot de passe de l'utilisateur
+         *
          * @return mixed false | array : False si pas de user, le user correspondant sous forme d'array sinon
          */
         public function check_credentials($email, $password)
         {
             $user = $this->model_user->get_by_email($email);
-            if (!$user) {
+            if (!$user)
+            {
                 return false;
             }
 
-            if (!password_verify($password, $user['password'])) {
+            if (!password_verify($password, $user['password']))
+            {
                 return false;
             }
 
@@ -54,32 +74,39 @@
         }
 
         /**
-         * Update a user password
-         * @param string $id : User id
+         * Update a user password.
+         *
+         * @param string $id       : User id
          * @param string $password : New password
+         *
          * @return bool;
          */
-        public function update_password(int $id, string $password) : bool
+        public function update_password(int $id, string $password): bool
         {
             $password = password_hash($password, PASSWORD_DEFAULT);
+
             return (bool) $this->model_user->update_password($id, $password);
         }
-        
+
         /**
-         * Update a user transfer property value
-         * @param string $id : User id
+         * Update a user transfer property value.
+         *
+         * @param string $id       : User id
          * @param string $transfer : New value of property transfer
+         *
          * @return boolean;
          */
-        public function update_transfer(int $id, int $transfer) : bool
+        public function update_transfer(int $id, int $transfer): bool
         {
             return (bool) $this->model_user->update_transfer($id, $transfer);
         }
-        
+
         /**
-         * Update user email
-         * @param string $id : user id
+         * Update user email.
+         *
+         * @param string $id    : user id
          * @param string $email : new mail
+         *
          * @return boolean;
          */
         public function update_email($id, $email)
@@ -88,8 +115,10 @@
         }
 
         /**
-         * Cette fonction retourne un utilisateur pour un mail donné
+         * Cette fonction retourne un utilisateur pour un mail donné.
+         *
          * @param string $email : L'email de l'utilisateur
+         *
          * @return mixed boolean | array : false si pas de user pour le mail, le user sinon
          */
         public function get_by_email($email)
@@ -98,7 +127,14 @@
         }
 
         /**
-         * Cette fonction met à jour une série de users
+         * Cette fonction met à jour une série de users.
+         *
+         * @param mixed $id
+         * @param mixed $email
+         * @param mixed $password
+         * @param mixed $admin
+         * @param mixed $transfer
+         *
          * @return int : le nombre de ligne modifiées
          */
         public function update($id, $email, $password, $admin, $transfer)
@@ -112,10 +148,16 @@
 
             return $this->model_user->update($id, $user);
         }
-        
+
         /**
-         * Cette fonction insert une nouvelle usere
-         * @param array $user : Un tableau représentant la usere à insérer
+         * Cette fonction insert une nouvelle usere.
+         *
+         * @param array $user     : Un tableau représentant la usere à insérer
+         * @param mixed $email
+         * @param mixed $password
+         * @param mixed $admin
+         * @param mixed $transfer
+         *
          * @return mixed bool|int : false si echec, sinon l'id de la nouvelle usere insérée
          */
         public function create($email, $password, $admin, $transfer = false)
@@ -129,12 +171,13 @@
 
             $result = $this->model_user->insert($user);
 
-            if (!$result) {
+            if (!$result)
+            {
                 return false;
             }
 
-            $this->internal_event->create('CONTACT_ADD', 'Ajout de l\'utilisateur : ' . $email . '.');
-            
+            $this->internal_event->create('CONTACT_ADD', 'Ajout de l\'utilisateur : '.$email.'.');
+
             return $result;
         }
     }