bfw-systems / bfw

src/class/Application.php

Doc Comments +3 added lines

@@ -51,6 +51,9 @@
         return $this->composerLoader;
     }
     
+    /**
+     * @param string $configKey
+     */
     public function getConfig($configKey)
     {
         return $this->config->getConfig($configKey);

Spacing +17 added lines, -17 removed lines

@@ -39,7 +39,7 @@ 
     
     public static function getInstance($options = [])
     {
-        if(self::$instance === null) {
+        if (self::$instance === null) {
             self::$instance = new self($options);
         }
         
@@ -112,7 +112,7 @@ 
     
     protected function initSession()
     {
-        if($this->options->getOption('runSession') === false) {
+        if ($this->options->getOption('runSession') === false) {
             return;
         }
         
@@ -153,11 +153,11 @@ 
     
     public function run()
     {
-        foreach($this->runPhases as $action) {
+        foreach ($this->runPhases as $action) {
             $action();
             
             $notifyAction = $action;
-            if(is_array($action)) {
+            if (is_array($action)) {
                 $notifyAction = $action[1];
             }
             
@@ -171,16 +171,16 @@ 
     {
         $memcacheConfig = $this->getConfig('memcached');
         
-        if($memcacheConfig['enabled'] === false) {
+        if ($memcacheConfig['enabled'] === false) {
             return;
         }
         
         $class = $memcacheConfig['class'];
-        if(empty($class)) {
+        if (empty($class)) {
             throw new Exception('Memcached is active but no class is define');
         }
         
-        if(class_exists($class) === false) {
+        if (class_exists($class) === false) {
             throw new Exception('Memcache class '.$class.' not found.');
         }
         
@@ -191,10 +191,10 @@ 
     {
         $listModules = array_diff(scandir(MODULES_DIR), ['.', '..']);
         
-        foreach($listModules as $moduleName) {
+        foreach ($listModules as $moduleName) {
             $moduleName = realpath($moduleName); //Symlink
             
-            if(!is_dir($moduleName)) {
+            if (!is_dir($moduleName)) {
                 continue;
             }
             
@@ -206,11 +206,11 @@ 
     
     protected function loadAllCoreModules()
     {
-        foreach($this->getConfig('modules') as $moduleInfos) {
+        foreach ($this->getConfig('modules') as $moduleInfos) {
             $moduleName    = $moduleInfos['name'];
             $moduleEnabled = $moduleInfos['enabled'];
             
-            if(empty($moduleName) || $moduleEnabled === false) {
+            if (empty($moduleName) || $moduleEnabled === false) {
                 continue;
             }
             
@@ -222,11 +222,11 @@ 
     {
         $tree = $this->modules->getLoadTree();
         
-        foreach($tree as $firstLine)
+        foreach ($tree as $firstLine)
         {
-            foreach($firstLine as $secondLine)
+            foreach ($firstLine as $secondLine)
             {
-                foreach($secondLine as $moduleName)
+                foreach ($secondLine as $moduleName)
                 {
                     $this->loadModule($moduleName);
                 }
@@ -242,17 +242,17 @@ 
     
     protected function runCliFile()
     {
-        if(PHP_SAPI !== 'cli') {
+        if (PHP_SAPI !== 'cli') {
             return;
         }
         
         $opt = getopt('f:');
-        if(!isset($opt['f'])) {
+        if (!isset($opt['f'])) {
             throw new Exception('Error: No file specified.');
         }
         
         $file = $opt['f'];
-        if(!file_exists(CLI_DIR.$file.'.php')) {
+        if (!file_exists(CLI_DIR.$file.'.php')) {
             throw new Exception('File to execute not found.');
         }
         

src/class/Form.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
         $this->formId = $formId;
     }
     
+    /**
+     * @param stdClass $saveInfos
+     */
     protected function saveToken($saveInfos)
     {
         //Default to session

Spacing +6 added lines, -6 removed lines

@@ -38,11 +38,11 @@ 
     {
         global $_SESSION;
         
-        if(!isset($_SESSION['token'])) {
+        if (!isset($_SESSION['token'])) {
             throw new Exception('no token found');
         }
         
-        if(!isset($_SESSION['token'][$this->formId])) {
+        if (!isset($_SESSION['token'][$this->formId])) {
             throw new Exception('no token found for form id '.$this->formId);
         }
         
@@ -51,7 +51,7 @@ 
     
     public function createToken()
     {
-        if(is_null($this->idForm)) {
+        if (is_null($this->idForm)) {
             throw new Exception('Form id is undefined.');
         }
         
@@ -66,7 +66,7 @@ 
         return $token;
     }
     
-    public function checkToken($tokenToCheck, $timeExp=15)
+    public function checkToken($tokenToCheck, $timeExp = 15)
     {
         //Throw Exception
         $tokenInfos = $this->getToken();
@@ -74,14 +74,14 @@ 
         $token      = $tokenInfos->token;
         $dateCreate = $tokenInfos->date;
         
-        if($token !== $tokenToCheck) {
+        if ($token !== $tokenToCheck) {
             return false;
         }
         
         $limitDate = new DateTime;
         $limitDate->modify('-'.(int) $timeExp.' minutes');
 
-        if($dateCreate < $limitDate) {
+        if ($dateCreate < $limitDate) {
             return false;
         }
         

src/class/Module.php

Doc Comments +6 added lines

@@ -28,6 +28,9 @@ 
         $this->status->load = true;
     }
     
+    /**
+     * @param string $pathName
+     */
     public static function installInfos($pathName)
     {
         $this->loadModulesInstallInfos();
@@ -94,6 +97,9 @@ 
         );
     }
     
+    /**
+     * @param string $jsonFilePath
+     */
     protected function loadJsonFile($jsonFilePath)
     {
         if(!file_exists($jsonFilePath)) {

Spacing +6 added lines, -6 removed lines

@@ -71,7 +71,7 @@ 
     
     protected function loadConfig()
     {
-        if(!file_exists(CONFIG_DIR.$this->pathName)) {
+        if (!file_exists(CONFIG_DIR.$this->pathName)) {
             return;
         }
         
@@ -96,12 +96,12 @@ 
     
     protected function loadJsonFile($jsonFilePath)
     {
-        if(!file_exists($jsonFilePath)) {
+        if (!file_exists($jsonFilePath)) {
             throw new Exception('File '.$jsonFilePath.' not found.');
         }
         
         $infos = json_decode(file_get_contents($jsonFilePath));
-        if($infos === null) {
+        if ($infos === null) {
             throw new Exception(json_last_error_msg());
         }
         
@@ -113,11 +113,11 @@ 
         $moduleInfos = $this->loadInfos;
         $runnerFile  = '';
         
-        if(property_exists($moduleInfos, 'runner')) {
+        if (property_exists($moduleInfos, 'runner')) {
             $runnerFile = (string) $moduleInfos->runner;
         }
         
-        if($runnerFile === '') {
+        if ($runnerFile === '') {
             return;
         }
         
@@ -126,7 +126,7 @@ 
             .'/'.$runnerFile
         ;
         
-        if(!file_exists($runnerFile)) {
+        if (!file_exists($runnerFile)) {
             throw new Exception(
                 'Runner file for module '.$this->pathName.' not found.'
             );

src/fonctions/global.php

Doc Comments +1 added lines, -1 removed lines

@@ -133,7 +133,7 @@
  * Permet de rediriger une page
  * 
  * @param string $page    : la page vers laquelle rediriger
- * @param bool   $permaet : If it's a permanent redirection for this url or not
+ * @param bool   $permanent : If it's a permanent redirection for this url or not
  */
 function redirection($page, $permanent=false)
 {

Spacing +25 added lines, -25 removed lines

@@ -27,21 +27,21 @@ 
     //--- Gestion de type de data ---
     $filterType = 'text';
 
-    if($type === 'int' || $type === 'integer') {
+    if ($type === 'int' || $type === 'integer') {
         $filterType = FILTER_VALIDATE_INT;
     }
-    elseif($type === 'float' || $type === 'double') {
+    elseif ($type === 'float' || $type === 'double') {
         $filterType = FILTER_VALIDATE_FLOAT;
     }
-    elseif($type === 'bool' || $type === 'boolean') {
+    elseif ($type === 'bool' || $type === 'boolean') {
         $filterType = FILTER_VALIDATE_BOOLEAN;
     }
-    elseif($type === 'email') {
+    elseif ($type === 'email') {
         $filterType = FILTER_VALIDATE_EMAIL;
     }
     //--- FIN Gestion de type de data ---
 
-    if($filterType === 'text') {
+    if ($filterType === 'text') {
         throw new Exception('Unknown type');
     }
 
@@ -50,8 +50,8 @@ 
 
 function securise($data, $type, $htmlentities)
 {
-    if(is_array($data)) {
-        foreach($data as $key => $val) {
+    if (is_array($data)) {
+        foreach ($data as $key => $val) {
             unset($data[$key]);
 
             $key = securise($key, true);
@@ -66,21 +66,21 @@ 
     try {
         return securiseKnownTypes($data, $type);
     }
-    catch(Exception $ex) {
-        if($ex->getMessage() !== 'Unknown type') {
+    catch (Exception $ex) {
+        if ($ex->getMessage() !== 'Unknown type') {
             throw new Exception($ex->getCode(), $ex->getMessage());
         }
         //Else : Use securise text type
     }
     
     $sqlSecureMethod = getSqlSecureMethod();
-    if($sqlSecureMethod !== false) {
+    if ($sqlSecureMethod !== false) {
         $data = $sqlSecureMethod($data);
     } else {
         $data = addslashes($data);
     }
 
-    if($htmlentities === false) {
+    if ($htmlentities === false) {
         $data = htmlentities($data, ENT_COMPAT | ENT_HTML401, 'UTF-8');
     }
 
@@ -93,7 +93,7 @@ 
     $fct = $app->getConfig('sqlSecureMethod');
 
     $callableName = '';
-    if(!is_callable($fct, true, $callableName)) {
+    if (!is_callable($fct, true, $callableName)) {
         return false;
     }
 
@@ -135,10 +135,10 @@ 
  * @param string $page    : la page vers laquelle rediriger
  * @param bool   $permaet : If it's a permanent redirection for this url or not
  */
-function redirection($page, $permanent=false)
+function redirection($page, $permanent = false)
 {
     $httpStatus = 302;
-    if($permanent === true) {
+    if ($permanent === true) {
         $httpStatus = 301;
     }
     
@@ -149,7 +149,7 @@ 
 
 function getSecurisedKeyInArray(&$array, $key, $type, $htmlentities = false)
 {
-    if(!isset($array[$key])) {
+    if (!isset($array[$key])) {
         throw new Exception('The key '.$key.' not exist');
     }
     
@@ -188,32 +188,32 @@ 
  */
 function verifTypeData($vars)
 {
-    if(!is_array($vars)) {
+    if (!is_array($vars)) {
         return false;
     }
 
-    foreach($vars as $var) {
-        if(!is_array($var)) {
+    foreach ($vars as $var) {
+        if (!is_array($var)) {
             return false;
         }
 
-        if(!(!empty($var['type']) && isset($var['data']))) {
+        if (!(!empty($var['type']) && isset($var['data']))) {
             return false;
         }
 
-        if(!is_string($var['type'])) {
+        if (!is_string($var['type'])) {
             return false;
         }
 
-        if($var['type'] === 'int') {
+        if ($var['type'] === 'int') {
             $var['type'] = 'integer';
         }
 
-        if($var['type'] === 'float') {
+        if ($var['type'] === 'float') {
             $var['type'] = 'double';
         }
 
-        if(gettype($var['data']) !== $var['type']) {
+        if (gettype($var['data']) !== $var['type']) {
             return false;
         }
     }
@@ -240,11 +240,11 @@ 
  */
 function sessionIsStarted()
 {
-    if(PHP_SAPI === 'cli') {
+    if (PHP_SAPI === 'cli') {
         return false;
     }
 
-    if(session_status() === PHP_SESSION_ACTIVE) {
+    if (session_status() === PHP_SESSION_ACTIVE) {
         return true;
     }
 

Braces +4 added lines, -8 removed lines

@@ -29,14 +29,11 @@ 
 
     if($type === 'int' || $type === 'integer') {
         $filterType = FILTER_VALIDATE_INT;
-    }
-    elseif($type === 'float' || $type === 'double') {
+    } elseif($type === 'float' || $type === 'double') {
         $filterType = FILTER_VALIDATE_FLOAT;
-    }
-    elseif($type === 'bool' || $type === 'boolean') {
+    } elseif($type === 'bool' || $type === 'boolean') {
         $filterType = FILTER_VALIDATE_BOOLEAN;
-    }
-    elseif($type === 'email') {
+    } elseif($type === 'email') {
         $filterType = FILTER_VALIDATE_EMAIL;
     }
     //--- FIN Gestion de type de data ---
@@ -65,8 +62,7 @@ 
     
     try {
         return securiseKnownTypes($data, $type);
-    }
-    catch(Exception $ex) {
+    } catch(Exception $ex) {
         if($ex->getMessage() !== 'Unknown type') {
             throw new Exception($ex->getCode(), $ex->getMessage());
         }

src/traits/memcache.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
      * 
      * @throws \Exception Erreur dsans les paramètres donnée à la méthode
      * 
-     * @return boolean|null
+     * @return boolean
      */
     public function majExpire($key, $expire)
     {

Spacing +4 added lines, -4 removed lines

@@ -17,11 +17,11 @@ 
     public function ifExists($key)
     {
         $verifParams = verifTypeData([['type' => 'string', 'data' => $key]]);
-        if(!$verifParams) {
+        if (!$verifParams) {
             throw new \Exception('The $key parameters must be a string');
         }
 
-        if($this->get($key) === false) {
+        if ($this->get($key) === false) {
             return false;
         }
 
@@ -45,7 +45,7 @@ 
             ['type' => 'int', 'data' => $expire]
         ]);
 
-        if(!$verifParams) {
+        if (!$verifParams) {
             throw new \Exception(
                 'Once of parameters $key or $expire not have a correct type.'
             );
@@ -55,7 +55,7 @@ 
         
         //On la "modifie" en remettant la même valeur mais en changeant le temps
         //avant expiration si une valeur a été retournée
-        if($value !== false && $this->replace($key, $value, 0, $expire)) {
+        if ($value !== false && $this->replace($key, $value, 0, $expire)) {
             return true;
         }
 

install/class/ReadDirectory.php

Spacing +6 added lines, -6 removed lines

@@ -32,22 +32,22 @@ 
     public function run($path)
     {
         $dir = opendir($path);
-        if($dir === false) {
+        if ($dir === false) {
             return;
         }
 
         //Tant qu'il y a des fichiers à lire dans le dossier
-        while(($file = readdir($dir)) !== false) {
+        while (($file = readdir($dir)) !== false) {
             $action = $this->fileAction($file, $dir);
 
-            if($action === 'continue') {
+            if ($action === 'continue') {
                 continue;
-            } elseif($action === 'break') {
+            } elseif ($action === 'break') {
                 break;
             }
 
             //If it's a directory and not a file
-            if(is_dir($dir.'/'.$file)) {
+            if (is_dir($dir.'/'.$file)) {
                 //We run the reading of this directory
                 $read = new readDirectory($this->list);
                 $read->run($dir.'/'.$file);
@@ -59,7 +59,7 @@ 
 
     protected function fileAction($fileName, $pathToFile)
     {
-        if(in_array($fileName, $this->ignore)) {
+        if (in_array($fileName, $this->ignore)) {
             return 'continue';
         }
     }

install/class/ReadDirLoadModule.php

Spacing +2 added lines, -2 removed lines

@@ -8,11 +8,11 @@
     {
         $parentAction = parent::fileAction($fileName, $pathToFile);
         
-        if($parentAction !== '') {
+        if ($parentAction !== '') {
             return $parentAction;
         }
         
-        if(file_exists($pathToFile.'/bfwModulesInfos.json')) {
+        if (file_exists($pathToFile.'/bfwModulesInfos.json')) {
             $this->itemList[] = $pathToFile;
             
             return 'break';

install/class/ModuleInstall.php

Spacing +20 added lines, -20 removed lines

@@ -103,15 +103,15 @@ 
         $this->srcPath    = $infos->srcPath;
         $this->configPath = $infos->srcPath;
 
-        if(property_exists($infos, 'configFiles')) {
+        if (property_exists($infos, 'configFiles')) {
             $this->configFiles = (array) $infos->configFiles;
         }
 
-        if(property_exists($infos, 'configPath')) {
+        if (property_exists($infos, 'configPath')) {
             $this->configPath = $infos->configPath;
         }
         
-        if(property_exists($infos, 'installScript')) {
+        if (property_exists($infos, 'installScript')) {
             $this->installScript = $infos->installScript;
         }
         
@@ -154,24 +154,24 @@ 
         $targetPath     = $this->bfwModulePath;
         $alreadyCreated = file_exists($targetPath);
         
-        if($alreadyCreated && $this->forceReinstall === true) {
+        if ($alreadyCreated && $this->forceReinstall === true) {
             echo '[Force Reinstall: Remove symlink] ';
             $alreadyCreated = false;
             
-            if(!unlink($targetPath)) {
+            if (!unlink($targetPath)) {
                 echo "\033[1;31m Symbolic link remove fail.\033[0m\n";
                 throw new Exception('Reinstall fail. Symlink remove error');
             }
         }
         
         //If module already exist in "modules" directory
-        if($alreadyCreated) {
+        if ($alreadyCreated) {
             echo "\033[1;33m Not created. Module already exist in 'modules' directory.\033[0m\n";
             return;
         }
 
         //If symbolic link create fail.
-        if(!symlink($this->srcPath, $targetPath))
+        if (!symlink($this->srcPath, $targetPath))
         {
             echo "...\033[1;31m Symbolic link creation fail.\033[0m\n";
             return;
@@ -190,20 +190,20 @@ 
     {
         echo ' > Copy config files : '."\n";
         
-        if($this->configFiles === []) {
+        if ($this->configFiles === []) {
             echo ' >> '."\033[1;33m".'No config file declared. Pass'."\033[0m\n";
             return;
         }
         
         $configDirStatus = $this->createConfigDirectory();
-        if($configDirStatus === false) {
+        if ($configDirStatus === false) {
             return;
         }
         
-        foreach($this->configFiles as $configFile) {
+        foreach ($this->configFiles as $configFile) {
             try {
                 $this->copyConfigFile($configFile);
-            } catch(Exception $e) {
+            } catch (Exception $e) {
                 trigger_error(
                     'Module '.$this->name.' Config file '.$configFile.' copy error: '.$e->getMessage(),
                     E_USER_WARNING
@@ -226,22 +226,22 @@ 
         $targetDirectory = $this->bfwConfigPath;
         $alreadyExist    = file_exists($targetDirectory);
         
-        if($alreadyExist && $this->forceReinstall === true) {
+        if ($alreadyExist && $this->forceReinstall === true) {
             echo '[Force Reinstall: Remove symlink] ';
             $alreadyExist = false;
             
-            if(!rmdir($targetDirectory)) {
+            if (!rmdir($targetDirectory)) {
                 echo "\033[1;31m Remove module config directory fail.\033[0m\n";
                 throw new Exception('Reinstall fail. Remove module config directory error.');
             }
         }
         
-        if($alreadyExist) {
+        if ($alreadyExist) {
             echo "\033[1;33m Already exist.\033[0m\n";
             return true;
         }
             
-        if(mkdir($targetDirectory, 0755)) {
+        if (mkdir($targetDirectory, 0755)) {
             echo "\033[1;32m Created. \033[0m\n";
             return true;
         }
@@ -269,19 +269,19 @@ 
         $targetFile = realpath($this->bfwConfigPath.'/'.$configFileName);
         
         //Check if config file already exist
-        if(file_exists($targetFile)) {
+        if (file_exists($targetFile)) {
             echo "\033[1;33m Existe déjà.\033[0m\n";
             return;
         }
         
         //If source file not exist
-        if(!file_exists($sourceFile)) {
+        if (!file_exists($sourceFile)) {
             echo "\033[1;31m Config file not exist in module source.\033[0m\n";
             throw new Exception('Source file not exist');
         }
             
         //Alors on copie le fichier vers le dossier /configs/[monModule]/
-        if(!copy($sourceFile, $targetFile))
+        if (!copy($sourceFile, $targetFile))
         {
             echo "\033[1;31m Copy fail.\033[0m\n";
             throw new Exception('Copy fail');
@@ -299,12 +299,12 @@ 
     {
         echo ' >> Run install specific script : ';
         
-        if($this->installScript === '' || $this->installScript === false) {
+        if ($this->installScript === '' || $this->installScript === false) {
             echo ' >> '."\033[1;33m".'No specific script declared. Pass'."\033[0m\n";
             return;
         }
         
-        if($this->installScript === true) {
+        if ($this->installScript === true) {
             $this->installScript = 'runInstallModule.php';
         }
         

install/skeleton/cli.php

Spacing +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 define('cliMode', true);
 
 //If this file is not call from cli, we display an error
-if(PHP_SAPI !== 'cli') {
+if (PHP_SAPI !== 'cli') {
     echo 'cli.php should be used only from the command.';
     exit;
 }