mambax7 / smartobject

class/smartobject.php

Doc Comments +9 added lines, -9 removed lines

@@ -165,7 +165,7 @@ 
     }
 
     /**
-     * @param        $key
+     * @param        string $key
      * @param        $data_type
      * @param bool   $itemName
      * @param string $form_caption
@@ -193,7 +193,7 @@ 
      * @param bool   $required     set to TRUE if this variable needs to have a value set before storing the object in the table
      * @param string $form_caption caption of this variable in a {@link SmartobjectForm} and title of a column in a  {@link SmartObjectTable}
      * @param string $form_dsc     description of this variable in a {@link SmartobjectForm}
-     * @param mixed  $value        default value of this variable
+     * @param string|false  $value        default value of this variable
      */
     public function quickInitVar($key, $data_type, $required = false, $form_caption = '', $form_dsc = '', $value = null)
     {
@@ -202,7 +202,7 @@ 
     }
 
     /**
-     * @param        $varname
+     * @param        string $varname
      * @param bool   $displayOnForm
      * @param string $default
      */
@@ -458,7 +458,7 @@ 
     /**
      * add an error
      *
-     * @param      $err_str
+     * @param      string $err_str
      * @param bool $prefix
      * @internal param string $value error to add
      * @access   public
@@ -720,8 +720,8 @@ 
 
     /**
      * @param $key
-     * @param $info
-     * @param $value
+     * @param string $info
+     * @param boolean $value
      */
     public function setVarInfo($key, $info, $value)
     {
@@ -729,7 +729,7 @@ 
     }
 
     /**
-     * @param         $key
+     * @param         string $key
      * @param  bool   $editor
      * @return string
      */
@@ -906,7 +906,7 @@ 
      * @access public
      * @param  string $key    key of the object's variable to be returned
      * @param  string $format format to use for the output
-     * @return mixed  formatted value of the variable
+     * @return string  formatted value of the variable
      */
     public function getVar($key, $format = 's')
     {
@@ -1209,7 +1209,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      */
     public function hideFieldFromForm($key)
     {

class/smartobjectcontroller.php

Doc Comments +6 added lines, -6 removed lines

@@ -123,9 +123,9 @@ 
 
     /**
      * @param        $smartObj
-     * @param        $objectid
-     * @param        $created_success_msg
-     * @param        $modified_success_msg
+     * @param        integer $objectid
+     * @param        string $created_success_msg
+     * @param        string $modified_success_msg
      * @param  bool  $redirect_page
      * @param  bool  $debug
      * @return mixed
@@ -289,7 +289,7 @@ 
      * @param  bool   $confirm_msg
      * @param  string $op
      * @param  bool   $userSide
-     * @return bool
+     * @return boolean|null
      * @internal param string $redir_page redirect page after deleting the object
      */
     public function handleObjectDeletion($confirm_msg = false, $op = 'del', $userSide = false)
@@ -443,7 +443,7 @@ 
     }
 
     /**
-     * @param         $smartObj
+     * @param         SmartMlObject $smartObj
      * @param  bool   $onlyUrl
      * @param  bool   $withimage
      * @return string
@@ -533,7 +533,7 @@ 
     }
 
     /**
-     * @param $smartObj
+     * @param SmartObject $smartObj
      * @return string
      */
     public function getPrintAndMailLink($smartObj)

class/smartobjecthandler.php

Doc Comments +4 added lines, -4 removed lines

@@ -132,10 +132,10 @@ 
      *
      * @param XoopsDatabase $db           {@link XoopsDatabase}
      *                                           object
-     * @param                      $itemname
+     * @param                      string $itemname
      * @param string               $keyname      Name of the table key that uniquely identify each {@link SmartObject}
      * @param string               $idenfierName Name of the field which properly identify the {@link SmartObject}
-     * @param                      $summaryName
+     * @param                      string $summaryName
      * @param                      $modulename
      * @internal param string $tablename Name of the table use to store this <a href='psi_element://SmartObject'>SmartObject</a>
      * @internal param Name $string of the class derived from <a href='psi_element://SmartObject'>SmartObject</a> and which this handler is handling and which this handler is handling
@@ -191,7 +191,7 @@ 
 
     /**
      * @param $criteria
-     * @param $perm_name
+     * @param boolean $perm_name
      * @return bool
      */
     public function setGrantedObjectsCriteria(&$criteria, $perm_name)
@@ -375,7 +375,7 @@ 
     }
 
     /**
-     * @param        $sql
+     * @param        string $sql
      * @param        $criteria
      * @param  bool  $force
      * @param  bool  $debug

class/smartobjectpermission.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
      */
     /**
      * @param        $gperm_name
-     * @param  null  $id
+     * @param  integer  $id
      * @return array
      */
     public function getGrantedGroups($gperm_name, $id = null)

class/smartobjectsregistry.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
     /**
      * Access the only instance of this class
      *
-     * @return XoopsObject
+     * @return SmartObjectsRegistry
      *
      * @static
      * @staticvar   object

include/functions.php

Doc Comments +13 added lines, -13 removed lines

@@ -325,7 +325,7 @@ 
 }
 
 /**
- * @param              $key
+ * @param              string $key
  * @param  bool        $moduleName
  * @param  string      $default
  * @return null|string
@@ -387,7 +387,7 @@ 
 
 /**
  * Thanks to the NewBB2 Development Team
- * @param $target
+ * @param string $target
  * @return bool
  */
 function smart_admin_mkdir($target)
@@ -540,7 +540,7 @@ 
 
 /**
  * @param $dirname
- * @return bool
+ * @return boolean|null
  */
 function smart_deleteFile($dirname)
 {
@@ -755,7 +755,7 @@ 
 }
 
 /**
- * @param $name
+ * @param string $name
  */
 function smart_close_collapsable($name)
 {
@@ -765,7 +765,7 @@ 
 }
 
 /**
- * @param     $name
+ * @param     string $name
  * @param     $value
  * @param int $time
  */
@@ -779,7 +779,7 @@ 
 }
 
 /**
- * @param         $name
+ * @param         string $name
  * @param  string $default
  * @return string
  */
@@ -938,7 +938,7 @@ 
 }
 
 /**
- * @param $src
+ * @param string $src
  */
 function smart_addScript($src)
 {
@@ -1115,8 +1115,8 @@ 
 }
 
 /**
- * @param $module
- * @param $file
+ * @param string $module
+ * @param string $file
  */
 function smart_loadLanguageFile($module, $file)
 {
@@ -1232,7 +1232,7 @@ 
  * This function should be able to cover almost all floats that appear in an european environment.
  * @param            $str
  * @param  bool      $set
- * @return float|int
+ * @return double
  */
 function smart_getfloat($str, $set = false)
 {
@@ -1267,7 +1267,7 @@ 
 /**
  * @param                         $var
  * @param  bool                   $currencyObj
- * @return float|int|mixed|string
+ * @return string
  */
 function smart_currency($var, $currencyObj = false)
 {
@@ -1295,7 +1295,7 @@ 
 
 /**
  * @param $var
- * @return float|int|mixed|string
+ * @return string
  */
 function smart_float($var)
 {
@@ -1343,7 +1343,7 @@ 
 /**
  * @param $moduleName
  * @param $items
- * @return array
+ * @return string[]
  */
 function smart_getTablesArray($moduleName, $items)
 {