mambax7 / smartobject

class/smarthookhandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
 	/**
 	 * Access the only instance of this class
      *
-     * @return	object
+     * @return	SmartHookHandler
      *
      * @static
      * @staticvar   object

class/smartmetagen.php

Doc Comments +13 added lines

@@ -156,17 +156,26 @@ 
         $this->_title = $ret;
     }
 
+    /**
+     * @param string|boolean $keywords
+     */
     function setKeywords($keywords)
     {
         $this->_keywords = $keywords;
     }
 
+    /**
+     * @param boolean $categoryPath
+     */
     function setCategoryPath($categoryPath)
     {
         $categoryPath = $this->html2text($categoryPath);
         $this->_categoryPath = $categoryPath;
     }
 
+    /**
+     * @param boolean $description
+     */
     function setDescription($description)
     {
         if (!$description) {
@@ -217,6 +226,10 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $text
+     * @param integer $minChar
+     */
     function findMetaKeywords($text, $minChar)
     {
         $keywords = array();

class/smartobject.php

Doc Comments +20 added lines, -4 removed lines

@@ -68,7 +68,7 @@ 
 	/**
 	* Checks if the user has a specific access on this object
 	*
-	* @param string $gperm_name name of the permission to test
+	* @param string $perm_name name of the permission to test
 	* @return boolean : TRUE if user has access, false if not
 	**/
 	function accessGranted($perm_name) {
@@ -127,6 +127,9 @@ 
         'readonly' => false));
     }
 
+    /**
+     * @param string $key
+     */
     function initNonPersistableVar($key, $data_type, $itemName=false, $form_caption='', $sortby=false, $value='', $displayOnForm=false, $required=false) {
 		$this->initVar($key, $data_type, $value, $required, null, '', false, $form_caption, '', $sortby, false, $displayOnForm);
 		$this->vars[$key]['itemName'] = $itemName;
@@ -145,13 +148,16 @@ 
     * @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
     */
 	function quickInitVar($key, $data_type, $required=false, $form_caption='', $form_dsc='', $value = null) {
 		$maxlength = $data_type == 'XOBJ_DTYPE_TXTBOX' ? 255 : null;
 		$this->initVar($key, $data_type, $value, $required, $maxlength, '', false, $form_caption, $form_dsc, false, true, true);
 	}
 
+    /**
+     * @param string $varname
+     */
     function initCommonVar($varname, $displayOnForm=true, $default='notdefined') {
 
     	switch ($varname) {
@@ -393,8 +399,8 @@ 
     /**
      * add an error
      *
-     * @param string $value error to add
      * @access public
+     * @param string $err_str
      */
     function setErrors($err_str, $prefix=false)
     {
@@ -585,10 +591,17 @@ 
 		$this->vars[$key]['data_type'] = $newType;
 	}
 
+	/**
+	 * @param string $info
+	 * @param boolean $value
+	 */
 	function setVarInfo($key, $info, $value) {
 		$this->vars[$key][$info] = $value;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	function getValueFor($key, $editor=true) {
     	global $xoopsModuleConfig;
 
@@ -759,7 +772,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
     */
     function getVar($key, $format = 's')
     {
@@ -1035,6 +1048,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $key
+	 */
 	function hideFieldFromForm($key) {
 		if (is_array($key)) {
 			foreach($key as $v) {

class/smartobjectcontroller.php

Doc Comments +14 added lines, -7 removed lines

@@ -111,6 +111,11 @@ 
     	}
     }
 
+    /**
+     * @param integer $objectid
+     * @param string $created_success_msg
+     * @param string $modified_success_msg
+     */
     function &doStoreFromDefaultForm(&$smartObj, $objectid, $created_success_msg, $modified_success_msg, $redirect_page=false, $debug=false)
     {
     	global $smart_previous_page;
@@ -193,10 +198,7 @@ 
      *
      * @param string $created_success_msg message to display if new object was created
      * @param string $modified_success_msg message to display if object was successfully edited
-     * @param string $created_redir_page redirect page after creating the object
-     * @param string $modified_redir_page redirect page after editing the object
      * @param string $redirect_page redirect page, if not set, then we backup once
-     * @param bool $exit if set to TRUE then the script ends
      * @return bool
      */
     function &storeFromDefaultForm($created_success_msg, $modified_success_msg, $redirect_page=false, $debug=false, $x_param = false)
@@ -261,8 +263,7 @@ 
     /**
      * Handles deletion of an object which keyid is passed as a GET param
      *
-     * @param string $redir_page redirect page after deleting the object
-     * @return bool
+     * @return boolean|null
      */
     function handleObjectDeletion($confirm_msg = false, $op='del', $userSide=false)
     {
@@ -338,7 +339,7 @@ 
     /**
      * Retreive the object admin side link for a {@link SmartObjectSingleView} page
      *
-     * @param object $smartObj reference to the object from which we want the user side link
+     * @param SmartObject $smartObj reference to the object from which we want the user side link
      * @param bool $onlyUrl wether or not to return a simple URL or a full <a> link
      * @return string admin side link to the object
      */
@@ -358,7 +359,7 @@ 
     /**
      * Retreive the object user side link
      *
-     * @param object $smartObj reference to the object from which we want the user side link
+     * @param SmartObject $smartObj reference to the object from which we want the user side link
      * @param bool $onlyUrl wether or not to return a simple URL or a full <a> link
      * @return string user side link to the object
      */
@@ -391,6 +392,9 @@ 
     	return $ret;
     }
 
+    /**
+     * @param SmartMlObject $smartObj
+     */
     function getEditLanguageLink($smartObj, $onlyUrl=false, $withimage=true)
     {
     	$ret = $this->handler->_moduleUrl . "admin/" . $this->handler->_page . "?op=mod&" . $this->handler->keyName . "=" . $smartObj->getVar($this->handler->keyName) . "&language=" . $smartObj->getVar('language');
@@ -432,6 +436,9 @@ 
     	return "<a href='" . $ret . "'>" . $smartObj->getVar($this->handler->identifierName) . "</a>";
     }
 
+    /**
+     * @param SmartObject $smartObj
+     */
     function getPrintAndMailLink($smartObj) {
     	global $xoopsConfig;
 

class/smartobjecthandler.php

Doc Comments +9 added lines, -4 removed lines

@@ -136,12 +136,12 @@ 
      * Constructor - called from child classes
      *
      * @param object $db {@link XoopsDatabase} object
-     * @param string $tablename Name of the table use to store this {@link SmartObject}
+     * @param string $itemname Name of the table use to store this {@link SmartObject}
      * @param string Name of the class derived from {@link SmartObject} and which this handler is handling
      * @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 string $page Page name use to basically manage and display the {@link SmartObject}
-     * @param string $moduleName name of the module
+     * @param string $modulename name of the module
+     * @param string $summaryName
      */
     function SmartPersistableObjectHandler(&$db, $itemname, $keyname, $idenfierName, $summaryName, $modulename) {
 
@@ -184,6 +184,9 @@ 
         );
     }
 
+    /**
+     * @param boolean $perm_name
+     */
     function setGrantedObjectsCriteria(&$criteria, $perm_name) {
         $smartpermissions_handler = new SmartobjectPermissionHandler($this);
         $grantedItems = $smartpermissions_handler->getGrantedItems($perm_name);
@@ -335,6 +338,9 @@ 
         return $this->convertResultSet($result, $id_as_key, $as_object);
     }
 
+    /**
+     * @param string $sql
+     */
     function query($sql, $criteria, $force=false, $debug=false)
     {
         $ret = array();
@@ -848,7 +854,6 @@ 
      * This method will check if the function is available
      *
      * @param string $event name of the event
-     * @param object $obj $object on which is performed the event
      * @return mixed result of the execution of the function or FALSE if the function was not executed
      */
     function executeEvent($event, &$executeEventObj) {

class/smartobjectlink.php

Doc Comments +1 added lines, -1 removed lines

@@ -56,7 +56,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 integer formatted value of the variable
     */
     function getVar($key, $format = 's') {
         if ($format == 's' && in_array($key, array('from_uid', 'to_uid', 'date', 'link'))) {

class/smartobjectpermission.php

Doc Comments -1 removed lines

@@ -126,7 +126,6 @@
      *  saveCategory_Permissions()
      *
      * @param array $groups : group with granted permission
-     * @param integer $categoryID : categoryID on which we are setting permissions for Categories and Forums
      * @param string $perm_name : name of the permission
      * @return boolean : TRUE if the no errors occured
      **/

class/smartobjectsingleview.php

Doc Comments +4 added lines

@@ -66,6 +66,7 @@ 
 
     /**
      * Constructor
+     * @param SmartObject $object
      */
     function SmartObjectSingleView(&$object, $userSide=false, $actions=array(), $headerAsRow=true)
     {
@@ -75,6 +76,9 @@ 
         $this->_headerAsRow = $headerAsRow;
     }
 
+    /**
+     * @param SmartObjectRow $rowObj
+     */
     function addRow($rowObj) {
         $this->_rows[] = $rowObj;
     }

class/smartobjectsregistry.php

Doc Comments +1 added lines, -1 removed lines

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