Enalean / tuleap

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';

plugins/docman/include/Docman_Metadata.class.php

Doc Comments +37 added lines

@@ -78,6 +78,10 @@ 
     }
 
     //{{{ Accessors
+
+    /**
+     * @param integer $v
+     */
     function setId($v) {
         $this->id = $v;
     }
@@ -106,6 +110,9 @@ 
         return $this->type;
     }
 
+    /**
+     * @param string $v
+     */
     function setLabel($v) {
         $this->label = $v;
     }
@@ -155,6 +162,9 @@ 
         return $this->special;
     }
 
+    /**
+     * @param integer $v
+     */
     function setDefaultValue($v) {
         $this->defaultValue = $v;
     }
@@ -218,6 +228,10 @@ 
 
     //{{{ Changable parameters
     var $canChangeName;
+
+    /**
+     * @param boolean $v
+     */
     function setCanChangeName($v) {
         $this->canChangeName = $v;
     }
@@ -226,6 +240,10 @@ 
     }
     
     var $canChangeType;
+
+    /**
+     * @param boolean $v
+     */
     function setCanChangeType($v) {
         $this->canChangeType = $v;
     }
@@ -234,6 +252,10 @@ 
     }
 
     var $canChangeDescription;
+
+    /**
+     * @param boolean $v
+     */
     function setCanChangeDescription($v) {
         $this->canChangeDescription = $v;
     }
@@ -242,6 +264,10 @@ 
     }
 
     var $canChangeIsEmptyAllowed;
+
+    /**
+     * @param boolean $v
+     */
     function setCanChangeIsEmptyAllowed($v) {
         $this->canChangeIsEmptyAllowed = $v;
     }
@@ -250,6 +276,10 @@ 
     }
 
     var $canChangeIsMultipleValuesAllowed;
+
+    /**
+     * @param boolean $v
+     */
     function setCanChangeIsMultipleValuesAllowed($v) {
         $this->canChangeIsMultipleValuesAllowed = $v;
     }
@@ -258,6 +288,10 @@ 
     }
 
     var $canChangeValue;
+
+    /**
+     * @param boolean $v
+     */
     function setCanChangeValue($v) {
         $this->canChangeValue = $v;
     }
@@ -376,6 +410,9 @@ 
         return $i;
     }
 
+    /**
+     * @param integer $v
+     */
     function setDefaultValue($v) {
         if(is_a($v, 'Iterator')) {
             $v->rewind();

plugins/docman/include/Docman_MetadataComparator.class.php

Doc Comments +6 added lines

@@ -27,6 +27,10 @@ 
     var $srcGo;
     var $dstGo;
 
+    /**
+     * @param integer $srcGroupId
+     * @param integer $dstGroupId
+     */
     function Docman_MetadataComparator($srcGroupId, $dstGroupId, $themePath) {
         $this->docmanIcons = new Docman_Icons($themePath.'/images/ic/');
         $pm = ProjectManager::instance();
@@ -37,6 +41,8 @@ 
     /**
      * For a five object iterator, return an array of object indexed by
      * $func applied on object.
+     * @param ArrayIterator $iter
+     * @param string $func
      */
     function getArrayFromIterator($iter, $func) {
         $a = array();

plugins/docman/include/Docman_MetadataDao.class.php

Doc Comments +6 added lines

@@ -42,6 +42,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param boolean $onlyUsed
+     */
     function searchByGroupId($id, $onlyUsed, $type = array()) {
         $where_clause = '';
         if($onlyUsed) {
@@ -143,6 +146,9 @@ 
 
     }
 
+    /**
+     * @param string $sql
+     */
     function _createAndReturnId($sql) {
         $inserted = $this->update($sql);
         if ($inserted) {

plugins/docman/include/Docman_MetadataFactory.class.php

Doc Comments +5 added lines

@@ -98,6 +98,7 @@ 
 
     /**
      * Create a Metadata object based on DB a entry.
+     * @param string $id
      */
     function &getRealMetadata($id) {
         $md = null;
@@ -147,6 +148,7 @@ 
      * Fetch and append HardCoded metadata variable parameters.
      *
      * Some HardCoded are customizable at project level.
+     * @param Docman_Metadata|null $md
      */
     function appendHardCodedMetadataParams(&$md) {
         $sBo =& Docman_SettingsBo::instance($this->groupId);
@@ -452,6 +454,9 @@ 
         return false;
     }
 
+    /**
+     * @param Docman_Metadata $md
+     */
     function create(&$md) {
         $md->setGroupId($this->groupId);
 

plugins/docman/include/Docman_MetadataHtml.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -56,6 +56,9 @@ 
         return $mdh;
     }
 
+    /**
+     * @param boolean $whitelist
+     */
     function buildFieldArray($mdIter, $mdla, $whitelist, $formName, $themePath) {
         $fields = array();
         $formParams = array('form_name' => $formName,
@@ -212,7 +215,7 @@ 
     /**
      * Return field input validator.
      *
-     * @return string
+     * @return Docman_ValidateMetadataIsNotEmpty|null
      */
     function &getValidator() {
         $validator = null;