thorsten / phpMyFAQ

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');

Indentation +16 added lines, -16 removed lines

@@ -1,21 +1,21 @@
 <?php
 /**
- * Attachment handler class for files stored in database
- *
- * PHP Version 5.3
- *
- * This Source Code Form is subject to the terms of the Mozilla Public License,
- * v. 2.0. If a copy of the MPL was not distributed with this file, You can
- * obtain one at http://mozilla.org/MPL/2.0/.
- *
- * @category  phpMyFAQ
- * @package   Attachment
- * @author    Anatoliy Belsky <ab@php.net>
- * @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-08-21
- */
+     * Attachment handler class for files stored in database
+     *
+     * PHP Version 5.3
+     *
+     * This Source Code Form is subject to the terms of the Mozilla Public License,
+     * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+     * obtain one at http://mozilla.org/MPL/2.0/.
+     *
+     * @category  phpMyFAQ
+     * @package   Attachment
+     * @author    Anatoliy Belsky <ab@php.net>
+     * @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-08-21
+     */
 
 if (!defined('IS_VALID_PHPMYFAQ')) {
     exit();

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)
     {

Indentation +16 added lines, -16 removed lines

@@ -1,21 +1,21 @@
 <?php
 /**
- * Attachment handler class
- *
- * PHP Version 5.3
- *
- * This Source Code Form is subject to the terms of the Mozilla Public License,
- * v. 2.0. If a copy of the MPL was not distributed with this file, You can
- * obtain one at http://mozilla.org/MPL/2.0/.
- *
- * @category  phpMyFAQ
- * @package   Attachment
- * @author    Anatoliy Belsky <ab@php.net>
- * @since     2009-08-21
- * @license   http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
- * @link      http://www.phpmyfaq.de
- * @copyright 2009-2016 phpMyFAQ Team
- */
+     * Attachment handler class
+     *
+     * PHP Version 5.3
+     *
+     * This Source Code Form is subject to the terms of the Mozilla Public License,
+     * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+     * obtain one at http://mozilla.org/MPL/2.0/.
+     *
+     * @category  phpMyFAQ
+     * @package   Attachment
+     * @author    Anatoliy Belsky <ab@php.net>
+     * @since     2009-08-21
+     * @license   http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
+     * @link      http://www.phpmyfaq.de
+     * @copyright 2009-2016 phpMyFAQ Team
+     */
 
 if (!defined('IS_VALID_PHPMYFAQ')) {
     exit();

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 +6 added lines, -6 removed lines

@@ -21,7 +21,7 @@ 
     exit();
 }
 
-require PMF_ROOT_DIR . '/inc/libs/phpseclib/Crypt/AES.php';
+require PMF_ROOT_DIR.'/inc/libs/phpseclib/Crypt/AES.php';
 
 /**
  * PMF_Attachment_Abstract
@@ -77,7 +77,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);
         }
@@ -101,7 +101,7 @@ 
      */
     public function putChunk($chunk)
     {
-        $content = $this->aes->encrypt($chunk) . self::chunkDelimiter;
+        $content = $this->aes->encrypt($chunk).self::chunkDelimiter;
         
         return fwrite($this->handle, $content);
     }
@@ -113,14 +113,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 +20 added lines, -20 removed lines

@@ -1,21 +1,21 @@ 
 <?php
 /**
- * Attachment migration handler
- *
- * PHP Version 5.3
- *
- * This Source Code Form is subject to the terms of the Mozilla Public License,
- * v. 2.0. If a copy of the MPL was not distributed with this file, You can
- * obtain one at http://mozilla.org/MPL/2.0/.
- *
- * @category  phpMyFAQ
- * @package   Attachment
- * @author    Anatoliy Belsky <ab@php.net>
- * @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-13
- */
+     * Attachment migration handler
+     *
+     * PHP Version 5.3
+     *
+     * This Source Code Form is subject to the terms of the Mozilla Public License,
+     * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+     * obtain one at http://mozilla.org/MPL/2.0/.
+     *
+     * @category  phpMyFAQ
+     * @package   Attachment
+     * @author    Anatoliy Belsky <ab@php.net>
+     * @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-13
+     */
 
 if (!defined('IS_VALID_PHPMYFAQ')) {
     exit();
@@ -162,8 +162,8 @@ 
             case PMF_Attachment_Migration::MIGRATION_TYPE1:
                 
                 PMF_Attachment_Factory::init(PMF_Attachment::STORAGE_TYPE_FILESYSTEM,
-                                             '',
-                                             false);
+                                                '',
+                                                false);
                 $this->migrateFromOldFormatToFs();
                 // FIXME should attachment settings update be triggered here?
                 
@@ -175,8 +175,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 +18 added lines, -18 removed lines

@@ -1,22 +1,22 @@ 
 <?php
 /**
- * Manages user authentication with Apache's HTTP authentication
- *
- * PHP Version 5.3
- *
- * This Source Code Form is subject to the terms of the Mozilla Public License,
- * v. 2.0. If a copy of the MPL was not distributed with this file, You can
- * obtain one at http://mozilla.org/MPL/2.0/.
- *
- * @category  phpMyFAQ 
- * @package   Auth
- * @author    Thorsten Rinne <thorsten@phpmyfaq.de>
- * @author    Alberto Cabello <alberto@unex.es>
- * @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-03-01
- */
+     * Manages user authentication with Apache's HTTP authentication
+     *
+     * PHP Version 5.3
+     *
+     * This Source Code Form is subject to the terms of the Mozilla Public License,
+     * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+     * obtain one at http://mozilla.org/MPL/2.0/.
+     *
+     * @category  phpMyFAQ 
+     * @package   Auth
+     * @author    Thorsten Rinne <thorsten@phpmyfaq.de>
+     * @author    Alberto Cabello <alberto@unex.es>
+     * @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-03-01
+     */
 
 if (!defined('IS_VALID_PHPMYFAQ')) {
     exit();
@@ -60,7 +60,7 @@ 
      * @param  string $login Loginname
      * @param  string $pass  Password
      * @return boolean
-    */
+     */
     public function changePassword($login, $pass)
     {
         return true;

phpmyfaq/inc/PMF/Cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
 
     /**
      * @static
-     * @return null|PMF_Cache
+     * @return PMF_Cache
      */
     public static function getInstance()
     {

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)

Spacing +4 added lines, -4 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 {

Indentation +17 added lines, -18 removed lines

@@ -1,23 +1,22 @@
 <?php
 /**
- * phpMyFAQ Date class
- *
- * PHP Version 5.3
- *
- * This Source Code Form is subject to the terms of the Mozilla Public License,
- * v. 2.0. If a copy of the MPL was not distributed with this file, You can
- * obtain one at http://mozilla.org/MPL/2.0/.
- *
- * @category  phpMyFAQ
- * @package   PMF_Date
- * @author    Thorsten Rinne <thorsten@phpmyfaq.de>
- * @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
- */
+     * phpMyFAQ Date class
+     *
+     * PHP Version 5.3
+     *
+     * This Source Code Form is subject to the terms of the Mozilla Public License,
+     * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+     * obtain one at http://mozilla.org/MPL/2.0/.
+     *
+     * @category  phpMyFAQ
+     * @package   PMF_Date
+     * @author    Thorsten Rinne <thorsten@phpmyfaq.de>
+     * @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
+     */
 
 if (!defined('IS_VALID_PHPMYFAQ')) {
     exit();

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);
         }
 

Indentation +17 added lines, -17 removed lines

@@ -1,22 +1,22 @@
 <?php
 /**
- * Helper class for database drivers
- *
- * PHP Version 5.3
- *
- * This Source Code Form is subject to the terms of the Mozilla Public License,
- * v. 2.0. If a copy of the MPL was not distributed with this file, You can
- * obtain one at http://mozilla.org/MPL/2.0/.
- *
- * @category  phpMyFAQ
- * @package   DB
- * @author    Thorsten Rinne <thorsten@phpmyfaq.de>
- * @author    Matteo Scaramuccia <matteo@phpmyfaq.de>
- * @copyright 2012-2016 phpMyFAQ Team
- * @license   http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
- * @link      http://www.phpmyfaq.de
- * @since     2012-04-12
- */
+     * Helper class for database drivers
+     *
+     * PHP Version 5.3
+     *
+     * This Source Code Form is subject to the terms of the Mozilla Public License,
+     * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+     * obtain one at http://mozilla.org/MPL/2.0/.
+     *
+     * @category  phpMyFAQ
+     * @package   DB
+     * @author    Thorsten Rinne <thorsten@phpmyfaq.de>
+     * @author    Matteo Scaramuccia <matteo@phpmyfaq.de>
+     * @copyright 2012-2016 phpMyFAQ Team
+     * @license   http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
+     * @link      http://www.phpmyfaq.de
+     * @since     2012-04-12
+     */
 
 if (!defined('IS_VALID_PHPMYFAQ')) {
     exit();