thorsten / phpMyFAQ

phpmyfaq/inc/Bootstrap.php

Doc Comments +1 added lines, -1 removed lines

@@ -220,7 +220,7 @@
  * @param  mixed  $context  It optionally contains an array of every variable
  *                          that existed in the scope the error was triggered in.
  *
- * @return bool
+ * @return boolean|null
  */
 function pmf_error_handler($level, $message, $filename, $line, $context)
 {

Spacing +25 added lines, -25 removed lines

@@ -53,18 +53,18 @@ 
 /**
  * The directory where the translations reside
  */
-define('PMF_LANGUAGE_DIR', dirname(__DIR__) . '/lang');
+define('PMF_LANGUAGE_DIR', dirname(__DIR__).'/lang');
 
 //
 // Setting up PSR-0 autoloader for Symfony Components
 //
-require PMF_INCLUDE_DIR . '/libs/Symfony/Component/ClassLoader/UniversalClassLoader.php';
+require PMF_INCLUDE_DIR.'/libs/Symfony/Component/ClassLoader/UniversalClassLoader.php';
 
 $loader = new UniversalClassLoader();
 $loader->registerNamespace('PMF', PMF_INCLUDE_DIR);
-$loader->registerNamespace('Symfony', PMF_INCLUDE_DIR . '/libs');
+$loader->registerNamespace('Symfony', PMF_INCLUDE_DIR.'/libs');
 $loader->registerPrefix('PMF_', PMF_INCLUDE_DIR);
-$loader->registerPrefix('Twig_', PMF_INCLUDE_DIR . '/libs');
+$loader->registerPrefix('Twig_', PMF_INCLUDE_DIR.'/libs');
 $loader->register();
 
 //
@@ -80,7 +80,7 @@ 
     $i++;
 }
 if (!$foundCurrPath) {
-    ini_set('include_path', '.' . PATH_SEPARATOR . ini_get('include_path'));
+    ini_set('include_path', '.'.PATH_SEPARATOR.ini_get('include_path'));
 }
 
 //
@@ -93,16 +93,16 @@ 
 //
 // Check if multisite/multisite.php exist for Multisite support
 //
