mambax7 / smartfaq

smartfaq/admin/mygrouppermform.php

Doc Comments +7 added lines

@@ -85,6 +85,10 @@ 
 
     /**
      * Constructor
+     * @param string $title
+     * @param integer $modid
+     * @param string $permname
+     * @param string $permdesc
      */
     function MyXoopsGroupPermForm($title, $modid, $permname, $permdesc)
     {
@@ -117,6 +121,8 @@ 
      * Add appendix
      *
      * @access public
+     * @param string $permName
+     * @param string $itemName
      */
     function addAppendix($permName,$itemId,$itemName)
     {
@@ -249,6 +255,7 @@ 
 
     /**
      * Constructor
+     * @param string $name
      */
     function MyXoopsGroupFormCheckBox($caption, $name, $groupId, $values = null)
     {

Braces +3 added lines, -1 removed lines

@@ -376,8 +376,10 @@
             $tree .= ' checked="checked"';
         }
         $tree .= " />".$option['name']."<input type=\"hidden\" name=\"".$this->getName()."[parents][".$option['id']."]\" value=\"".implode(':', $parentIds)."\" /><input type=\"hidden\" name=\"".$this->getName()."[itemname][".$option['id']."]\" value=\"".htmlspecialchars($option['name'])."\" /><br />\n";
-        if ( isset( $option['children'] ) ) foreach ($option['children'] as $child) {
+        if ( isset( $option['children'] ) ) {
+            foreach ($option['children'] as $child) {
             array_push($parentIds, $option['id']);
+        }
             $this->_renderOptionTree($tree, $this->_optionTree[$child], $prefix.'&nbsp;-', $parentIds);
         }
     }

smartfaq/class/answer.php

Doc Comments +3 added lines, -6 removed lines

@@ -24,6 +24,7 @@ 
     var $attachment_array = array();
     /**
     * constructor
+    * @param integer $id
     */
     function __construct ($id = null)
     {
@@ -297,7 +298,7 @@ 
     * create a new answer
     *
     * @param bool $isNew flag the new objects as "new"?
-    * @return object sfAnswer
+    * @return sfAnswer sfAnswer
     */
     function &create($isNew = true)
     {
@@ -338,7 +339,7 @@ 
     /**
     * insert a new answer in the database
     *
-    * @param object $answer reference to the {@link sfAnswer} object
+    * @param sfAnswer $answerObj reference to the {@link sfAnswer} object
     * @param bool $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */
@@ -414,8 +415,6 @@ 
     /**
     * delete an answer from the database
     *
-    * @param object $answer reference to the answer to delete
-    * @param bool $force
     * @return bool FALSE if failed.
     */
     function deleteFaqAnswers(&$faqObj)
@@ -476,7 +475,6 @@ 
     /**
     * retrieve 1 official answer (for now SmartFAQ only allow 1 official answer...)
     *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
     * @param int $faqid
     * @return mixed reference to the {@link sfAnswer} object, FALSE if failed
     */
@@ -495,7 +493,6 @@ 
     /**
     * retrieve all answers
     *
-    * @param object $criteria {@link CriteriaElement} conditions to be met
     * @param int $faqid
     * @return array array of {@link sfAnswer} objects
     */

Braces +31 added lines, -13 removed lines

@@ -62,17 +62,24 @@ 
     // attachment functions    TODO: there should be a file/attachment management class
     function getAttachment()
     {
-        if (count($this->attachment_array)) return $this->attachment_array;
+        if (count($this->attachment_array)) {
+            return $this->attachment_array;
+        }
         $attachment = $this->getVar('attachment');
-        if (empty($attachment)) $this->attachment_array = null;
-        else $this->attachment_array = @unserialize(base64_decode($attachment));
+        if (empty($attachment)) {
+            $this->attachment_array = null;
+        } else {
+            $this->attachment_array = @unserialize(base64_decode($attachment));
+        }
 
         return $this->attachment_array;
     }
 
     function incrementDownload($attach_key)
     {
-        if (!$attach_key) return false;
+        if (!$attach_key) {
+            return false;
+        }
         $this->attachment_array[strval($attach_key)]['num_download'] ++;
 
         return $this->attachment_array[strval($attach_key)]['num_download'];
@@ -80,9 +87,11 @@ 
 
     function saveAttachment()
     {
-        if (is_array($this->attachment_array) && count($this->attachment_array) > 0)
-            $attachment_save = base64_encode(serialize($this->attachment_array));
-        else $attachment_save = '';
+        if (is_array($this->attachment_array) && count($this->attachment_array) > 0) {
+                    $attachment_save = base64_encode(serialize($this->attachment_array));
+        } else {
+            $attachment_save = '';
+        }
         $this->setVar('attachment', $attachment_save);
         $sql = "UPDATE " . $GLOBALS["xoopsDB"]->prefix("smartfaq_answers") . " SET attachment=" . $GLOBALS["xoopsDB"]->quoteString($attachment_save) . " WHERE post_id = " . $this->getVar('answerid');
         if (!$result = $GLOBALS["xoopsDB"]->queryF($sql)) {
@@ -98,11 +107,18 @@ 
         global $xoopsModuleConfig;
 
         $attach_old = $this->getAttachment();
-        if (!is_array($attach_old) || count($attach_old) < 1) return true;
+        if (!is_array($attach_old) || count($attach_old) < 1) {
+            return true;
+        }
         $this->attachment_array = array();
 
-        if ($attach_array === null) $attach_array = array_keys($attach_old); // to delete all!
-        if (!is_array($attach_array)) $attach_array = array($attach_array);
+        if ($attach_array === null) {
+            $attach_array = array_keys($attach_old);
+        }
+        // to delete all!
+        if (!is_array($attach_array)) {
+            $attach_array = array($attach_array);
+        }
 
         foreach ($attach_old as $key => $attach) {
             if (in_array($key, $attach_array)) {
@@ -112,9 +128,11 @@ 
             }
             $this->attachment_array[$key] = $attach;
         }
-        if (is_array($this->attachment_array) && count($this->attachment_array) > 0)
-            $attachment_save = base64_encode(serialize($this->attachment_array));
-        else $attachment_save = '';
+        if (is_array($this->attachment_array) && count($this->attachment_array) > 0) {
+                    $attachment_save = base64_encode(serialize($this->attachment_array));
+        } else {
+            $attachment_save = '';
+        }
         $this->setVar('attachment', $attachment_save);
 
         return true;

smartfaq/class/category.php

Doc Comments +2 added lines, -2 removed lines

@@ -228,7 +228,7 @@ 
     * create a new category
     *
     * @param bool $isNew flag the new objects as "new"?
-    * @return object sfCategory
+    * @return sfCategory sfCategory
     */
     function &create($isNew = true)
     {
@@ -270,7 +270,7 @@ 
     /**
     * insert a new category in the database
     *
-    * @param object $category reference to the {@link sfCategory} object
+    * @param sfCategory $category reference to the {@link sfCategory} object
     * @param bool $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */

smartfaq/class/faq.php

Doc Comments +4 added lines, -1 removed lines

@@ -207,6 +207,9 @@ 
         return $ret;
     }
 
+    /**
+     * @return integer
+     */
     function uid()
     {
         return $this->getVar("uid");
@@ -619,7 +622,7 @@ 
     /**
     * insert a new faq in the database
     *
-    * @param object $faq reference to the {@link sfFaq} object
+    * @param sfFaq $faq reference to the {@link sfFaq} object
     * @param bool $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */

smartfaq/class/smartdbupdater.php

Doc Comments +4 added lines, -1 removed lines

@@ -164,6 +164,9 @@ 
         return $fields;
     }
 
+    /**
+     * @param string $field
+     */
     function fieldExists($field)
     {
         $existingFields = $this->getExistingFieldsArray();
@@ -620,7 +623,7 @@ 
    /**
     * Use to update a table
     *
-    * @param object $table {@link SmartDbTable} that will be updated
+    * @param SmartDbTable $table {@link SmartDbTable} that will be updated
     *
     * @see SmartDbTable
     *

smartfaq/class/uploader.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      * Constructor
      *
      * @param string $uploadDir
-     * @param array  $allowedMimeTypes
+     * @param integer  $allowedMimeTypes
      * @param int    $maxFileSize
      * @param int    $maxWidth
      * @param int    $maxHeight

smartfaq/include/functions.php

Doc Comments +3 added lines

@@ -581,6 +581,9 @@
     echo "<h3 style=\"color: #2F5376; margin: 6px 0 0 0; \"><a href='#' onClick=\"toggle('" . $tablename . "'); toggleIcon('" . $iconname . "');\">";
 }
 
+/**
+ * @param string $name
+ */
 function sf_gethandler($name, $optional = false )
 {
     static $handlers;

smartfaq/include/functions.render.php

Doc Comments -1 removed lines

@@ -68,7 +68,6 @@
 /**
  * Display forrum button
  *
- * @param	string	$image		image/button name, without extension
  * @param	string	$alt		alt message
  * @param	boolean	$asImage	true for image mode; false for text mode
  * @param	string	$extra		extra attribute for the button

Braces +3 added lines, -1 removed lines

@@ -123,7 +123,9 @@
     global $xoTheme, $xoopsConfig;
     static $icon_handler;
 
-    if (isset($icon_handler)) return $icon_handler;
+    if (isset($icon_handler)) {
+        return $icon_handler;
+    }
 
     if (!class_exists("NewbbIconHandler")) {
         require_once dirname(__DIR__)."/class/icon.php";

smartfaq/answer.php

Braces +6 added lines, -2 removed lines

@@ -20,8 +20,12 @@
 $op = 'form';
 
 // Getting the operation we are doing
-if (isset($_GET['op'])) $op = $_GET['op'];
-if (isset($_POST['op'])) $op = $_POST['op'];
+if (isset($_GET['op'])) {
+    $op = $_GET['op'];
+}
+if (isset($_POST['op'])) {
+    $op = $_POST['op'];
+}
 
 // Getting the faqid
 $faqid = isset($_GET['faqid'])? intval($_GET['faqid']) : 0;