Enalean / tuleap

plugins/docman/include/Docman_MetadataListOfValuesElementFactory.class.php

Doc Comments +5 added lines

@@ -49,6 +49,7 @@ 
      * Delete the the ListOfValueElement.
      * Then keep metadata_value consistent: if there is no entry for a given
      * (item, $this->metadataId), create a default entry (NONE value).
+     * @param Docman_MetadataListOfValuesElement $love
      */
     function delete(&$love) {
         $dao =& $this->getDao();
@@ -131,6 +132,9 @@ 
         }
     }
 
+    /**
+     * @param boolean $onlyActive
+     */
     function &getIteratorByFieldId($id, $mdLabel, $onlyActive) {
         $loveArray = $this->getListByFieldId($id, $mdLabel, $onlyActive);
         $loveIter  = new ArrayIterator($loveArray);
@@ -296,6 +300,7 @@ 
 
     /**
      * Return static list of status (hardcoded metadata with hardcoded values)
+     * @param integer $status
      */
     function &getStatusList($status=null) {
         $ea = array();

plugins/docman/include/Docman_MetaMetadataHtml.class.php

Doc Comments +3 added lines

@@ -34,6 +34,9 @@
         $this->str_no = $GLOBALS['Language']->getText('plugin_docman', 'admin_md_detail_param_no');
     }
 
+    /**
+     * @param string|false $sthCanChange
+     */
     function getName(&$sthCanChange) {
         $mdContent = '';
         $mdContent .= '<tr>';

plugins/docman/include/Docman_NotificationsManager.class.php

Doc Comments +9 added lines

@@ -51,6 +51,9 @@ 
      */
     private $mail_builder;
 
+    /**
+     * @param string|null $url
+     */
     function __construct(Project $project, $url, $feedback, MailBuilder $mail_builder) {
         parent::__construct();
 
@@ -172,6 +175,9 @@ 
         return $users;
     }
 
+    /**
+     * @param PFUser $user
+     */
     function _buildMessage($event, $params, $user) {
         $type = '';
         switch($event) {
@@ -200,6 +206,9 @@ 
         );
     }
 
+    /**
+     * @param string $msg
+     */
     protected function _addMessage(PFUser $to, $subject, $msg, $link) {
         if (!isset($this->notifications[$msg])) {
             $subject = '['. util_unconvert_htmlspecialchars($this->_group_name) .' - Documents] '. $subject;

plugins/docman/include/Docman_NotificationsManager_Add.class.php

Doc Comments +7 added lines

@@ -47,6 +47,10 @@ 
                 break;
         }
     }
+
+    /**
+     * @param string $message_type
+     */
     function _getMessageForUser(&$user, $message_type, $params) {
         $msg = '';
         switch($message_type) {
@@ -66,6 +70,9 @@ 
         return $msg;
     }
 
+    /**
+     * @param string $type
+     */
     protected function getMessageLink($type, $params) {
         switch($type) {
             case self::MESSAGE_ADDED:

plugins/docman/include/Docman_NotificationsManager_Delete.class.php

Doc Comments +3 added lines

@@ -144,6 +144,9 @@
         return $link;
     }
 
+    /**
+     * @param string $message_type
+     */
     function _storeEvents($id, $message_type, $params) {
         $dpm   = $this->_getPermissionsManager();
         $users = $this->_getListeningUsers($id);

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