Enalean / tuleap

plugins/docman/include/Docman_PermissionsManagerDao.class.php

Doc Comments +19 added lines

@@ -25,11 +25,18 @@ 
 class Docman_PermissionsManagerDao extends DataAccessObject {
 
     var $groupId;
+
+    /**
+     * @param integer $groupId
+     */
     function __construct($da, $groupId) {
         parent::__construct($da);
         $this->groupId = $groupId;
     }
 
+    /**
+     * @param string[] $perms
+     */
     function retreivePermissionsForItems($itemsIds, $perms, $ugroupIds) {
         $sql = 'SELECT *'.
             ' FROM permissions'.
@@ -39,6 +46,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param string $perm
+     */
     function setDefaultPermissions($objectId, $perm, $force=false) {
         require_once('www/project/admin/permissions.php');
         $res = permission_db_get_defaults($perm);
@@ -47,6 +57,9 @@ 
         }
     }
 
+    /**
+     * @param integer $group_id
+     */
     function oneFolderIsWritable($group_id, $ugroupIds) {
         $sql = sprintf('SELECT i.item_id'.
                       ' FROM plugin_docman_item as i, permissions as p'.
@@ -107,6 +120,9 @@ 
         }
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function isThereAnExplicitPermission($ugroup_id, $project_id) {
         $ugroup_id  = $this->da->escapeInt($ugroup_id);
         $project_id = $this->da->escapeInt($project_id);
@@ -123,6 +139,9 @@ 
         return $this->retrieveFirstRow($sql);
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function doAllItemsHaveExplicitPermissions($project_id) {
         $project_id = $this->da->escapeInt($project_id);
 

plugins/docman/include/Docman_Report.class.php

Doc Comments +3 added lines

@@ -76,6 +76,9 @@
         return $this->title;
     }
 
+    /**
+     * @param integer $g
+     */
     function setGroupId($g) {
         $this->groupId = $g;
     }

plugins/docman/include/Docman_ReportColumn.class.php

Doc Comments +3 added lines

@@ -29,6 +29,9 @@
         $this->sort = null;
     }
 
+    /**
+     * @param integer $s
+     */
     function setSort($s) {
         $this->sort = $s;
     }

plugins/docman/include/Docman_ReportColumnFactory.class.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
         $this->groupId = $groupId;
     }
 
+    /**
+     * @param string $colLabel
+     */
     function getColumnFromLabel($colLabel) {
         $col = null;
         $mdFactory = $this->_getMetadataFactory();

plugins/docman/include/Docman_ReportFactory.class.php

Doc Comments +8 added lines

@@ -36,6 +36,8 @@ 
 
     /**
      * Create a report for table view based on URL
+     * @param integer|null $reportId
+     * @param boolean $feedback
      */
     function &get($reportId, $request, $item, &$feedback) {
         $report = null;
@@ -263,6 +265,9 @@ 
         return $rai;
     }
 
+    /**
+     * @param PFUser $user
+     */
     function getPersonalReportsForUser($user) {
         $ra = array();
         $dao =& $this->getDao();
@@ -336,6 +341,9 @@ 
         return false;
     }
 
+    /**
+     * @param Docman_Report $report
+     */
     function deleteReport($report) {
         $dao =& $this->getDao();
         $filterFactory = new Docman_FilterFactory($this->groupId);

plugins/docman/include/Docman_ReportHtml.class.php

Doc Comments +3 added lines

@@ -49,6 +49,9 @@
         return $html;
     }
 
+    /**
+     * @param ArrayIterator $reportIter
+     */
     function getSelectOptionFromReportIterator($reportIter, $current=null) {
         $html = '';
         $reportIter->rewind();

plugins/docman/include/Docman_SettingsBo.class.php

Doc Comments +5 added lines

@@ -108,6 +108,9 @@ 
         return $dao->updateMetadataUsageForGroupId($this->groupId, $label, $useIt);
     }
 
+    /**
+     * @param integer $targetGroupId
+     */
     function cloneMetadataSettings($targetGroupId) {
         if($this->settingsExist()) {
             $dao =& $this->getDao();
@@ -136,6 +139,8 @@ 
         
      /**
       * @access: private
+      * @param Docman_SettingsBo $srcBo
+      * @param string $label
       */
     function _importMetadataUsage($srcBo, $label) {
         if($srcBo->getMetadataUsage($label) == true &&

plugins/docman/include/Docman_SubItemsWritableVisitor.class.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
     var $docCounter;
     var $fldCounter;
 
+    /**
+     * @param integer $groupId
+     */
     function Docman_SubItemsWritableVisitor($groupId, $user) {
         $this->dpm =& Docman_PermissionsManager::instance($groupId);
         $this->user = $user;

plugins/docman/include/Docman_TokenDao.class.php

Doc Comments +5 added lines, -1 removed lines

@@ -28,6 +28,7 @@ 
 
     /**
     * Searches Docman_Token by Url 
+    * @param integer $user_id
     * @return DataAccessResult
     */
     function searchUrl($user_id, $token) {
@@ -39,7 +40,9 @@ 
     
     /**
     * create a row in the table plugin_docman_tokens 
-    * @return true or id(auto_increment) if there is no error
+    * @param integer $user_id
+    * @param string $token
+    * @return boolean or id(auto_increment) if there is no error
     */
     function create($user_id, $token, $url) {
 		$sql = sprintf("INSERT INTO plugin_docman_tokens (user_id, token, url, created_at) VALUES (%s, %s, %s, NOW())",
@@ -53,6 +56,7 @@ 
     
     /**
     * delete a row in the table plugin_docman_tokens
+    * @param integer $user_id
     */
     function delete($user_id, $token) {
         $sql = sprintf("DELETE FROM plugin_docman_tokens WHERE (TO_DAYS(NOW()) - TO_DAYS(created_at)) > 1 OR (user_id = %s AND token = %s)",