-if (file_exists(__DIR__ . '/../multisite/multisite.php') && 'cli' !== PHP_SAPI) {
-    require __DIR__ . '/../multisite/multisite.php';
+if (file_exists(__DIR__.'/../multisite/multisite.php') && 'cli' !== PHP_SAPI) {
+    require __DIR__.'/../multisite/multisite.php';
 }
 
 //
 // Read configuration and constants
 //
-if (! defined('PMF_MULTI_INSTANCE_CONFIG_DIR')) {
+if (!defined('PMF_MULTI_INSTANCE_CONFIG_DIR')) {
     // Single instance configuration
-    define('PMF_CONFIG_DIR', dirname(__DIR__) . '/config');
+    define('PMF_CONFIG_DIR', dirname(__DIR__).'/config');
 } else {
     // Multi instance configuration
     define('PMF_CONFIG_DIR', PMF_MULTI_INSTANCE_CONFIG_DIR);
@@ -112,17 +112,17 @@ 
 // Check if config/database.php exist -> if not, redirect to installer
 //
 
-if (!file_exists(PMF_CONFIG_DIR . '/database.php') && !file_exists(PMF_ROOT_DIR . '/inc/data.php')) {
+if (!file_exists(PMF_CONFIG_DIR.'/database.php') && !file_exists(PMF_ROOT_DIR.'/inc/data.php')) {
     RedirectResponse::create('setup/index.php')->send();
     exit();
 }
 
-if (file_exists(PMF_ROOT_DIR . '/inc/data.php')) {
-    require PMF_ROOT_DIR . '/inc/data.php';
+if (file_exists(PMF_ROOT_DIR.'/inc/data.php')) {
+    require PMF_ROOT_DIR.'/inc/data.php';
 } else {
-    require PMF_CONFIG_DIR . '/database.php';
+    require PMF_CONFIG_DIR.'/database.php';
 }
-require PMF_CONFIG_DIR . '/constants.php';
+require PMF_CONFIG_DIR.'/constants.php';
 
 //
 // Set the error handler to our pmf_error_handler() function
@@ -151,7 +151,7 @@ 
 // We always need a valid session!
 //
 ini_set('session.use_only_cookies', 1); // Avoid any PHP version to move sessions on URLs
-ini_set('session.auto_start', 0);       // Prevent error to use session_start() if it's active in php.ini
+ini_set('session.auto_start', 0); // Prevent error to use session_start() if it's active in php.ini
 ini_set('session.use_trans_sid', 0);
 ini_set('url_rewriter.tags', '');
 
@@ -164,9 +164,9 @@ 
 //
 // Connect to LDAP server, when LDAP support is enabled
 //
-if ($faqConfig->get('security.ldapSupport') && file_exists(PMF_CONFIG_DIR . '/ldap.php') && extension_loaded('ldap')) {
-    require PMF_CONFIG_DIR . '/constants_ldap.php';
-    require PMF_CONFIG_DIR . '/ldap.php';
+if ($faqConfig->get('security.ldapSupport') && file_exists(PMF_CONFIG_DIR.'/ldap.php') && extension_loaded('ldap')) {
+    require PMF_CONFIG_DIR.'/constants_ldap.php';
+    require PMF_CONFIG_DIR.'/ldap.php';
     $faqConfig->setLdapConfig($PMF_LDAP);
 } else {
     $ldap = null;
@@ -181,7 +181,7 @@ 
     define('PMF_ATTACHMENTS_DIR', $confAttachmentsPath);
 } else {
     // otherwise build the absolute path
-    $tmp = dirname(__DIR__) . DIRECTORY_SEPARATOR . $confAttachmentsPath;
+    $tmp = dirname(__DIR__).DIRECTORY_SEPARATOR.$confAttachmentsPath;
 
     // Check that nobody is traversing
     if (0 === strpos((string)$tmp, dirname(__DIR__))) {
@@ -194,7 +194,7 @@ 
 //
 // Fix if phpMyFAQ is running behind a proxy server
 //
-if (! isset($_SERVER['HTTP_HOST'])) {
+if (!isset($_SERVER['HTTP_HOST'])) {
     if (isset($_SERVER['HTTP_X_FORWARDED_SERVER'])) {
         $_SERVER['HTTP_HOST'] = $_SERVER['HTTP_X_FORWARDED_SERVER'];
     } else {
@@ -205,14 +205,14 @@ 
 //
 // Fix undefined server variables in Windows IIS & CGI mode
 //
-if (! isset($_SERVER['SCRIPT_NAME'])) {
-    if(isset($_SERVER['SCRIPT_FILENAME'])) {
+if (!isset($_SERVER['SCRIPT_NAME'])) {
+    if (isset($_SERVER['SCRIPT_FILENAME'])) {
         $_SERVER['SCRIPT_NAME'] = $_SERVER['SCRIPT_FILENAME'];
-    } elseif(isset($_SERVER['PATH_TRANSLATED'])) {
+    } elseif (isset($_SERVER['PATH_TRANSLATED'])) {
         $_SERVER['SCRIPT_NAME'] = $_SERVER['PATH_TRANSLATED'];
-    } elseif(isset($_SERVER['PATH_INFO'])) {
+    } elseif (isset($_SERVER['PATH_INFO'])) {
         $_SERVER['SCRIPT_NAME'] = $_SERVER['PATH_INFO'];
-    } elseif(isset($_SERVER['SCRIPT_URL'])) {
+    } elseif (isset($_SERVER['SCRIPT_URL'])) {
         $_SERVER['SCRIPT_NAME'] = $_SERVER['SCRIPT_URL'];
     }
 }

phpmyfaq/inc/PMF/Attachment/Abstract.php

Doc Comments +1 added lines, -1 removed lines

@@ -433,7 +433,7 @@
     /**
      * Validate attached file with the real hash
      *
-     * @return boolean
+     * @return boolean|null
      */
     public function validate()
     {

Spacing +13 added lines, -13 removed lines

@@ -131,7 +131,7 @@ 
      *
      * @return PMF_Attachment_Abstract
      */
-    public function __construct ($id = null)
+    public function __construct($id = null)
     {   
         $this->db = PMF_Db::getInstance();
         
@@ -148,7 +148,7 @@ 
      *
      * @return string
      */
-    public function buildUrl ($forHTML = true)
+    public function buildUrl($forHTML = true)
     {
         $amp = true == $forHTML ? '&' : '&';
         
@@ -163,7 +163,7 @@ 
      *
      * @return void
      */
-    public function setKey ($key, $default = true)
+    public function setKey($key, $default = true)
     {
         $this->key = $key;
         $this->encrypted = null !== $key;
@@ -172,7 +172,7 @@ 
          * Not default means the key was set explicitly
          * for this attachment, so lets hash it
          */
-        if($this->encrypted && !$default) {
+        if ($this->encrypted && !$default) {
             $this->passwordHash = sha1($key);
         }
     }
@@ -184,7 +184,7 @@ 
      *
      * @return null
      */
-    public function setRecordId ($id)
+    public function setRecordId($id)
     {
         $this->recordId = $id;
     }
@@ -196,7 +196,7 @@ 
      *
      * @return null
      */
-    public function setRecordLang ($lang)
+    public function setRecordLang($lang)
     {
         $this->recordLang = $lang;
     }
@@ -370,18 +370,18 @@ 
      */
     protected function mkVirtualHash()
     {
-        if($this->encrypted) {
-            if(null === $this->id || null === $this->recordId ||
+        if ($this->encrypted) {
+            if (null === $this->id || null === $this->recordId ||
                null === $this->realHash || null === $this->filename ||
                null === $this->key) {
-                throw new PMF_Attachment_Exception('All of id, ' .
-                                     'recordId, hash, filename, ' .
-                                     'key is needed to generate ' . 
+                throw new PMF_Attachment_Exception('All of id, '.
+                                     'recordId, hash, filename, '.
+                                     'key is needed to generate '. 
                                      'fs hash for encrypted files');
             }
             
-            $src = $this->id . $this->recordId . $this->realHash .
-                        $this->filename . $this->key;
+            $src = $this->id.$this->recordId.$this->realHash.
+                        $this->filename.$this->key;
             $this->virtualHash = md5($src);            
         } else {
             $this->virtualHash = $this->realHash;

Indentation +3 added lines, -3 removed lines

@@ -375,9 +375,9 @@
                null === $this->realHash || null === $this->filename ||
                null === $this->key) {
                 throw new PMF_Attachment_Exception('All of id, ' .
-                                     'recordId, hash, filename, ' .
-                                     'key is needed to generate ' . 
-                                     'fs hash for encrypted files');
+                                        'recordId, hash, filename, ' .
+                                        'key is needed to generate ' . 
+                                        'fs hash for encrypted files');
             }
             
             $src = $this->id . $this->recordId . $this->realHash .

phpmyfaq/inc/PMF/Attachment/DB.php

Doc Comments +2 added lines, -2 removed lines

@@ -49,7 +49,7 @@ 
     /**
      * Delete attachment
      *
-     * @return boolean
+     * @return boolean|null
      */
     function delete()
     {
@@ -59,7 +59,7 @@ 
     /**
      * Save current attachment to the appropriate storage
      *
-     * @return boolean
+     * @return boolean|null
      */
     public function save()
     {

Spacing +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
      *
      * @param int $id attachment id
      */
-    public function __construct ($id = null)
+    public function __construct($id = null)
     {
         // TODO implement this
         throw new PMF_Attachment_Exception('The database attachment storage type is not yet implemented');

phpmyfaq/inc/PMF/Attachment/Factory.php

Doc Comments +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
      * @param PMF_Configuration $config
      * @param integer $recordId ID of the record
      *
-     * @return array
+     * @return integer|null
      */
     public static function fetchByRecordId(PMF_Configuration $config, $recordId)
     {

phpmyfaq/inc/PMF/Attachment/Filesystem/File/Encrypted.php

Doc Comments +3 added lines, -3 removed lines

@@ -51,9 +51,9 @@
     protected $aes;
 
     /**
-     * @param $filepath
-     * @param $mode
-     * @param $key
+     * @param string $filepath
+     * @param string $mode
+     * @param string $key
      *
      * @return PMF_Attachment_Filesystem_File_Encrypted
      */

Spacing +5 added lines, -5 removed lines

@@ -75,7 +75,7 @@ 
         $chunk   = '';
         $chunkDelimLen = strlen(self::chunkDelimiter);
         
-        while(!$readEnd && !$this->eof()) {
+        while (!$readEnd && !$this->eof()) {
             $chunk .= fread($this->handle, 1);
             $readEnd = self::chunkDelimiter == substr($chunk, -$chunkDelimLen);
         }
@@ -99,7 +99,7 @@ 
      */
     public function putChunk($chunk)
     {
-        $content = $this->aes->encrypt($chunk) . self::chunkDelimiter;
+        $content = $this->aes->encrypt($chunk).self::chunkDelimiter;
         
         return fwrite($this->handle, $content);
     }
@@ -111,14 +111,14 @@ 
     {
         $retval = false;
 
-        if(is_string($target)) {
+        if (is_string($target)) {
             $target = new PMF_Attachment_Filesystem_File_Vanilla($target, self::MODE_WRITE);
         } else {
             $target->setMode(self::MODE_WRITE);
         }
         
-        if($target->isOk()) {
-            while(!$this->eof()) {
+        if ($target->isOk()) {
+            while (!$this->eof()) {
                 $target->putChunk($this->getChunk());
             }
             

phpmyfaq/inc/PMF/Attachment/Migration.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
     }
 
     /**
-     * @param $dir
+     * @param boolean $dir
      * @return array
      */
     protected function getOldFileList($dir)

Spacing +11 added lines, -11 removed lines

@@ -101,14 +101,14 @@ 
         $records = $faq->faqRecords;
         
         reset($records);
-        while(list(,$record) = each($records)) {
+        while (list(,$record) = each($records)) {
             
             $recordDir = "$dir/$record[id]";
-            if(file_exists($recordDir) && is_dir($recordDir)) {
+            if (file_exists($recordDir) && is_dir($recordDir)) {
                 
                 $list[$record['id']]['files'] = array();
-                foreach(new DirectoryIterator($recordDir) as $entry) {
-                    if(!$entry->isDot() && $entry->isFile()) {
+                foreach (new DirectoryIterator($recordDir) as $entry) {
+                    if (!$entry->isDot() && $entry->isFile()) {
                         $list[$record['id']]['files'][] = "$recordDir/{$entry->getFilename()}";
                     }
                 }
@@ -129,20 +129,20 @@ 
     {
         $list = $this->getOldFileList(PMF_ATTACHMENTS_DIR);
     
-        foreach($list as $recordId => $item) {
+        foreach ($list as $recordId => $item) {
             $recordLang = $item['lang'];
-            foreach($item['files'] as $file) {
+            foreach ($item['files'] as $file) {
                 $att = PMF_Attachment_Factory::create();
                 $att->setRecordId($recordId);
                 $att->setRecordLang($recordLang);
                 
-                if(!$att->save($file)) {
+                if (!$att->save($file)) {
                     $this->error[] = "File $file couldn't be migrated";
                 }
             }
             
-            $recordDir = PMF_ATTACHMENTS_DIR . "/$recordId";
-            if(!@rmdir(PMF_ATTACHMENTS_DIR . "/$file")) {
+            $recordDir = PMF_ATTACHMENTS_DIR."/$recordId";
+            if (!@rmdir(PMF_ATTACHMENTS_DIR."/$file")) {
                 $this->warning[] = "Couldn't remove dir $recordDir after migration";
             }
         }
@@ -158,7 +158,7 @@ 
      */
     public function doMigrate($migrationType, $options)
     {
-        switch($migrationType) {
+        switch ($migrationType) {
             case PMF_Attachment_Migration::MIGRATION_TYPE1:
                 
                 PMF_Attachment_Factory::init(PMF_Attachment::STORAGE_TYPE_FILESYSTEM,
@@ -173,7 +173,7 @@ 
                 /**
                  * Awaiting new default key here
                  */
-                if(isset($options['defaultKey']) && !empty($options['defaultKey'])) {
+                if (isset($options['defaultKey']) && !empty($options['defaultKey'])) {
                     PMF_Attachment_Factory::init(PMF_Attachment::STORAGE_TYPE_FILESYSTEM,
                                                  $options['defaultKey'],
                                                  true);

Indentation +4 added lines, -4 removed lines

@@ -159,8 +159,8 @@ 
             case self::MIGRATION_TYPE1:
 
                 PMF_Attachment_Factory::init(PMF_Attachment::STORAGE_TYPE_FILESYSTEM,
-                                             '',
-                                             false);
+                                                '',
+                                                false);
                 $this->migrateFromOldFormatToFs();
                 // FIXME should attachment settings update be triggered here?
 
@@ -172,8 +172,8 @@ 
                  */
                 if (isset($options['defaultKey']) && !empty($options['defaultKey'])) {
                     PMF_Attachment_Factory::init(PMF_Attachment::STORAGE_TYPE_FILESYSTEM,
-                                                 $options['defaultKey'],
-                                                 true);
+                                                    $options['defaultKey'],
+                                                    true);
                     $this->migrateFromOldFormatToFs();
                 } else {
                     $this->error[] = 'Default key required to be set for this option';

phpmyfaq/inc/PMF/Auth/Http.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
      *
      * @param  string $login        Loginname
      * @param  array  $optionalData Optional data
-     * @return integer
+     * @return boolean
      */
     public function checkLogin($login, Array $optionalData = null)
     {

Indentation +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
      * @param  string $login Loginname
      * @param  string $pass  Password
      * @return boolean
-    */
+     */
     public function changePassword($login, $pass)
     {
         $change = sprintf("

phpmyfaq/inc/PMF/Date.php

Doc Comments +1 added lines, -1 removed lines

@@ -126,7 +126,7 @@
     /**
      * Returns date formatted according to user defined format
      *
-     * @param string $date
+     * @param string $unformattedDate
      * @return string
      */
     public function format($unformattedDate)

Indentation -1 removed lines

@@ -14,7 +14,6 @@
  * @author    Matteo Scaramuccia <matteo@phpmyfaq.de>
  * @copyright 2009-2016 phpMyFAQ Team
  * @license   http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
-
  * @link      http://www.phpmyfaq.de
  * @since     2009-09-24
  */

Spacing +6 added lines, -6 removed lines

@@ -68,10 +68,10 @@ 
     {
         if ($pmfFormat) {
             $dateString = strtotime(
-                substr($date, 0, 4) . '-' .
-                substr($date, 4, 2) . '-' .
-                substr($date, 6, 2) . ' ' .
-                substr($date, 8, 2) . ':' .
+                substr($date, 0, 4).'-'.
+                substr($date, 4, 2).'-'.
+                substr($date, 6, 2).' '.
+                substr($date, 8, 2).':'.
                 substr($date, 10, 2)
             );
         } else {
@@ -97,7 +97,7 @@ 
             $rfc822TZ = 'GMT';
         }
         
-        return self::createIsoDate($date, DATE_RFC822, $pmfFormat) . ' ' . $rfc822TZ;
+        return self::createIsoDate($date, DATE_RFC822, $pmfFormat).' '.$rfc822TZ;
     }
 
     /**
@@ -118,7 +118,7 @@ 
             $iso8601TZD = 'Z';
         }
         
-        return self::createIsoDate($date, DATE_ISO8601, $pmfFormat) . $iso8601TZD;
+        return self::createIsoDate($date, DATE_ISO8601, $pmfFormat).$iso8601TZD;
     }
     
     /**

phpmyfaq/inc/PMF/DB/Helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      * @param string $query
      * @param string $table
      *
-     * @return   array
+     * @return   string[]
      */
     public function buildInsertQueries($query, $table)
     {

Spacing +4 added lines, -4 removed lines

@@ -50,7 +50,7 @@ 
      */
     public function __construct(PMF_Configuration $config)
     {
-        $this->_config   = $config;
+        $this->_config = $config;
     }
 
     /**
@@ -85,7 +85,7 @@ 
                     }
                 }
             }
-            $ret[] = "INSERT INTO " . $table . " (" . implode(",", $p1) . ") VALUES (" . implode(",", $p2) . ");";
+            $ret[] = "INSERT INTO ".$table." (".implode(",", $p1).") VALUES (".implode(",", $p2).");";
         }
 
         return $ret;
@@ -134,11 +134,11 @@ 
         $return  = $query;
         $matches = array();
 
-        PMF_String::preg_match_all("/^" . $startPattern . "\s+(\w+)(\s+|$)/i", $query, $matches);
+        PMF_String::preg_match_all("/^".$startPattern."\s+(\w+)(\s+|$)/i", $query, $matches);
 
         if (isset($matches[1][0])) {
             $oldTableFullName = $matches[1][0];
-            $newTableFullName = $newValue . PMF_String::substr($oldTableFullName, PMF_String::strlen($oldValue));
+            $newTableFullName = $newValue.PMF_String::substr($oldTableFullName, PMF_String::strlen($oldValue));
             $return           = str_replace($oldTableFullName, $newTableFullName, $query);
         }