Enalean / tuleap

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact.class.php

Doc Comments +26 added lines, -8 removed lines

@@ -132,7 +132,7 @@ 
     *
     * @param bool $use_artifact_permissions
     *
-    * @return bool true if the artifact has individual permissions set
+    * @return boolean|null true if the artifact has individual permissions set
     */
     public function setUseArtifactPermissions($use_artifact_permissions) {
         $this->use_artifact_permissions = $use_artifact_permissions;
@@ -175,6 +175,9 @@ 
         return $this->can_view_cache[$user->getId()];
     }
 
+    /**
+     * @param boolean $can_view
+     */
     public function setUserCanView(PFUser $user, $can_view) {
         $this->can_view_cache[$user->getId()] = $can_view;
     }
@@ -226,6 +229,7 @@ 
      * @param array  $recipient
      * @param string $format, the mail format text or html
      * @param bool   $ignore_perms, indicates if we ignore various permissions
+     * @param string $format
      *
      * @return string
      */
@@ -290,7 +294,8 @@ 
         return $output;
     }
 
-    /** @param Tracker_FormElement[] */
+    /** @param Tracker_FormElement[]
+* @param Tracker_FormElement $toplevel_form_elements */
     private function prepareElementsForDisplay($toplevel_form_elements) {
         foreach ($toplevel_form_elements as $formElement) {
             $formElement->prepareForDisplay();
@@ -418,6 +423,9 @@ 
         return $this->fetchTitleContent($prefix, true);
     }
 
+    /**
+     * @param boolean $unsubscribe_button
+     */
     private function fetchTitleContent($prefix = '', $unsubscribe_button) {
         $html = '';
         $html .= $this->fetchHiddenTrackerId();
@@ -653,6 +661,7 @@ 
      * Returns HTML code to display the artifact history
      *
      * @param Codendi_Request $request The data from the user
+     * @param string $comment_format_field_name
      *
      * @return String The valid followup comment format
      */
@@ -838,6 +847,9 @@ 
         $GLOBALS['Response']->sendStatusCode(403);
     }
 
+    /**
+     * @param integer $milestone_id
+     */
     private function userHasRankingPermissions($milestone_id) {
         $user_is_authorized = true;
 
@@ -1058,7 +1070,7 @@ 
      *
      * @throws Tracker_Exception In the validation
      * @throws Tracker_NoChangeException In the validation
-     * @return Tracker_Artifact_Changeset|Boolean The new changeset if update is done without error, false otherwise
+     * @return Tracker_Artifact_Changeset The new changeset if update is done without error, false otherwise
      */
     public function createNewChangeset($fields_data, $comment, PFUser $submitter, $send_notification = true, $comment_format = Tracker_Artifact_Changeset_Comment::TEXT_COMMENT) {
         $submitted_on = $_SERVER['REQUEST_TIME'];
@@ -1474,7 +1486,7 @@ 
      * @param int  $linked_artifact_id The id of the artifact to link
      * @param PFUser $current_user       The user who made the link
      *
-     * @return bool true if success false otherwise
+     * @return boolean|null true if success false otherwise
      */
     public function linkArtifact($linked_artifact_id, PFUser $current_user) {
         $artlink_fields = $this->getFormElementFactory()->getUsedArtifactLinkFields($this->getTracker());
@@ -1505,7 +1517,7 @@ 
      * @param array  $linked_artifact_ids The ids of the artifacts to link
      * @param PFUser $current_user       The user who made the link
      *
-     * @return bool true if success false otherwise
+     * @return boolean|null true if success false otherwise
      */
     public function linkArtifacts($linked_artifact_ids, PFUser $current_user) {
         $linked_artifact_ids = implode(',', $linked_artifact_ids);
@@ -1570,7 +1582,7 @@ 
      *
      * @param PFUser $user The user who should see the artifacts
      *
-     * @return Array of Tracker_Artifact
+     * @return Tracker_Artifact[] of Tracker_Artifact
      */
     public function getLinkedArtifactsOfHierarchy(PFUser $user) {
         $artifact_links = $this->getLinkedArtifacts($user);
@@ -1611,7 +1623,7 @@ 
      *
      * @param PFUser $user The user who should see the artifacts
      *
-     * @return Array of Tracker_Artifact
+     * @return Tracker_Artifact[] of Tracker_Artifact
      */
     public function getUniqueLinkedArtifacts(PFUser $user) {
         $sub_artifacts = $this->getLinkedArtifacts($user);
@@ -1678,6 +1690,9 @@ 
         return $this->parent_without_permission_checking;
     }
 
+    /**
+     * @param Tracker_Artifact $parent
+     */
     public function setParentWithoutPermissionChecking($parent) {
         $this->parent_without_permission_checking = $parent;
     }
@@ -1717,6 +1732,9 @@ 
         return $this->siblings_without_permission_checking;
     }
 
+    /**
+     * @param ArrayIterator $siblings
+     */
     public function setSiblingsWithoutPermissionChecking($siblings) {
         $this->siblings_without_permission_checking = $siblings;
     }
@@ -1765,7 +1783,7 @@ 
     /**
      * Return the first BurndownField (if any)
      *
-     * @return Tracker_FormElement_Field_Burndown
+     * @return Tracker_FormElement_Field_ArtifactLink
      */
     public function getABurndownField(PFUser $user) {
         return $this->getFormElementFactory()->getABurndownField($user, $this->getTracker());

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_Changeset.class.php

Doc Comments +28 added lines, -3 removed lines

@@ -361,6 +361,11 @@ 
     // display such changesets as if they were only containing changes,
     // so we introduced this function to determine wether we're in this
     // case or not.
+
+    /**
+     * @param string $changes
+     * @param Tracker_Artifact_Changeset_Comment|null $comment
+     */
     private function shouldBeDisplayedAsChange($changes, $comment) {
         if ($comment) {
             // Not comment AND no changes
@@ -499,7 +504,7 @@ 
     /**
      * Returns the comment dao
      *
-     * @return Tracker_Artifact_ChangesetCommentDao The dao
+     * @return Tracker_Artifact_Changeset_CommentDao The dao
      */
     protected function getCommentDao() {
         return new Tracker_Artifact_Changeset_CommentDao();
@@ -606,6 +611,7 @@ 
     * Display diff messsage
     *
     * @param String $diff
+    * @param string $format
     *
     */
     public function displayDiff($diff, $format, $field) {
@@ -706,6 +712,9 @@ 
         }
     }
 
+    /**
+     * @param boolean $is_update
+     */
     public function buildOneMessageForMultipleRecipients(array $recipients, $is_update) {
         $messages = array();
         foreach ($recipients as $recipient => $check_perms) {
@@ -735,6 +744,9 @@ 
         return $messages;
     }
 
+    /**
+     * @param boolean $is_update
+     */
     public function buildAMessagePerRecipient(array $recipients, $is_update) {
         $messages       = array();
         $anonymous_mail = 0;
@@ -807,6 +819,9 @@ 
         }
     }
 
+    /**
+     * @param PFUser $user
+     */
     private function getMessageContent($user, $is_update, $check_perms) {
         $ignore_perms = !$check_perms;
 
@@ -925,6 +940,9 @@ 
         );
     }
 
+    /**
+     * @param string $tracker_name
+     */
     private function getTextBodyFilter($project_name, $tracker_name) {
         $project_filter = '=PROJECT='.$project_name;
         $tracker_filter = '=TRACKER='.$tracker_name;
@@ -932,6 +950,9 @@ 
         return PHP_EOL . $project_filter . PHP_EOL . $tracker_filter . PHP_EOL;
     }
 
+    /**
+     * @param string $tracker_name
+     */
     private function getHTMLBodyFilter($project_name, $tracker_name) {
         $filter  = '<div style="display: none !important;">';
         $filter .= '=PROJECT=' . $project_name . '<br>';
@@ -1072,7 +1093,7 @@ 
      * Get the text body for notification
      *
      * @param Boolean $is_update    It is an update, not a new artifact
-     * @param String  $recipient    The recipient who will receive the notification
+     * @param String  $recipient_user    The recipient who will receive the notification
      * @param BaseLanguage $language The language of the message
      * @param Boolean $ignore_perms indicates if permissions have to be ignored
      *
@@ -1112,7 +1133,7 @@ 
      * Get the html body for notification
      *
      * @param Boolean $is_update    It is an update, not a new artifact
-     * @param String  $recipient    The recipient who will receive the notification
+     * @param String  $recipient_user    The recipient who will receive the notification
      * @param BaseLanguage $language The language of the message
      * @param Boolean $ignore_perms ???
      *
@@ -1195,6 +1216,7 @@ 
     }
 
     /**
+     * @param string $artifact_link
      * @return string html call to action button to include in an html mail
      */
     private function fetchHtmlAnswerButton($artifact_link) {
@@ -1302,6 +1324,9 @@ 
         return $soap;
     }
 
+    /**
+     * @param string $fields
+     */
     public function getRESTValue(PFUser $user, $fields) {
         $comment = $this->getComment();
         if (! $comment) {

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_Changeset_Null.class.php

Doc Comments +3 added lines, -3 removed lines

@@ -120,7 +120,7 @@ 
     /**
      * Return diff between this changeset and previous one (HTML code)
      *
-     * @return string The field difference between the previous changeset. or false if no changes
+     * @return boolean The field difference between the previous changeset. or false if no changes
      */
     public function diffToPrevious($format='html', $user=null, $ignore_perms=false) {
         return false;
@@ -155,7 +155,7 @@ 
      * Get the body for notification
      *
      * @param bool   $is_update It is an update, not a new artifact
-     * @param string $recipient The recipient who will receive the notification
+     * @param string $recipient_user The recipient who will receive the notification
      *
      * @return string
      */
@@ -167,7 +167,7 @@ 
      * Get the body for notification
      *
      * @param bool   $is_update It is an update, not a new artifact
-     * @param string $recipient The recipient who will receive the notification
+     * @param string $recipient_user The recipient who will receive the notification
      *
      * @return string
      */

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_ChangesetValue_ArtifactLink.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -218,7 +218,7 @@ 
     /**
      * Returns the value of this changeset value
      *
-     * @return mixed The value of this artifact changeset value
+     * @return Tracker_ArtifactLinkInfo[] The value of this artifact changeset value
      */
     public function getValue() {
         return $this->artifact_links;
@@ -258,6 +258,9 @@ 
         return $reverse_artifact_links_user_can_see;
     }
 
+    /**
+     * @param null|PFUser $user
+     */
     private function setCurrentUserIfUserIsNotDefined(&$user) {
         if (! isset($user)) {
             $user = $this->user_manager->getCurrentUser();

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_ChangesetValue_ArtifactLinkDiff.class.php

Doc Comments +3 added lines

@@ -144,6 +144,9 @@
         return $this->getFormatted($this->getRemovedUserCanSee($user), $format);
     }
 
+    /**
+     * @param string $format
+     */
     private function getFormatted(array $array, $format) {
         $method = 'getLabel';
         if ($format === 'html') {

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_ChangesetValue_Date.class.php

Doc Comments +1 added lines

@@ -35,6 +35,7 @@
      * @param Tracker_FormElement_Field_Date $field       The field of the value
      * @param boolean                        $has_changed If the changeset value has chnged from the previous one
      * @param int                            $timestamp   The date
+     * @param integer|null $id
      */
     public function __construct($id, $field, $has_changed, $timestamp) {
         parent::__construct($id, $field, $has_changed);

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_ChangesetValue_File.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -35,6 +35,7 @@ 
      * @param Tracker_FormElement_Field_File $field       The field of the value
      * @param boolean                        $has_changed If the changeset value has chnged from the previous one
      * @param array                          $files       array of Tracker_FileInfo
+     * @param integer $id
      */
     public function __construct($id, $field, $has_changed, $files) {
         parent::__construct($id, $field, $has_changed);
@@ -207,7 +208,7 @@ 
     /**
      * Returns the value of this changeset value
      *
-     * @return mixed The value of this artifact changeset value
+     * @return boolean The value of this artifact changeset value
      */
     public function getValue() {
         // TODO : implement

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_ChangesetValue_Float.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
     /**
      * Get the Json value
      *
-     * @return string The value of this artifact changeset value in Json format
+     * @return double|null The value of this artifact changeset value in Json format
      */
     public function getJsonValue() {
         return $this->getFloat();

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_ChangesetValue_List.class.php

Doc Comments +9 added lines

@@ -268,6 +268,9 @@ 
         return $this->getChangesSentence($previous, $next, $added, $removed);
     }
 
+    /**
+     * @param string $format
+     */
     private function getAdded(array $previous, array $next, $format) {
         $added_elements = array_diff($next, $previous);
         $added_arr = array();
@@ -279,6 +282,9 @@ 
         return $this->format(implode(', ', $added_arr), $format);
     }
 
+    /**
+     * @param string $format
+     */
     private function getRemoved(array $previous, array $next, $format) {
         $removed_elements = array_diff($previous, $next);
         $removed_arr = array();
@@ -290,6 +296,9 @@ 
         return $this->format(implode(', ', $removed_arr), $format);
     }
 
+    /**
+     * @param string $value
+     */
     private function format($value, $format) {
         if ($format === 'text') {
             return $value;