Enalean / tuleap

plugins/docman/include/Docman_Icons.class.php

Doc Comments +14 added lines

@@ -25,10 +25,17 @@ 
  */
 class Docman_Icons {
     var $images_path;
+
+    /**
+     * @param string $images_path
+     */
     function Docman_Icons($images_path) {
         $this->images_path = $images_path;
     }
     
+    /**
+     * @param string $action
+     */
     function getActionIcon($action) {
         switch ($action) {
             case 'popup': 
@@ -186,10 +193,17 @@ 
     function getSpinner() {
         return $this->images_path . 'spinner.gif';
     }
+
+    /**
+     * @param string $icon
+     */
     function getIcon($icon) {
         return $this->images_path . $icon;
     }
 
+    /**
+     * @param string $icon
+     */
     function getThemeIcon($icon) {
         return util_get_image_theme('ic/'.$icon);
     }

plugins/docman/include/Docman_Item.class.php

Doc Comments +3 added lines

@@ -340,6 +340,9 @@
         return $this->pathTitle;
     }
 
+    /**
+     * @param string $event
+     */
     public function fireEvent($event, $user, $parent=null) {
         $params = array('group_id' => $this->getGroupId(),
                         'parent'   => $parent,

plugins/docman/include/Docman_ItemDao.class.php

Doc Comments +16 added lines, -7 removed lines

@@ -53,6 +53,7 @@ 
 
     /**
      * Return the SQL statements that exclude deleted & obsolete items.
+     * @param string $table
      */
     function getCommonExcludeStmt($table) {
         return Docman_ItemDao::getExcludeDeletedItemsStmt($table).' AND '.
@@ -114,6 +115,8 @@ 
     }
 
     /**
+     * @param integer $limit
+     * @param integer $offset
      * @return DataAccessResult
      */
     public function searchPaginatedWithVersionByGroupId($groupId, $limit, $offset) {
@@ -312,7 +315,7 @@ 
     /**
      * Create a string from an array of sql statements.
      *
-     * @param $op Operator (AND, OR, LEFT JOIN, ...)
+     * @param string $op Operator (AND, OR, LEFT JOIN, ...)
      * @param $stmtArray Array of statements.
      * @return string
      */
@@ -377,8 +380,8 @@ 
     /**
      * Creates an item by calling the given SQL request, and returns the new ID
      *  
-     * @param $sql          SQL request
-     * @param $updateParent Determines if the parent folder "update date" must be updated
+     * @param string $sql          SQL request
+     * @param boolean $updateParent Determines if the parent folder "update date" must be updated
      */
     function _createAndReturnId($sql, $updateParent) {
         $inserted = $this->update($sql);
@@ -398,7 +401,8 @@ 
     /**
      * Update a row in the table plugin_docman_item 
      *
-     * @return true if there is no error
+     * @param integer $update_date
+     * @return boolean if there is no error
      */
     function updateById($item_id, $parent_id=null, $group_id=null, $title=null,
                     $description=null, $create_date=null, $update_date=null, 
@@ -529,7 +533,7 @@ 
      * Delete entry that match $item_id in plugin_docman_item
      *
      * @param $item_id int
-     * @return true if there is no error
+     * @return boolean if there is no error
      */
     function delete($item_id) {
         $sql = sprintf("DELETE FROM plugin_docman_item WHERE item_id=%d",
@@ -722,6 +726,11 @@ 
      *
      * @note: Cross-Project query.
      */
+
+    /**
+     * @param integer $tsStart
+     * @param integer $tsEnd
+     */
     function searchObsoleteAcrossProjects($tsStart, $tsEnd) {
         $sql = sprintf('SELECT i.*'.
                        ' FROM plugin_docman_item i, groups g'.
@@ -807,7 +816,7 @@ 
     /**
     * This removes all users copy preferences set on item identified by $item_id. This is done once the corresponding item is deleted
     *
-    * @param int $itemid identifer of docman item that has been marked as deleted.
+    * @param integer $item_id identifer of docman item that has been marked as deleted.
     *@return void
     *
     */
@@ -822,7 +831,7 @@ 
     /**
     * This removes all users cut preferences set on item identified by $item_id. This is done once the corresponding item is deleted
     *
-    * @param int $itemid identifer of docman item that has been marked as deleted.
+    * @param integer $item_id identifer of docman item that has been marked as deleted.
     *@return void
     *
     */

plugins/docman/include/Docman_ItemFactory.class.php

Doc Comments +11 added lines, -3 removed lines

@@ -360,8 +360,8 @@ 
      *
      * This function retreive collapsed folders from user preferences 
      *
-     * @param $parentId Id of the "current" root node (cannot be excluded).
-     * @param $userId Id of current user.
+     * @param integer $parentId Id of the "current" root node (cannot be excluded).
+     * @param integer $userId Id of current user.
      * @return Array List of items to exclude for a search
      **/
     function &_getExpandedUserPrefs($parentId, $userId) {           
@@ -663,7 +663,8 @@ 
     /**
      * Build a list of items
      *
-     * @return ItemNode
+     * @param integer $nbItemsFound
+     * @return ArrayIterator
      */
     function &getItemList($id = 0, &$nbItemsFound, $params = null) {
         if (!$id) {
@@ -1079,6 +1080,12 @@ 
 
     /**
      * Copy a subtree.
+     * @param integer $srcGroupId
+     * @param integer $dstGroupId
+     * @param PFUser $user
+     * @param boolean $ugroupsMapping
+     * @param string $dataRoot
+     * @param string $ordering
      */
     function cloneItems($srcGroupId, $dstGroupId, $user, $metadataMapping, $ugroupsMapping, $dataRoot, $srcItemId = 0, $dstItemId = 0, $ordering = null) {
         $itemMapping = array();
@@ -1221,6 +1228,7 @@ 
     /**
      * Recursive method that takes a subtree and
      * returns the corresponding stats (count + size)
+     * @param Docman_Item|null $folder
      */
     private function getFolderTreeStats($folder) {
         $stats['count'] = 0;

plugins/docman/include/Docman_LinkVersionDao.class.php

Doc Comments +2 added lines

@@ -21,6 +21,7 @@ 
 class Docman_LinkVersionDao extends DataAccessObject {
 
     /**
+     * @param integer $item_id
      * @return DataAccessResult
      */
     function searchByItemId($item_id) {
@@ -34,6 +35,7 @@ 
     }
 
     /**
+     * @param integer $item_id
      * @return DataAccessResult
      */
     function searchByNumber($item_id, $number) {

plugins/docman/include/Docman_LockDao.class.php

Doc Comments +10 added lines

@@ -29,6 +29,9 @@ 
         parent::__construct($da);
     }
 
+    /**
+     * @param integer $itemId
+     */
     function searchLockForItem($itemId) {
         $sql = 'SELECT *'.
                ' FROM plugin_docman_item_lock'.
@@ -84,6 +87,10 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $itemId
+     * @param integer $userId
+     */
     function addLock($itemId, $userId, $date) {
         $sql = 'INSERT INTO plugin_docman_item_lock'.
                ' (item_id, user_id, lock_date)'.
@@ -95,6 +102,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $itemId
+     */
     function delLock($itemId) {
         $sql = 'DELETE FROM plugin_docman_item_lock'.
                ' WHERE item_id = '.$this->da->quoteSmart($itemId);

plugins/docman/include/Docman_LockFactory.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
     /**
      * Retrun true if given user locked given item
      *
-     * @param Intger $itemId Item to test
+     * @param integer $itemId Item to test
      * @param PFUser   $user   User to test
      *
      * @return Boolean
@@ -112,7 +112,7 @@ 
     /**
      * Return true if item is locked
      * 
-     * @param Docman_Item $item Item to test
+     * @param Docman_Item $itemId Item to test
      * 
      * @return Boolean
      */

plugins/docman/include/Docman_Log.class.php

Doc Comments +1 added lines

@@ -252,6 +252,7 @@
 
     /**
      * Search if user accessed the given item after the given date.
+     * @param integer $itemId
      */
     function userAccessedSince($userId, $itemId, $date) {
         return $this->dao->searchUserAccessSince($userId, $itemId, $date);

plugins/docman/include/Docman_LogDao.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -118,7 +118,7 @@
 
     /**
     * create a row in the table plugin_docman_log 
-    * @return true or id(auto_increment) if there is no error
+    * @return boolean or id(auto_increment) if there is no error
     */
     function create($group_id, $item_id, $user_id, $type, $old_value = null, $new_value = null, $field = null) {
 		$sql = 'INSERT INTO plugin_docman_log (time, group_id, item_id, user_id, type';