Enalean / tuleap

plugins/docman/include/Docman_NotificationsManager_Move.class.php

Doc Comments +8 added lines

@@ -38,6 +38,10 @@ 
         }
     }
     var $do_not_send_notifications_to;
+
+    /**
+     * @param string $type
+     */
     function _buildMessagesForUsers(&$users, $type, $params) {
         if ($users) {
             $um = $this->_getUserManager();
@@ -55,6 +59,10 @@ 
             }
         }
     }
+
+    /**
+     * @param PFUser $user
+     */
     function _buildMessage($params, $user, $type) {
         $params['old_parent'] = $this->_item_factory->getItemFromDb($params['item']->getParentId());
         $this->_addMessage(

plugins/docman/include/Docman_PermissionsManager.class.php

Doc Comments +6 added lines, -1 removed lines

@@ -257,6 +257,7 @@ 
     * - he is super user,
     * - he is admin of the current docman,
     * - or one of his ugroups has MANAGE permission on the item
+    * @param PFUser|null $user
     * @return boolean
     */
     function userCanManage($user, $item_id) {
@@ -339,7 +340,7 @@ 
     /**
      * Check if given user has write access on a item tree.
      *
-     * @param $user   User User object.
+     * @param PFUser $user   User User object.
      * @param $itemId Integer The parent item id.
      * @return boolean
      */
@@ -461,6 +462,7 @@ 
 
     /**
      * Revoke all access to the user if not already set.
+     * @param integer $userId
      */
     function _setNoAccess($userId, $objectId) {
         $this->_revokeIfNotGranted($this->cache_read, $userId, $objectId);
@@ -473,6 +475,7 @@ 
      *
      * If userCanRead, cache it. Otherwise, if read is not already granted,
      * block it.
+     * @param boolean $canRead
      */
     function _setCanRead($userId, $objectId, $canRead) {
         if($canRead) {
@@ -487,6 +490,7 @@ 
      *
      * If userCanWrite, cache it. Otherwise, if write is not already granted,
      * block it.
+     * @param boolean $canWrite
      */
     function _setCanWrite($userId, $objectId, $canWrite) {
         if($canWrite) {
@@ -501,6 +505,7 @@ 
      * Set MANAGE, WRITE and READ accesses to the user.
      *
      * If user cannot manage and manage is not already granted, block it.
+     * @param boolean $canManage
      */
     function _setCanManage($userId, $objectId, $canManage) {
         if($canManage) {

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 &&