- Indentation

- PhpDoc

composer.json

@@ -2,6 +2,7 @@
   "name": "nextdom/core",
   "description": "Software for home automation Open Source",
   "require": {
+    "ext-json": "*",
     "christian-riesen/base32": "^1.3",
     "doctrine/cache": "^1.6",
     "endroid/qr-code": "^2.5",

src/Managers/BackupManager.php

@@ -44,6 +44,9 @@
  */
 class BackupManager
 {
+    /**
+     * @var null
+     */
     private static $logLevel = null;
 
     /**
@@ -72,6 +75,7 @@ public static function backup(bool $background = false)
      *
      * @return bool true if no error
      * @throws CoreException
+     * @throws \Exception
      */
     public static function createBackup()
     {
@@ -315,13 +319,14 @@ public static function createBackupArchive(string $outputPath, $sqlPath, $cacheP
     }
 
     /**
-     * @param array $roots
+     * @param array  $roots
      * @param string $pattern
-     * @param Tar $tar
-     * @param $logFile
+     * @param Tar    $tar
+     * @param        $logFile
      * @throws \splitbrain\PHPArchive\ArchiveCorruptedException
      * @throws \splitbrain\PHPArchive\ArchiveIOException
      * @throws \splitbrain\PHPArchive\FileInfoException
+     * @throws \Exception
      */
     private static function addPathToArchive($roots, $pattern, $tar, $logFile)
     {
@@ -609,6 +614,7 @@ private static function extractArchive($file)
      *
      * @param string $tmpDir extracted backup root directory
      * @throws CoreException
+     * @throws \Exception
      */
     private static function restorePlugins($tmpDir)
     {
@@ -643,6 +649,7 @@ private static function restorePlugins($tmpDir)
      *
      * @param $folderRoot
      * @throws CoreException on permission error
+     * @throws \Exception
      */
     private static function restorePublicPerms($folderRoot)
     {
@@ -855,9 +862,9 @@ private static function clearCache()
     }
 
     /**
-     * Obtenir la liste des sauvegardes
+     * Get the list of backups
      *
-     * @return array Liste des sauvegardes
+     * @return array list of backups
      * @throws \Exception
      */
     public static function listBackup(): array
@@ -879,6 +886,7 @@ public static function listBackup(): array
      * @param string $backupFilePath Backup file path
      *
      * @throws CoreException
+     * @throws \Exception
      */
     public static function removeBackup(string $backupFilePath)
     {

src/Managers/CacheManager.php

@@ -102,7 +102,7 @@ public static function stats($details = false)
                     $result['count']++;
                 }
             }
-        } else if ($engine == CacheEngine::REDIS) {
+        } elseif ($engine == CacheEngine::REDIS) {
             $result['count'] = self::$cacheSystem->getRedis()->dbSize();
         }
         if ($details) {

src/Managers/ConfigManager.php

@@ -407,10 +407,18 @@ public static function preConfig_market_password($newValue)
         return $newValue;
     }
 
+    /**
+     * @param $_value
+     * @return string|string[]
+     */
     public static function preConfig_info_latitude($_value){
         return str_replace(',','.',$_value);
     }
 
+    /**
+     * @param $_value
+     * @return string|string[]
+     */
     public static function preConfig_info_longitude($_value){
         return str_replace(',','.',$_value);
     }

src/Managers/ConsistencyManager.php

@@ -43,6 +43,9 @@
  */
 class ConsistencyManager
 {
+    /**
+     * @var array 
+     */
     private static $defaultSummary = [
         'security' => ['key' => 'security', 'name' => 'Alerte', 'calcul' => 'sum', 'icon' => '<i class="icon nextdom-alerte2"></i>', 'unit' => '', 'count' => 'binary', 'allowDisplayZero' => false],
         'motion' => ['key' => 'motion', 'name' => 'Mouvement', 'calcul' => 'sum', 'icon' => '<i class="icon nextdom-mouvement"></i>', 'unit' => '', 'count' => 'binary', 'allowDisplayZero' => false],
@@ -130,11 +133,11 @@ private static function checkAllDefaultCrons()
                     if (false == is_object($cron)) {
                         $cron = new Cron();
                     }
-                    $cron->setClass($cronClass);
-                    $cron->setFunction($cronName);
-                    $cron->setSchedule($cronConfig["schedule"]);
-                    $cron->setTimeout($cronConfig["timeout"]);
-                    $cron->setDeamon(0);
+                    $cron->setClass($cronClass)
+                         ->setFunction($cronName)
+                         ->setSchedule($cronConfig["schedule"])
+                         ->setTimeout($cronConfig["timeout"])
+                         ->setDeamon(0);
                     if (true == array_key_exists("enabled", $cronConfig)) {
                         $cron->setEnable($cronConfig["enabled"]);
                     }
@@ -148,7 +151,7 @@ private static function checkAllDefaultCrons()
     /**
      * @return array
      */
-    public static function getDefaultCrons()
+    public static function getDefaultCrons(): array
     {
         return [
             "nextdom" => [
@@ -249,6 +252,9 @@ public static function getDefaultCrons()
         ];
     }
 
+    /**
+     * @throws \Exception
+     */
     private static function cleanWidgetCache()
     {
         foreach (EqLogicManager::all() as $c_item) {
@@ -269,6 +275,9 @@ private static function saveObjects()
         }
     }
 
+    /**
+     * @throws \Exception
+     */
     private static function resetCommandsActionID()
     {
         foreach (CmdManager::all() as $c_cmd) {

src/Managers/CronManager.php

@@ -107,12 +107,13 @@ public static function searchClassAndFunction($className, $functionName, $option
 
     /**
      * Clean cron that will never run
+     * @throws \Exception
      */
     public static function clean()
     {
         $crons = self::all();
         foreach ($crons as $cron) {
-            $cronExpression = new \Cron\CronExpression($cron->getSchedule(), new \Cron\FieldFactory);
+            $cronExpression = new \Cron\CronExpression($cron->getSchedule(), new \Cron\FieldFactory());
             try {
                 if (!$cronExpression->isDue()) {
                     $cronExpression->getNextRunDate();
@@ -176,6 +177,7 @@ public static function loadAvg()
 
     /**
      * Write jeeCron PID of current process
+     * @throws \Exception
      */
     public static function setPidFile()
     {
@@ -203,7 +205,7 @@ public static function jeeCronRun()
     /**
      * Return the current pid of jeecron or empty if not running
      *
-     * @return int Current jeeCron PID
+     * @return false|string Current jeeCron PID
      * @throws \Exception
      */
     public static function getPidFile()
@@ -234,7 +236,7 @@ public static function convertDateToCron($dateToConvert)
      * @return string
      * @throws \Exception
      */
-    public static function convertCronSchedule($cron)
+    public static function convertCronSchedule(string $cron)
     {
         $return = str_replace('*/ ', '* ', $cron);
         preg_match_all('/([0-9]*\/\*)/m', $return, $matches, PREG_SET_ORDER, 0);

src/Managers/EqLogicManager.php

@@ -367,6 +367,7 @@ public static function allType()
 
     /**
      * Vérifier si un objet est actif
+     * @throws \Exception
      */
     public static function checkAlive()
     {
@@ -426,6 +427,7 @@ public static function byTimeout($timeout = 0, $onlyEnable = false)
      * @param $input
      * @return array|mixed
      * @throws \ReflectionException
+     * @throws CoreException
      */
     public static function toHumanReadable($input)
     {
@@ -467,6 +469,7 @@ public static function toHumanReadable($input)
 
     /**
      * @TODO: ???
+     * @throws \Exception
      */
     public static function clearCacheWidget()
     {

src/Managers/EventManager.php

@@ -100,8 +100,8 @@ public static function add($eventCode, $eventOptions = [])
     /**
      * Add multiple events in cache
      *
-     * @param string $eventName
-     * @param array $values
+     * @param       $eventCode
+     * @param array $eventOptions
      * @throws \Exception
      */
     public static function adds($eventCode, $eventOptions = [])
@@ -126,7 +126,7 @@ public static function adds($eventCode, $eventOptions = [])
     /**
      * Clean events
      *
-     * @param $events
+     * @param $_events
      * @return array
      */
     public static function cleanEvent($_events)
@@ -274,4 +274,4 @@ private static function changesSince($_datetime)
         $result[Common::RESULT] = array_reverse($result[Common::RESULT]);
         return $result;
     }
-}
+}

src/Managers/InteractDefManager.php

@@ -107,6 +107,10 @@ public static function searchByQuery($_query)
         return static::searchMultipleByClauses($clauses);
     }
 
+    /**
+     * @throws \NextDom\Exceptions\CoreException
+     * @throws \ReflectionException
+     */
     public static function regenerateInteract()
     {
         foreach (self::all() as $interactDef) {

src/Managers/JeeObjectManager.php

@@ -123,6 +123,11 @@ public static function getRootObjects($all = false, $onlyVisible = false)
         return DBHelper::Prepare($sql, [], $fetchType, \PDO::FETCH_CLASS, self::CLASS_NAME);
     }
 
+    /**
+     * @param User $user
+     * @return array|mixed|null
+     * @throws CoreException
+     */
     public static function getDefaultUserRoom(User $user)
     {
         $rootRoomId = $user->getOptions('defaultDashboardObject');
@@ -196,6 +201,13 @@ public static function all($onlyVisible = false)
         return static::getMultipleByClauses($clauses, ['position', 'name', 'father_id']);
     }
 
+    /**
+     * @param $father_id
+     * @param $onlyVisible
+     * @return mixed|null
+     * @throws CoreException
+     * @throws \ReflectionException
+     */
     public static function getChildren($father_id, $onlyVisible)
     {
         $clauses = ['father_id' => $father_id];

src/Managers/Parents/CastedObjectManager.php

@@ -57,8 +57,13 @@ abstract static function cast($castType);
         byId as baseById;
     }
 
+    /**
+     * @param $requestedId
+     * @return mixed
+     * @throws CoreException
+     */
     public static function byId($requestedId) {
 
         return static::cast(static::baseById($requestedId));
     }
-}
+}

src/Managers/Parents/CommonManager.php

@@ -52,11 +52,10 @@ trait CommonManager
      * @return mixed
      *
      * @throws CoreException
-     * @throws \ReflectionException
      */
     public static function byId($requestedId)
     {
-        if (empty($requestedId)) {
+        if (empty($requestedId) === true) {
             return null;
         }
         $params = ['id' => $requestedId];
@@ -70,7 +69,6 @@ public static function byId($requestedId)
      * @return mixed|null
      *
      * @throws CoreException
-     * @throws \ReflectionException
      */
     protected static function getAll()
     {
@@ -87,7 +85,6 @@ protected static function getAll()
      * @return mixed|null
      *
      * @throws CoreException
-     * @throws \ReflectionException
      */
     protected static function getAllOrdered(string $orderColumn, bool $reverseOrder = false, int $limit = 0)
     {
@@ -181,10 +178,9 @@ protected static function searchMultipleByClauses(array $clauses, $orderColumn =
      */
     private static function query(array $clauses, $compOperator = '', bool $onlyOneResult = false, $orderColumn = '', bool $reverseOrder = false) {
         $sql = static::createSQL($clauses, $compOperator, $orderColumn, $reverseOrder);
-        if ($onlyOneResult) {
+        if ($onlyOneResult === true) {
             return DBHelper::getOneObject($sql, $clauses, static::CLASS_NAME);
-        }
-        else {
+        } else {
             return DBHelper::getAllObjects($sql, $clauses, static::CLASS_NAME);
         }
     }
@@ -199,7 +195,6 @@ private static function query(array $clauses, $compOperator = '', bool $onlyOneR
      *
      * @return string
      *
-     * @throws \ReflectionException
      */
     private static function createSQL(array $clauses, string $compOperator, $orderColumn = '', bool $reverseOrder = false)
     {
@@ -209,17 +204,15 @@ private static function createSQL(array $clauses, string $compOperator, $orderCo
         foreach ($clauses as $clauseName => $clauseValue) {
             if ($sqlClauses === '') {
                 $sqlClauses = "WHERE ";
-            }
-            else {
+            } else {
                 $sqlClauses .= "AND ";
             }
             $sqlClauses .= "`$clauseName` $compOperator :$clauseName ";
         }
         if ($orderColumn !== '') {
             if (is_array($orderColumn)) {
                 $sqlOrder = "ORDER BY `" . implode("`, `", $orderColumn) . "`";
-            }
-            else {
+            } else {
                 $sqlOrder = "ORDER BY `$orderColumn`";
             }
             if ($reverseOrder) {
@@ -228,4 +221,4 @@ private static function createSQL(array $clauses, string $compOperator, $orderCo
         }
         return $sql . $sqlClauses . $sqlOrder;
     }
-}
+}

src/core.php

@@ -78,9 +78,10 @@
      *
      * @param string $className Name of the class
      *
+     * @throws CoreException
      * @throws Exception
      */
-    function nextdomPluginAutoload($className)
+    function nextdomPluginAutoload(string $className)
     {
         global $ENABLED_PLUGINS;
         if ($ENABLED_PLUGINS === null) {