thorsten / phpMyFAQ

phpmyfaq/inc/PMF/DB/Mssql.php

Doc Comments +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
      * @param string $password
      * @param string $database
      *
-     * @return bool TRUE, if connected, otherwise FALSE
+     * @return null|boolean TRUE, if connected, otherwise FALSE
      */
     public function connect($host, $user, $password, $database = '')
     {
@@ -290,7 +290,7 @@ 
      *
      * @param string $prefix Table prefix
      *
-     * @return array
+     * @return string[]
      */
     public function getTableNames($prefix = '')
     {

phpmyfaq/inc/PMF/DB/Mysqli.php

Doc Comments +4 added lines, -4 removed lines

@@ -68,7 +68,7 @@ 
      *
      * @throws PMF_Exception
      *
-     * @return bool true, if connected, otherwise false
+     * @return null|boolean true, if connected, otherwise false
      */
     public function connect($host, $user, $password, $database = '')
     {
@@ -144,7 +144,7 @@ 
      *
      * This function fetches a result row as an object.
      *
-     * @param mixed $result
+     * @param resource $result
      *
      * @return mixed
      */
@@ -158,7 +158,7 @@ 
      *
      * This function fetches a result as an associative array.
      *
-     * @param mixed $result
+     * @param mysqli_result $result
      *
      * @return array
      */
@@ -299,7 +299,7 @@ 
      *
      * @param string $prefix Table prefix
      *
-     * @return array
+     * @return string[]
      */
     public function getTableNames($prefix = '')
     {

Indentation +2 added lines, -2 removed lines

@@ -248,8 +248,8 @@
                MAX(%s) AS current_id
            FROM
                %s',
-           $id,
-           $table);
+            $id,
+            $table);
 
         $result = $this->query($select);
 

phpmyfaq/inc/PMF/DB/Pgsql.php

Doc Comments +5 added lines, -4 removed lines

@@ -66,7 +66,7 @@ 
      * @param string $password Password
      * @param string $database Database name
      *
-     * @return bool true, if connected, otherwise false
+     * @return null|boolean true, if connected, otherwise false
      */
     public function connect($host, $user, $password, $database = '')
     {
@@ -133,7 +133,7 @@ 
     /**
      * Fetch a result row as an object.
      *
-     * @param mixed $result
+     * @param resource $result
      *
      * @return mixed
      */
@@ -192,7 +192,7 @@ 
     /**
      * Logs the queries.
      *
-     * @return int
+     * @return string
      */
     public function log()
     {
@@ -203,6 +203,7 @@ 
      * Returns just one row.
      *
      * @param  string
+     * @param string $query
      *
      * @return string
      */
@@ -294,7 +295,7 @@ 
      *
      * @param string $prefix Table prefix
      *
-     * @return array
+     * @return string[]
      */
     public function getTableNames($prefix = '')
     {

phpmyfaq/inc/PMF/DB/Sqlite3.php

Doc Comments +6 added lines, -6 removed lines

@@ -68,7 +68,7 @@ 
      * @param string
      * @param string
      *
-     * @return bool
+     * @return null|boolean
      */
     public function connect($host, $user, $passwd, $db = '')
     {
@@ -88,7 +88,7 @@ 
      * @param int    $offset
      * @param int    $rowcount
      *
-     * @return mixed $result
+     * @return SQLite3Result $result
      */
     public function query($query, $offset = 0, $rowcount = 0)
     {
@@ -124,7 +124,7 @@ 
     /**
      * Fetch a result row as an object.
      *
-     * @param mixed $result
+     * @param SQLite3Result $result
      *
      * @return object or NULL if there are no more results
      */
@@ -157,7 +157,7 @@ 
      *
      * @param SQLite3Result $result
      *
-     * @return array
+     * @return SQLite3Result
      */
     public function fetchAssoc($result)
     {
@@ -212,7 +212,7 @@ 
     /**
      * Logs the queries.
      *
-     * @return int
+     * @return string
      */
     public function log()
     {
@@ -244,7 +244,7 @@ 
      *
      * @param string $prefix Table prefix
      *
-     * @return array
+     * @return string[]
      */
     public function getTableNames($prefix = '')
     {

Spacing +3 added lines, -3 removed lines

@@ -134,7 +134,7 @@ 
         $return = $result->fetchArray(SQLITE3_ASSOC);
 
         return $return
-            ? (object) $return
+            ? (object)$return
             : null;
     }
 
@@ -184,7 +184,7 @@ 
 
         $result->fetchedByPMF = true;
         while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
-            $ret[] = (object) $row;
+            $ret[] = (object)$row;
         }
 
         return $ret;
@@ -297,7 +297,7 @@ 
      */
     public function nextId($table, $id)
     {
-        $result = (int) $this->conn->querySingle(
+        $result = (int)$this->conn->querySingle(
             sprintf(
                 'SELECT max(%s) AS current_id FROM %s',
                 $id,

phpmyfaq/inc/PMF/Entity/Category.php

Doc Comments +1 added lines, -1 removed lines

@@ -229,7 +229,7 @@
     }
 
     /**
-     * @return string
+     * @return integer
      */
     public function getUserId()
     {

phpmyfaq/inc/PMF/Faq.php

Doc Comments +10 added lines, -10 removed lines

@@ -1065,7 +1065,7 @@ 
      * @param int    $record_id  Record id
      * @param string $language   Language
      *
-     * @return int
+     * @return boolean
      */
     public function addCategoryRelations(Array $categories, $record_id, $language)
     {
@@ -1493,7 +1493,7 @@ 
      * @param int    $record_id   Record id
      * @param string $record_lang Record language
      *
-     * @return array
+     * @return boolean
      */
     public function addNewRevision($record_id, $record_lang)
     {
@@ -1762,7 +1762,7 @@ 
      * Sets the visibilty of a question.
      *
      * @param int    $questionId
-     * @param string $is_visible
+     * @param string $isVisible
      *
      * @return bool
      */
@@ -2494,7 +2494,7 @@ 
      * Build a logic sequence, for a WHERE statement, of those category IDs
      * children of the provided category ID, if any.
      *
-     * @param   $nCatid
+     * @param   integer $nCatid
      * @param   $logicOp
      * @param   $oCat
      *
@@ -2524,14 +2524,14 @@ 
     /**
      * Build the SQL query for retrieving faq records according to the constraints provided.
      *
-     * @param   $QueryType
-     * @param   $nCatid
-     * @param   $bDownwards
-     * @param   $lang
-     * @param   $date
+     * @param   string $QueryType
+     * @param   integer $nCatid
+     * @param   boolean $bDownwards
+     * @param   string $lang
+     * @param   string $date
      * @param   $faqid
      *
-     * @return array
+     * @return string
      *
      * @since   2005-11-02
      *

Indentation +36 added lines, -36 removed lines

@@ -1766,16 +1766,16 @@ 
         return true;
     }
 
-     /**
-      * Returns the visibility of a question.
-      *
-      * @param   int $questionId
-      *
-      * @return  string
-      */
-     public function getVisibilityOfQuestion($questionId)
-     {
-         $query = sprintf("
+        /**
+         * Returns the visibility of a question.
+         *
+         * @param   int $questionId
+         *
+         * @return  string
+         */
+        public function getVisibilityOfQuestion($questionId)
+        {
+            $query = sprintf("
             SELECT
                 is_visible
             FROM
@@ -1789,15 +1789,15 @@ 
             $this->_config->getLanguage()->getLanguage()
         );
 
-         $result = $this->_config->getDb()->query($query);
-         if ($this->_config->getDb()->numRows($result) > 0) {
-             $row = $this->_config->getDb()->fetchObject($result);
+            $result = $this->_config->getDb()->query($query);
+            if ($this->_config->getDb()->numRows($result) > 0) {
+                $row = $this->_config->getDb()->fetchObject($result);
 
-             return $row->is_visible;
-         }
+                return $row->is_visible;
+            }
 
-         return;
-     }
+            return;
+        }
 
     /**
      * Sets the visibilty of a question.
@@ -2318,18 +2318,18 @@ 
         return $question;
     }
 
-     /**
-      * Returns all open questions.
-      *
-      * @param  $all boolean If true, then return visible and unvisble questions; otherwise only visible ones
-      *
-      * @return array
-      */
-     public function getAllOpenQuestions($all = true)
-     {
-         $questions = [];
-
-         $query = sprintf("
+        /**
+         * Returns all open questions.
+         *
+         * @param  $all boolean If true, then return visible and unvisble questions; otherwise only visible ones
+         *
+         * @return array
+         */
+        public function getAllOpenQuestions($all = true)
+        {
+            $questions = [];
+
+            $query = sprintf("
             SELECT
                 id, lang, username, email, category_id, question, created, answer_id, is_visible
             FROM
@@ -2344,9 +2344,9 @@ 
             ($all == false ? " AND is_visible = 'Y'" : '')
         );
 
-         if ($result = $this->_config->getDb()->query($query)) {
-             while ($row = $this->_config->getDb()->fetchObject($result)) {
-                 $questions[] = array(
+            if ($result = $this->_config->getDb()->query($query)) {
+                while ($row = $this->_config->getDb()->fetchObject($result)) {
+                    $questions[] = array(
                     'id' => $row->id,
                     'lang' => $row->lang,
                     'username' => $row->username,
@@ -2357,11 +2357,11 @@ 
                     'answer_id' => $row->answer_id,
                     'is_visible' => $row->is_visible,
                 );
-             }
-         }
+                }
+            }
 
-         return $questions;
-     }
+            return $questions;
+        }
 
     /**
      * Updates an existing voting record.

Spacing +16 added lines, -16 removed lines

@@ -28,17 +28,17 @@ 
  * SQL constants definitions
  */
 define('FAQ_SQL_ACTIVE_YES', 'yes');
-define('FAQ_SQL_ACTIVE_NO',  'no');
+define('FAQ_SQL_ACTIVE_NO', 'no');
 
 /*
  * Query type definitions
  */
-define('FAQ_QUERY_TYPE_DEFAULT',      'faq_default');
-define('FAQ_QUERY_TYPE_APPROVAL',     'faq_approval');
-define('FAQ_QUERY_TYPE_EXPORT_PDF',   'faq_export_pdf');
+define('FAQ_QUERY_TYPE_DEFAULT', 'faq_default');
+define('FAQ_QUERY_TYPE_APPROVAL', 'faq_approval');
+define('FAQ_QUERY_TYPE_EXPORT_PDF', 'faq_export_pdf');
 define('FAQ_QUERY_TYPE_EXPORT_XHTML', 'faq_export_xhtml');
-define('FAQ_QUERY_TYPE_EXPORT_XML',   'faq_export_xml');
-define('FAQ_QUERY_TYPE_RSS_LATEST',   'faq_rss_latest');
+define('FAQ_QUERY_TYPE_EXPORT_XML', 'faq_export_xml');
+define('FAQ_QUERY_TYPE_RSS_LATEST', 'faq_rss_latest');
 
 /*
  * Sorting type definitions
@@ -384,12 +384,12 @@ 
 
         $result = $this->_config->getDb()->query($query);
         $num = $this->_config->getDb()->numRows($result);
-        $pages = (int) ceil($num / $numPerPage);
+        $pages = (int)ceil($num/$numPerPage);
 
         if ($page == 1) {
             $first = 0;
         } else {
-            $first = $page * $numPerPage - $numPerPage;
+            $first = $page*$numPerPage - $numPerPage;
         }
 
         if ($num > 0) {
@@ -570,12 +570,12 @@ 
         $result = $this->_config->getDb()->query($query);
 
         $num = $this->_config->getDb()->numRows($result);
-        $pages = ceil($num / $this->_config->get('records.numberOfRecordsPerPage'));
+        $pages = ceil($num/$this->_config->get('records.numberOfRecordsPerPage'));
 
         if ($page == 1) {
             $first = 0;
         } else {
-            $first = ($page * $this->_config->get('records.numberOfRecordsPerPage')) - $this->_config->get('records.numberOfRecordsPerPage');
+            $first = ($page*$this->_config->get('records.numberOfRecordsPerPage')) - $this->_config->get('records.numberOfRecordsPerPage');
         }
 
         if ($num > 0) {
@@ -1258,7 +1258,7 @@ 
                 AND
                 lang = '%s'",
             PMF_Db::getTablePrefix(),
-            (int) $faqId,
+            (int)$faqId,
             $this->_config->getDb()->escape($faqLang)
         );
 
@@ -2311,7 +2311,7 @@ 
                     'category_id' => $row->category_id,
                     'question' => $row->question,
                     'created' => $row->created,
-                    'is_visible' => $row->is_visible, );
+                    'is_visible' => $row->is_visible,);
             }
         }
 
@@ -2479,7 +2479,7 @@ 
                     'revision_id' => $row->revision_id,
                     'user' => $row->usr,
                     'date' => $row->datum,
-                    'changelog' => $row->what, );
+                    'changelog' => $row->what,);
             }
         }
 
@@ -2790,13 +2790,13 @@ 
             $mode,
             PMF_Db::getTablePrefix(),
             $mode,
-            (int) $recordId);
+            (int)$recordId);
 
         $result = $this->_config->getDb()->query($query);
 
         if ($this->_config->getDb()->numRows($result) > 0) {
             while (($row = $this->_config->getDb()->fetchObject($result))) {
-                $permissions[] = (int) $row->permission;
+                $permissions[] = (int)$row->permission;
             }
         }
 
@@ -3043,7 +3043,7 @@ 
                 $lang
             );
 
-            $retval = (bool) $this->_config->getDb()->query($update);
+            $retval = (bool)$this->_config->getDb()->query($update);
         }
 
         return $retval;

phpmyfaq/inc/PMF/Helper/Faq.php

Doc Comments +1 added lines, -1 removed lines

@@ -185,7 +185,7 @@
      * @param PMF_Faq      $faq
      * @param string       $language
      *
-     * @return array
+     * @return string
      */
     public function createOverview(PMF_Category $category, PMF_Faq $faq, $language = '')
     {

phpmyfaq/inc/PMF/Instance.php

Doc Comments +1 added lines, -1 removed lines

@@ -262,7 +262,7 @@
      * Adds a configuration item for the database.
      *
      * @param string $name
-     * @param mixed  $value
+     * @param string  $value
      *
      * @return bool
      */

Spacing +5 added lines, -5 removed lines

@@ -105,7 +105,7 @@ 
      */
     public function setId($id)
     {
-        $this->id = (int) $id;
+        $this->id = (int)$id;
     }
 
     /**
@@ -147,7 +147,7 @@ 
         $select = sprintf(
             'SELECT * FROM %sfaqinstances WHERE id = %d',
             PMF_Db::getTablePrefix(),
-            (int) $id
+            (int)$id
         );
 
         $result = $this->config->getDb()->query($select);
@@ -220,7 +220,7 @@ 
             PMF_Db::getTablePrefix(),
             $data['instance'],
             $data['comment'],
-            (int) $id
+            (int)$id
         );
 
         return $this->config->getDb()->query($update);
@@ -239,12 +239,12 @@ 
             sprintf(
                 'DELETE FROM %sfaqinstances WHERE id = %d',
                 PMF_Db::getTablePrefix(),
-                (int) $id
+                (int)$id
             ),
             sprintf(
                 'DELETE FROM %sfaqinstances_config WHERE instance_id = %d',
                 PMF_Db::getTablePrefix(),
-                (int) $id
+                (int)$id
             ),
         );
 

phpmyfaq/inc/PMF/Mail/SwiftSMTP.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
     /**
      * Send the message using SMTP with authorisation.
      *
-     * @return bool True if successful, false otherwise.     
+     * @return integer True if successful, false otherwise.     
      */
     public function send($recipients, Array $headers, $body)
     {