Enalean / tuleap

plugins/docman/include/ApprovalTable/Item/ItemDao.class.php

Doc Comments +14 added lines

@@ -22,6 +22,9 @@ 
 
 class Docman_ApprovalTableItemDao extends DataAccessObject {
 
+    /**
+     * @param integer $item_id
+     */
     public function getTableByItemId($item_id, $fields='*') {
         $sql = 'SELECT '.$fields.
             ' FROM plugin_docman_approval'.
@@ -57,6 +60,11 @@ 
         return $groupBy;
     }
 
+    /**
+     * @param boolean $status
+     * @param string $fields
+     * @param string $where
+     */
     function getTableWithStatus($status, $fields, $where, $join='', $orderBy='', $limit='') {
         $groupBy = '';
         if($status) {
@@ -75,6 +83,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param string $field
+     */
     function createTable($field, $id, $userId, $description, $date, $status, $notification) {
         $sql = 'INSERT INTO plugin_docman_approval'.
             '('.$field.', table_owner, date, description, status, notification)'.
@@ -149,6 +160,9 @@ 
         }
     }
 
+    /**
+     * @param string $sql
+     */
     function _createAndReturnId($sql) {
         $inserted = $this->update($sql);
         if ($inserted) {

plugins/docman/include/ApprovalTable/NotificationCycle.class.php

Doc Comments +11 added lines

@@ -79,6 +79,9 @@ 
 
     /**
      * Action
+     * @param PFUser $reviewer
+     * @param boolean $isLastReviewer
+     * @param boolean $withComments
      */
     function reviewerApprove($reviewer, $isLastReviewer, $withComments) {
         if($isLastReviewer) {
@@ -96,6 +99,7 @@ 
 
     /**
      * Action
+     * @param PFUser $reviewer
      */
     function reviewerReject($reviewer) {
         $this->sendNotifRejected($reviewer);
@@ -104,6 +108,8 @@ 
 
     /**
      * Action
+     * @param PFUser $reviewer
+     * @param boolean $isLastReviewer
      */
     function reviewerDecline($reviewer, $isLastReviewer) {
         $this->sendNotifReviewDeclined($reviewer);
@@ -115,6 +121,7 @@ 
 
     /**
      * Action
+     * @param PFUser $reviewer
      */
     function reviewerComment($reviewer) {
         $this->sendNotifReviewCommented($reviewer);
@@ -210,6 +217,7 @@ 
     /**
      * Update item status according to parameters.
      * Not in use today.
+     * @param integer $status
      */
     function changeItemStatus($reviewer, $status) {
        // TBD
@@ -521,6 +529,9 @@ 
         return $this->table;
     }
 
+    /**
+     * @param PFUser $owner
+     */
     function setOwner(&$owner) {
         $this->owner = $owner;
     }

plugins/docman/include/ApprovalTable/Reminder.class.php

Doc Comments +2 added lines, -3 removed lines

@@ -98,7 +98,7 @@ 
      *
      * @param Docman_ApprovalTable $table Approval table
      *
-     * @return Boolean
+     * @return null|boolean
      */
     private function notifyNextReviewer(Docman_ApprovalTable $table) {
         $dao = new Docman_ApprovalTableReviewerDao(CodendiDataAccess::instance());
@@ -121,7 +121,7 @@ 
      * @param Docman_ApprovalTable $table      Approval table
      * @param Integer              $reviewerId Id of the reviewer
      *
-     * @return Boolean
+     * @return null|boolean
      */
     private function notifyIndividual(Docman_ApprovalTable $table, $reviewerId) {
         $hp       = Codendi_HTMLPurifier::instance();
@@ -191,7 +191,6 @@ 
     /**
      * Retrieve url to access a given docman item
      *
-     * @param Docman_Item $table The approval table that its reminder notification will be sent
      *
      * @return String
      */

plugins/docman/include/ApprovalTable/Reviewer/Reviewer.class.php

Doc Comments +3 added lines

@@ -51,6 +51,9 @@
         return $this->rank;
     }
 
+    /**
+     * @param integer|null $v
+     */
     function setReviewDate($v) {
         $this->reviewDate = $v;
     }

plugins/docman/include/ApprovalTable/Reviewer/ReviewerDao.class.php

Doc Comments +11 added lines

@@ -76,6 +76,9 @@ 
         return parent::prepareRanking($userId, $tableId, $rank, 'reviewer_id', 'table_id');
     }
 
+    /**
+     * @param integer $userId
+     */
     function addUser($tableId, $userId) {
         $newRank = $this->prepareUserRanking($tableId, $userId, 'end');
         $sql = sprintf('INSERT INTO plugin_docman_approval_user'.
@@ -146,6 +149,11 @@ 
         return $this->_copyReviewers($srcTableId, $dstTableId, 'NULL', 0, "''", 'NULL');
     }
 
+    /**
+     * @param string $date
+     * @param string $comment
+     * @param string $version
+     */
     function _copyReviewers($srcTableId, $dstTableId, $date, $state, $comment, $version) {
         $sql = 'INSERT INTO plugin_docman_approval_user'.
             '(table_id, reviewer_id, rank, date, state, comment, version) '.
@@ -158,6 +166,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $state
+     */
     function getAllReviewsForUserByState($userId, $state) {
         // Item
         $sql_item = 'SELECT u.table_id, i.item_id, i.group_id, t.date, i.title, g.group_name'.

plugins/docman/include/ApprovalTable/Reviewer/ReviewerFactory.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -237,7 +237,7 @@ 
     /**
      * Add members of the given ugroup to the reviewer list.
      *
-     * @return true if at least one user was added to the list.
+     * @return boolean if at least one user was added to the list.
      */
     function addUgroup($ugroupId) {
         $nbUserAdded = 0;
@@ -316,6 +316,7 @@ 
 
     /**
      *
+     * @param integer $newTableId
      */
     function newTableCopy($newTableId) {
         $dao = $this->_getDao();
@@ -324,6 +325,7 @@ 
 
     /**
      *
+     * @param integer $newTableId
      */
     function newTableReset($newTableId) {
         $dao = $this->_getDao();

plugins/docman/include/ApprovalTable/Wiki/WikiDao.class.php

Doc Comments +2 added lines

@@ -105,6 +105,8 @@
 
     /**
      * Did user access the wiki since the given version was published.
+     * @param integer $groupId
+     * @param integer $versionId
      */
     function userAccessedSince($userId, $pageName, $groupId, $versionId) {
         $sql  = 'SELECT NULL'.

plugins/docman/include/ApprovalTable/Wiki/WikiFactory.class.php

Doc Comments +4 added lines

@@ -45,6 +45,7 @@ 
      * If there is no approval table linked to the item, pick-up the last
      * version id of the wiki page.
      * If there is no version for the given wiki page, default to 0.
+     * @param Docman_Wiki $item
      */
     function __construct($item, $versionNumber=null) {
         parent::__construct($item);
@@ -106,6 +107,9 @@ 
         return $this->getTableFromVersion($this->item->getId(), $this->wikiVersionId);
     }
 
+    /**
+     * @param integer $version
+     */
     function getTableFromVersion($itemId, $version) {
         $table = null;
         if($version !== null) {

plugins/docman/include/Docman_Actions.class.php

Doc Comments +9 added lines, -2 removed lines

@@ -76,6 +76,9 @@ 
         return $ret_id;
     }
 
+    /**
+     * @param string $field
+     */
     private function _raiseMetadataChangeEvent(&$user, &$item, $group_id, $old, $new, $field) {
         $logEventParam = array('group_id' => $group_id,
                                'item'     => &$item,
@@ -1173,8 +1176,8 @@ 
     * The force parameter must be set to true if you want to bypass permissions checking (@see permission_add_ugroup).
     * Pretty difficult to know if a user can update the permissions which does not exist for a new item...
     *
-    * @param $group_id integer The id of the project
-    * @param $item_id integer The id of the item
+    * @param integer $group_id integer The id of the project
+    * @param integer $item_id integer The id of the item
     * @param $permission_definition array The definission of the permission (pretty name, relations between perms, internal name, ...)
     * @param $old_permissions array The permissions before
     * @param &$done_permissions array The permissions after
@@ -1862,6 +1865,7 @@ 
 
     /**
      * @access private
+     * @param Docman_ApprovalTableReviewerFactory $atrf
      */
     function _approval_update_add_users($atrf, $usUserList, $sUgroups) {
         $noError = true;
@@ -1929,6 +1933,7 @@ 
 
     /**
      * @access private
+     * @param Docman_ApprovalTableReviewerFactory $atrf
      */
     function _approval_update_del_users($atrf, $selectedUsers) {
         $deletedUsers = 0;
@@ -1947,6 +1952,7 @@ 
 
     /**
      * @access private
+     * @param Docman_ApprovalTableReviewerFactory $atrf
      */
     function _approval_update_notify_users($atrf, $selectedUsers) {
         $notifiedUsers = 0;
@@ -1972,6 +1978,7 @@ 
 
     /**
      * @access private
+     * @param Docman_ApprovalTableReviewerFactory $atrf
      */
     function _approval_update_notif_resend($atrf) {
         $res = $atrf->notifyReviewers();