@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.) hq.recaptime.dev/wiki/Phorge
phorge phabricator

PHPDoc: Replace "@return this" with "@return $this"

Summary:
Per https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md the valid keyword is `$this`.
Thus replace `this` to make output of static code analysis slightly less noisy.

(See rARC4b7ee1985b3c15b4af81b5480522ae24c0afd6a2 for its Arcanist counterpart.)

Test Plan: Read the docs.

Reviewers: O1 Blessed Committers, valerio.bozzolan

Reviewed By: O1 Blessed Committers, valerio.bozzolan

Subscribers: tobiaswiese, valerio.bozzolan, Matthew, Cigaryno

Differential Revision: https://we.phorge.it/D25819

+140 -140
+3 -3
src/aphront/AphrontRequest.php
··· 539 539 * 540 540 * @param string $name Cookie name. 541 541 * @param string $value Cookie value. 542 - * @return this 542 + * @return $this 543 543 * @task cookie 544 544 */ 545 545 public function setCookie($name, $value) { ··· 555 555 * 556 556 * @param string $name Cookie name. 557 557 * @param string $value Cookie value. 558 - * @return this 558 + * @return $this 559 559 * @task cookie 560 560 */ 561 561 public function setTemporaryCookie($name, $value) { ··· 569 569 * @param string $name Cookie name. 570 570 * @param string $value Cookie value. 571 571 * @param int $expire Epoch timestamp for cookie expiration. 572 - * @return this 572 + * @return $this 573 573 * @task cookie 574 574 */ 575 575 private function setCookieWithExpiration(
+1 -1
src/aphront/httpparametertype/AphrontHTTPParameterType.php
··· 32 32 * to use the current viewer to execute queries. 33 33 * 34 34 * @param PhabricatorUser $viewer Current viewer. 35 - * @return this 35 + * @return $this 36 36 * @task read 37 37 */ 38 38 final public function setViewer(PhabricatorUser $viewer) {
+1 -1
src/aphront/writeguard/AphrontWriteGuard.php
··· 58 58 * valid token isn't present. 59 59 * 60 60 * @param $callback Callable CSRF callback. 61 - * @return this 61 + * @return $this 62 62 * @task manage 63 63 */ 64 64 public function __construct($callback) {
+1 -1
src/applications/conduit/protocol/exception/ConduitException.php
··· 13 13 * an exception (e.g., which values were wrong in an invalid request). 14 14 * 15 15 * @param string $error_description Detailed error description. 16 - * @return this 16 + * @return $this 17 17 */ 18 18 final public function setErrorDescription($error_description) { 19 19 $this->errorDescription = $error_description;
+1 -1
src/applications/config/issue/PhabricatorSetupIssue.php
··· 147 147 * 148 148 * @param string $php_config PHP configuration option to provide a value for. 149 149 * @param string $value Explicit value to show in the UI. 150 - * @return this 150 + * @return $this 151 151 */ 152 152 public function addPHPConfigOriginalValue($php_config, $value) { 153 153 $this->originalPHPConfigValues[$php_config] = $value;
+2 -2
src/applications/differential/parser/DifferentialChangesetParser.php
··· 246 246 * storage changeset. Note that this may be false, if the left 247 247 * side of some storage changeset is being shown as the right 248 248 * side of a display diff. 249 - * @return this 249 + * @return $this 250 250 */ 251 251 public function setRightSideCommentMapping($id, $is_new) { 252 252 $this->rightSideChangesetID = $id; ··· 297 297 * 298 298 * @param string $key Key for identifying this changeset in the render 299 299 * cache. 300 - * @return this 300 + * @return $this 301 301 */ 302 302 public function setRenderCacheKey($key) { 303 303 $this->renderCacheKey = $key;
+15 -15
src/applications/differential/query/DifferentialRevisionQuery.php
··· 46 46 * Find revisions affecting one or more items in a list of paths. 47 47 * 48 48 * @param list<string> $paths List of file paths. 49 - * @return this 49 + * @return $this 50 50 * @task config 51 51 */ 52 52 public function withPaths(array $paths) { ··· 60 60 * @{method:withAuthors}. 61 61 * 62 62 * @param array $author_phids List of PHIDs of authors 63 - * @return this 63 + * @return $this 64 64 * @task config 65 65 */ 66 66 public function withAuthors(array $author_phids) { ··· 73 73 * function will clear anything set by previous calls to @{method:withCCs}. 74 74 * 75 75 * @param array $cc_phids List of PHIDs of subscribers. 76 - * @return this 76 + * @return $this 77 77 * @task config 78 78 */ 79 79 public function withCCs(array $cc_phids) { ··· 87 87 * to @{method:withReviewers}. 88 88 * 89 89 * @param array $reviewer_phids List of PHIDs of reviewers 90 - * @return this 90 + * @return $this 91 91 * @task config 92 92 */ 93 93 public function withReviewers(array $reviewer_phids) { ··· 127 127 * @param array $commit_hashes List of pairs <Class 128 128 * ArcanistDifferentialRevisionHash::HASH_$type constant, 129 129 * hash> 130 - * @return this 130 + * @return $this 131 131 * @task config 132 132 */ 133 133 public function withCommitHashes(array $commit_hashes) { ··· 150 150 * Filter results to revisions on given branches. 151 151 * 152 152 * @param list $branches List of branch names. 153 - * @return this 153 + * @return $this 154 154 * @task config 155 155 */ 156 156 public function withBranches(array $branches) { ··· 163 163 * Filter results to only return revisions whose ids are in the given set. 164 164 * 165 165 * @param array $ids List of revision ids 166 - * @return this 166 + * @return $this 167 167 * @task config 168 168 */ 169 169 public function withIDs(array $ids) { ··· 176 176 * Filter results to only return revisions whose PHIDs are in the given set. 177 177 * 178 178 * @param array $phids List of revision PHIDs 179 - * @return this 179 + * @return $this 180 180 * @task config 181 181 */ 182 182 public function withPHIDs(array $phids) { ··· 190 190 * responsible for (i.e., they are either authors or reviewers). 191 191 * 192 192 * @param array $responsible_phids List of user PHIDs. 193 - * @return this 193 + * @return $this 194 194 * @task config 195 195 */ 196 196 public function withResponsibleUsers(array $responsible_phids) { ··· 222 222 * revision. 223 223 * 224 224 * @param bool $need_active_diffs True to load and attach diffs. 225 - * @return this 225 + * @return $this 226 226 * @task config 227 227 */ 228 228 public function needActiveDiffs($need_active_diffs) { ··· 236 236 * each revision. 237 237 * 238 238 * @param bool $need_commit_phids True to load and attach diffs. 239 - * @return this 239 + * @return $this 240 240 * @task config 241 241 */ 242 242 public function needCommitPHIDs($need_commit_phids) { ··· 250 250 * revision. 251 251 * 252 252 * @param bool $need_diff_ids True to load and attach diff IDs. 253 - * @return this 253 + * @return $this 254 254 * @task config 255 255 */ 256 256 public function needDiffIDs($need_diff_ids) { ··· 264 264 * revision. 265 265 * 266 266 * @param bool $need_hashes True to load and attach commit hashes. 267 - * @return this 267 + * @return $this 268 268 * @task config 269 269 */ 270 270 public function needHashes($need_hashes) { ··· 277 277 * Set whether or not the query should load associated reviewers. 278 278 * 279 279 * @param bool $need_reviewers True to load and attach reviewers. 280 - * @return this 280 + * @return $this 281 281 * @task config 282 282 */ 283 283 public function needReviewers($need_reviewers) { ··· 292 292 * they are a member of. 293 293 * 294 294 * @param bool $need_reviewer_authority True to load and attach authority. 295 - * @return this 295 + * @return $this 296 296 * @task config 297 297 */ 298 298 public function needReviewerAuthority($need_reviewer_authority) {
+1 -1
src/applications/diffusion/request/DiffusionRequest.php
··· 296 296 * Modify the request to move the symbolic commit elsewhere. 297 297 * 298 298 * @param string $symbol New symbolic commit. 299 - * @return this 299 + * @return $this 300 300 */ 301 301 public function updateSymbolicCommit($symbol) { 302 302 $this->symbolicCommit = $symbol;
+1 -1
src/applications/diviner/query/DivinerAtomQuery.php
··· 94 94 * restore the original data. 95 95 * 96 96 * @param bool $ghosts 97 - * @return this 97 + * @return $this 98 98 */ 99 99 public function withGhosts($ghosts) { 100 100 $this->isGhost = $ghosts;
+1 -1
src/applications/doorkeeper/engine/DoorkeeperFeedStoryPublisher.php
··· 33 33 * 34 34 * @param bool $render_with_implied_context True to assume object context 35 35 * when rendering. 36 - * @return this 36 + * @return $this 37 37 * @task config 38 38 */ 39 39 public function setRenderWithImpliedContext($render_with_implied_context) {
+1 -1
src/applications/drydock/storage/DrydockLease.php
··· 511 511 /** 512 512 * Awaken yielded tasks after a state change. 513 513 * 514 - * @return this 514 + * @return $this 515 515 */ 516 516 public function awakenTasks() { 517 517 $awaken_ids = $this->getAttribute('internal.awakenTaskIDs');
+1 -1
src/applications/files/query/PhabricatorFileQuery.php
··· 98 98 * 99 99 * @param list<dict> $specs List of transform specifications, described 100 100 * above. 101 - * @return this 101 + * @return $this 102 102 */ 103 103 public function withTransforms(array $specs) { 104 104 foreach ($specs as $spec) {
+2 -2
src/applications/files/storage/PhabricatorFile.php
··· 1472 1472 * This method is successful even if the file is already attached. 1473 1473 * 1474 1474 * @param phid $phid Object PHID to attach to. 1475 - * @return this 1475 + * @return $this 1476 1476 */ 1477 1477 public function attachToObject($phid) { 1478 1478 self::attachFileToObject($this->getPHID(), $phid); ··· 1526 1526 * 1527 1527 * @param map<string, wild> $params Bag of parameters, see 1528 1528 * @{class:PhabricatorFile} for documentation. 1529 - * @return this 1529 + * @return $this 1530 1530 */ 1531 1531 private function readPropertiesFromParameters(array $params) { 1532 1532 PhutilTypeSpec::checkMap(
+1 -1
src/applications/herald/adapter/HeraldAdapter.php
··· 173 173 * 174 174 * @param list<PhabricatorApplicationTransaction> $xactions List of 175 175 * transactions. 176 - * @return this 176 + * @return $this 177 177 */ 178 178 final public function setAppliedTransactions(array $xactions) { 179 179 assert_instances_of($xactions, 'PhabricatorApplicationTransaction');
+7 -7
src/applications/metamta/storage/PhabricatorMetaMTAMail.php
··· 89 89 * of mail, like updates when a task's projects change. 90 90 * 91 91 * @param list<const> $tags 92 - * @return this 92 + * @return $this 93 93 */ 94 94 public function setMailTags(array $tags) { 95 95 $this->setParam('mailtags', array_unique($tags)); ··· 110 110 * T251 for more details. 111 111 * 112 112 * @param string $id The "Message-ID" of the email which precedes this one. 113 - * @return this 113 + * @return $this 114 114 */ 115 115 public function setParentMessageID($id) { 116 116 $this->setParam('parent-message-id', $id); ··· 420 420 * receive things like password resets. 421 421 * 422 422 * @param bool $force True to force delivery despite user preferences. 423 - * @return this 423 + * @return $this 424 424 */ 425 425 public function setForceDelivery($force) { 426 426 $this->setParam('force', $force); ··· 438 438 * dependent. 439 439 * 440 440 * @param bool $is_bulk True if the mail is automated bulk mail. 441 - * @return this 441 + * @return $this 442 442 */ 443 443 public function setIsBulk($is_bulk) { 444 444 $this->setParam('is-bulk', $is_bulk); ··· 458 458 * Message-ID, In-Reply-To or References headers. 459 459 * @param bool $is_first_message (optional) If true, indicates this is the 460 460 * first message in the thread. 461 - * @return this 461 + * @return $this 462 462 */ 463 463 public function setThreadID($thread_id, $is_first_message = false) { 464 464 $this->setParam('thread-id', $thread_id); ··· 478 478 * Save a newly created mail to the database. The mail will eventually be 479 479 * delivered by the MetaMTA daemon. 480 480 * 481 - * @return this 481 + * @return $this 482 482 */ 483 483 public function saveAndSend() { 484 484 return $this->save(); 485 485 } 486 486 487 487 /** 488 - * @return this 488 + * @return $this 489 489 */ 490 490 public function save() { 491 491 if ($this->getID()) {
+3 -3
src/applications/metamta/view/PhabricatorMetaMTAMailBody.php
··· 41 41 * Add a raw block of text to the email. This will be rendered as-is. 42 42 * 43 43 * @param string $text Block of text. 44 - * @return this 44 + * @return $this 45 45 * @task compose 46 46 */ 47 47 public function addRawSection($text) { ··· 102 102 * 103 103 * @param string $header Header text. 104 104 * @param string $section Section text. 105 - * @return this 105 + * @return $this 106 106 * @task compose 107 107 */ 108 108 public function addTextSection($header, $section) { ··· 156 156 * Add an attachment. 157 157 * 158 158 * @param PhabricatorMailAttachment $attachment Attachment. 159 - * @return this 159 + * @return $this 160 160 * @task compose 161 161 */ 162 162 public function addAttachment(PhabricatorMailAttachment $attachment) {
+1 -1
src/applications/notification/query/PhabricatorNotificationQuery.php
··· 33 33 * 34 34 * @param mixed $unread True or false to filter results by read status. Null 35 35 * to remove the filter. 36 - * @return this 36 + * @return $this 37 37 * @task config 38 38 */ 39 39 public function withUnread($unread) {
+2 -2
src/applications/people/storage/PhabricatorUser.php
··· 478 478 * This is primarily useful for unit tests. 479 479 * 480 480 * @param string $identifier New timezone identifier. 481 - * @return this 481 + * @return $this 482 482 * @task settings 483 483 */ 484 484 public function overrideTimezoneIdentifier($identifier) { ··· 772 772 * 773 773 * @param wild $availability Availability cache data. 774 774 * @param int|null $ttl Cache TTL. 775 - * @return this 775 + * @return $this 776 776 * @task availability 777 777 */ 778 778 public function writeAvailabilityCache(array $availability, $ttl) {
+2 -2
src/applications/people/storage/PhabricatorUserEmail.php
··· 181 181 * Send a verification email from $user to this address. 182 182 * 183 183 * @param PhabricatorUser $user The user sending the verification. 184 - * @return this 184 + * @return $this 185 185 * @task email 186 186 */ 187 187 public function sendVerificationEmail(PhabricatorUser $user) { ··· 270 270 * recipient that this is now their account's new primary email address. 271 271 * 272 272 * @param PhabricatorUser $user The user sending the verification. 273 - * @return this 273 + * @return $this 274 274 * @task email 275 275 */ 276 276 public function sendNewPrimaryEmail(PhabricatorUser $user) {
+1 -1
src/applications/phid/PhabricatorObjectHandle.php
··· 276 276 * @{method:isComplete} for an explanation of what it means to be complete. 277 277 * 278 278 * @param bool $complete True if the handle represents a complete object. 279 - * @return this 279 + * @return $this 280 280 */ 281 281 public function setComplete($complete) { 282 282 $this->complete = $complete;
+1 -1
src/applications/phortune/currency/PhortuneCurrency.php
··· 197 197 * 198 198 * @param string|null Currency string, or null to skip check. 199 199 * @param string|null Currency string, or null to skip check. 200 - * @return this 200 + * @return $this 201 201 */ 202 202 public function assertInRange($minimum, $maximum) { 203 203 if ($minimum !== null && $maximum !== null) {
+1 -1
src/applications/phortune/query/PhortuneCartQuery.php
··· 48 48 * Include or exclude carts which represent invoices with payments due. 49 49 * 50 50 * @param bool `true` to select invoices; `false` to exclude invoices. 51 - * @return this 51 + * @return $this 52 52 */ 53 53 public function withInvoices($invoices) { 54 54 $this->invoices = $invoices;
+7 -7
src/applications/search/field/PhabricatorSearchField.php
··· 34 34 * does not contain any special characters. 35 35 * 36 36 * @param string $key Unique key which identifies the field. 37 - * @return this 37 + * @return $this 38 38 * @task config 39 39 */ 40 40 public function setKey($key) { ··· 60 60 * This should be a short text string, like "Reviewers" or "Colors". 61 61 * 62 62 * @param string $label Short, human-readable field label. 63 - * @return this 63 + * @return $this 64 64 * task config 65 65 */ 66 66 public function setLabel($label) { ··· 87 87 * behalf by the caller. 88 88 * 89 89 * @param PhabricatorUser $viewer Viewer. 90 - * @return this 90 + * @return $this 91 91 * @task config 92 92 */ 93 93 public function setViewer(PhabricatorUser $viewer) { ··· 116 116 * `&authorPHIDs=alincoln`. This is a little easier to use. 117 117 * 118 118 * @param list<string> $aliases List of aliases for this field. 119 - * @return this 119 + * @return $this 120 120 * @task config 121 121 */ 122 122 public function setAliases(array $aliases) { ··· 143 143 * If no key is provided, the main key is used. 144 144 * 145 145 * @param string $conduit_key Alternate key for Conduit. 146 - * @return this 146 + * @return $this 147 147 * @task config 148 148 */ 149 149 public function setConduitKey($conduit_key) { ··· 171 171 * Set a human-readable description for this field. 172 172 * 173 173 * @param string $description Human-readable description. 174 - * @return this 174 + * @return $this 175 175 * @task config 176 176 */ 177 177 public function setDescription($description) { ··· 195 195 * Hide this field from the web UI. 196 196 * 197 197 * @param bool $is_hidden True to hide the field from the web UI. 198 - * @return this 198 + * @return $this 199 199 * @task config 200 200 */ 201 201 public function setIsHidden($is_hidden) {
+3 -3
src/applications/subscriptions/editor/PhabricatorSubscriptionsEditor.php
··· 19 19 * had previously unsubscribed. 20 20 * 21 21 * @param list<phid> $phids List of PHIDs to explicitly subscribe. 22 - * @return this 22 + * @return $this 23 23 */ 24 24 public function subscribeExplicit(array $phids) { 25 25 $this->explicitSubscribePHIDs += array_fill_keys($phids, true); ··· 33 33 * suppressed if they've previously unsubscribed from the object. 34 34 * 35 35 * @param list<phid> $phids List of PHIDs to implicitly subscribe. 36 - * @return this 36 + * @return $this 37 37 */ 38 38 public function subscribeImplicit(array $phids) { 39 39 $this->implicitSubscribePHIDs += array_fill_keys($phids, true); ··· 46 46 * will not resubscribe them. 47 47 * 48 48 * @param list<phid> $phids List of PHIDs to unsubscribe. 49 - * @return this 49 + * @return $this 50 50 */ 51 51 public function unsubscribe(array $phids) { 52 52 $this->unsubscribePHIDs += array_fill_keys($phids, true);
+1 -1
src/applications/transactions/editengine/PhabricatorEditEngine.php
··· 699 699 * Flag this workflow as a create or edit. 700 700 * 701 701 * @param bool $is_create True if this is a create workflow. 702 - * @return this 702 + * @return $this 703 703 * @task load 704 704 */ 705 705 private function setIsCreate($is_create) {
+4 -4
src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php
··· 142 142 * 143 143 * @param bool $continue True to drop transactions without effect and 144 144 * continue. 145 - * @return this 145 + * @return $this 146 146 */ 147 147 public function setContinueOnNoEffect($continue) { 148 148 $this->continueOnNoEffect = $continue; ··· 171 171 * 172 172 * @param bool $continue_on_missing_fields True to continue when transactions 173 173 * don't completely satisfy all required fields. 174 - * @return this 174 + * @return $this 175 175 */ 176 176 public function setContinueOnMissingFields($continue_on_missing_fields) { 177 177 $this->continueOnMissingFields = $continue_on_missing_fields; ··· 4603 4603 * 4604 4604 * @param dict<string, wild> $state Editor state, from 4605 4605 @{method:getWorkerState}. 4606 - * @return this 4606 + * @return $this 4607 4607 * @task workers 4608 4608 */ 4609 4609 final public function loadWorkerState(array $state) { ··· 4630 4630 * 4631 4631 * @param dict<string, wild> $state Custom state, 4632 4632 * from @{method:getCustomWorkerState}. 4633 - * @return this 4633 + * @return $this 4634 4634 * @task workers 4635 4635 */ 4636 4636 protected function loadCustomWorkerState(array $state) {
+1 -1
src/infrastructure/cache/PhutilInRequestKeyValueCache.php
··· 27 27 * cache. Setting a limit of `0` disables the cache. 28 28 * 29 29 * @param int $limit Maximum number of items to store in the cache. 30 - * @return this 30 + * @return $this 31 31 */ 32 32 public function setLimit($limit) { 33 33 $this->limit = $limit;
+5 -5
src/infrastructure/cache/PhutilKeyValueCache.php
··· 52 52 * @param string $key Key to set. 53 53 * @param wild $value Value to set. 54 54 * @param int|null $ttl (optional) TTL. 55 - * @return this 55 + * @return $this 56 56 * @task kvimpl 57 57 */ 58 58 final public function setKey($key, $value, $ttl = null) { ··· 65 65 * keys at once. 66 66 * 67 67 * @param string $key Key to delete. 68 - * @return this 68 + * @return $this 69 69 * @task kvimpl 70 70 */ 71 71 final public function deleteKey($key) { ··· 94 94 * 95 95 * @param dict<string, wild> $keys Map of cache keys to values. 96 96 * @param int|null $ttl (optional) TTL for cache keys, in seconds. 97 - * @return this 97 + * @return $this 98 98 * @task kvimpl 99 99 */ 100 100 abstract public function setKeys(array $keys, $ttl = null); ··· 104 104 * Delete a list of keys from the cache. 105 105 * 106 106 * @param list<string> $keys List of keys to delete. 107 - * @return this 107 + * @return $this 108 108 * @task kvimpl 109 109 */ 110 110 abstract public function deleteKeys(array $keys); ··· 113 113 /** 114 114 * Completely destroy all data in the cache. 115 115 * 116 - * @return this 116 + * @return $this 117 117 * @task kvimpl 118 118 */ 119 119 abstract public function destroyCache();
+1 -1
src/infrastructure/cache/PhutilKeyValueCacheProfiler.php
··· 18 18 * Set a profiler for cache operations. 19 19 * 20 20 * @param PhutilServiceProfiler $profiler Service profiler. 21 - * @return this 21 + * @return $this 22 22 * @task kvimpl 23 23 */ 24 24 public function setProfiler(PhutilServiceProfiler $profiler) {
+2 -2
src/infrastructure/cache/PhutilKeyValueCacheStack.php
··· 40 40 * 41 41 * @param list<PhutilKeyValueCache> $caches Ordered list of key-value 42 42 * caches. 43 - * @return this 43 + * @return $this 44 44 * @task config 45 45 */ 46 46 public function setCaches(array $caches) { ··· 64 64 * $stack->getKey('hedgehog'); 65 65 * 66 66 * @param int $ttl TTL in seconds. 67 - * @return this 67 + * @return $this 68 68 * 69 69 * @task config 70 70 */
+1 -1
src/infrastructure/cache/PhutilMemcacheKeyValueCache.php
··· 101 101 * )); 102 102 * 103 103 * @param list<dict> $servers List of server specifications. 104 - * @return this 104 + * @return $this 105 105 * @task memcache 106 106 */ 107 107 public function setServers(array $servers) {
+4 -4
src/infrastructure/customfield/field/PhabricatorCustomField.php
··· 383 383 * discussion of field proxies. 384 384 * 385 385 * @param PhabricatorCustomField $proxy Field implementation. 386 - * @return this 386 + * @return $this 387 387 * @task proxy 388 388 */ 389 389 final public function setProxy(PhabricatorCustomField $proxy) { ··· 423 423 * 424 424 * @param PhabricatorCustomFieldInterface $object The object this field 425 425 * belongs to. 426 - * @return this 426 + * @return $this 427 427 * @task context 428 428 */ 429 429 final public function setObject(PhabricatorCustomFieldInterface $object) { ··· 443 443 * 444 444 * @param PhabricatorCustomFieldInterface $object The object this field 445 445 * belongs to. 446 - * @return this 446 + * @return $this 447 447 * @task context 448 448 */ 449 449 public function readValueFromObject(PhabricatorCustomFieldInterface $object) { ··· 612 612 * @param string|null $value Serialized field representation (from 613 613 * @{method:getValueForStorage}) or null if no value has 614 614 * ever been stored. 615 - * @return this 615 + * @return $this 616 616 * @task storage 617 617 */ 618 618 public function setValueFromStorage($value) {
+2 -2
src/infrastructure/daemon/PhutilDaemon.php
··· 344 344 * that are part of an autoscale pool are continuously busy for a prolonged 345 345 * period of time, the overseer may scale up the pool. 346 346 * 347 - * @return this 347 + * @return $this 348 348 * @task autoscale 349 349 */ 350 350 protected function willBeginWork() { ··· 365 365 * that are part of an autoscale pool are idle for a prolonged period of 366 366 * time, they may exit to scale the pool down. 367 367 * 368 - * @return this 368 + * @return $this 369 369 * @task autoscale 370 370 */ 371 371 protected function willBeginIdle() {
+1 -1
src/infrastructure/daemon/workers/PhabricatorWorker.php
··· 233 233 * @param string $class Task class to queue. 234 234 * @param array $data Data for the followup task. 235 235 * @param array $options (optional) Options for the followup task. 236 - * @return this 236 + * @return $this 237 237 */ 238 238 final protected function queueTask( 239 239 $class,
+1 -1
src/infrastructure/daemon/workers/query/PhabricatorWorkerLeaseQuery.php
··· 60 60 * 61 61 * @param mixed $leased `true` to select only leased tasks, `false` to select 62 62 * only unleased tasks (default), or `null` to select both. 63 - * @return this 63 + * @return $this 64 64 */ 65 65 public function withLeasedTasks($leased) { 66 66 $this->leased = $leased;
+1 -1
src/infrastructure/daemon/workers/query/PhabricatorWorkerTriggerQuery.php
··· 60 60 * ordering when querying for specific triggers, e.g. by ID or PHID. 61 61 * 62 62 * @param const $order Result order. 63 - * @return this 63 + * @return $this 64 64 */ 65 65 public function setOrder($order) { 66 66 $this->order = $order;
+2 -2
src/infrastructure/diff/PhabricatorDifferenceEngine.php
··· 22 22 * Set the name to identify the old file with. Primarily cosmetic. 23 23 * 24 24 * @param string $old_name Old file name. 25 - * @return this 25 + * @return $this 26 26 * @task config 27 27 */ 28 28 public function setOldName($old_name) { ··· 35 35 * Set the name to identify the new file with. Primarily cosmetic. 36 36 * 37 37 * @param string $new_name New file name. 38 - * @return this 38 + * @return $this 39 39 * @task config 40 40 */ 41 41 public function setNewName($new_name) {
+2 -2
src/infrastructure/edges/editor/PhabricatorEdgeEditor.php
··· 49 49 * @param const $type Edge type constant. 50 50 * @param phid $dst Destination object PHID. 51 51 * @param map $options (optional) Options map (see documentation). 52 - * @return this 52 + * @return $this 53 53 * 54 54 * @task edit 55 55 */ ··· 70 70 * @param phid $src Source object PHID. 71 71 * @param const $type Edge type constant. 72 72 * @param phid $dst Destination object PHID. 73 - * @return this 73 + * @return $this 74 74 * 75 75 * @task edit 76 76 */
+5 -5
src/infrastructure/edges/query/PhabricatorEdgeQuery.php
··· 41 41 * to execute an edge query. 42 42 * 43 43 * @param list $source_phids List of source PHIDs. 44 - * @return this 44 + * @return $this 45 45 * 46 46 * @task config 47 47 */ ··· 62 62 * Find edges terminating at one or more destination PHIDs. 63 63 * 64 64 * @param list $dest_phids List of destination PHIDs. 65 - * @return this 65 + * @return $this 66 66 * 67 67 */ 68 68 public function withDestinationPHIDs(array $dest_phids) { ··· 75 75 * Find edges of specific types. 76 76 * 77 77 * @param list $types List of PhabricatorEdgeConfig type constants. 78 - * @return this 78 + * @return $this 79 79 * 80 80 * @task config 81 81 */ ··· 89 89 * Configure the order edge results are returned in. 90 90 * 91 91 * @param const $order Order constant. 92 - * @return this 92 + * @return $this 93 93 * 94 94 * @task config 95 95 */ ··· 103 103 * When loading edges, also load edge data. 104 104 * 105 105 * @param bool $need True to load edge data. 106 - * @return this 106 + * @return $this 107 107 * 108 108 * @task config 109 109 */
+1 -1
src/infrastructure/env/PhabricatorScopedEnv.php
··· 19 19 * 20 20 * @param string $key Key to override. 21 21 * @param wild $value New value. 22 - * @return this 22 + * @return $this 23 23 * 24 24 * @task override 25 25 */
+4 -4
src/infrastructure/markup/PhabricatorMarkupEngine.php
··· 84 84 * 85 85 * @param PhabricatorMarkupInterface $object The object to render. 86 86 * @param string $field The field to render. 87 - * @return this 87 + * @return $this 88 88 * @task markup 89 89 */ 90 90 public function addObject(PhabricatorMarkupInterface $object, $field) { ··· 102 102 * Process objects queued with @{method:addObject}. You can then retrieve 103 103 * the output with @{method:getOutput}. 104 104 * 105 - * @return this 105 + * @return $this 106 106 * @task markup 107 107 */ 108 108 public function process() { ··· 319 319 * Set the viewing user. Used to implement object permissions. 320 320 * 321 321 * @param PhabricatorUser $viewer The viewing user. 322 - * @return this 322 + * @return $this 323 323 * @task markup 324 324 */ 325 325 public function setViewer(PhabricatorUser $viewer) { ··· 331 331 * Set the context object. Used to implement object permissions. 332 332 * 333 333 * @param $object The object in which context this remarkup is used. 334 - * @return this 334 + * @return $this 335 335 * @task markup 336 336 */ 337 337 public function setContextObject($object) {
+1 -1
src/infrastructure/markup/PhutilMarkupEngine.php
··· 10 10 * 11 11 * @param string $key Key to set in the configuration dictionary. 12 12 * @param string $value Value to set. 13 - * @return this 13 + * @return $this 14 14 */ 15 15 abstract public function setConfig($key, $value); 16 16
+8 -8
src/infrastructure/query/policy/PhabricatorCursorPagedPolicyAwareQuery.php
··· 885 885 * also more involved. 886 886 * 887 887 * @param string $order Key of a builtin order supported by this query. 888 - * @return this 888 + * @return $this 889 889 * @task order 890 890 */ 891 891 public function setOrder($order) { ··· 919 919 * 920 920 * @param PhabricatorQueryOrderVector|list<string> $vector List of order 921 921 * keys. 922 - * @return this 922 + * @return $this 923 923 * @task order 924 924 */ 925 925 public function setGroupVector($vector) { ··· 1044 1044 * 1045 1045 * @param PhabricatorQueryOrderVector|list<string> $vector List of order 1046 1046 * keys. 1047 - * @return this 1047 + * @return $this 1048 1048 * @task order 1049 1049 */ 1050 1050 public function setOrderVector($vector) { ··· 1358 1358 * @param PhabricatorCustomFieldIndexStorage $index Table where the index is 1359 1359 * stored. 1360 1360 * @param string|list<string> $value One or more values to filter by. 1361 - * @return this 1361 + * @return $this 1362 1362 * @task appsearch 1363 1363 */ 1364 1364 public function withApplicationSearchContainsConstraint( ··· 1410 1410 * stored. 1411 1411 * @param int|null $min Minimum permissible value, inclusive. 1412 1412 * @param int|null $max Maximum permissible value, inclusive. 1413 - * @return this 1413 + * @return $this 1414 1414 * @task appsearch 1415 1415 */ 1416 1416 public function withApplicationSearchRangeConstraint( ··· 2590 2590 * @param const $edge_type Edge constant. 2591 2591 * @param const $operator Constraint operator. 2592 2592 * @param list<phid> $phids List of PHIDs. 2593 - * @return this 2593 + * @return $this 2594 2594 * @task edgelogic 2595 2595 */ 2596 2596 public function withEdgeLogicPHIDs($edge_type, $operator, array $phids) { ··· 2604 2604 2605 2605 2606 2606 /** 2607 - * @return this 2607 + * @return $this 2608 2608 * @task edgelogic 2609 2609 */ 2610 2610 public function withEdgeLogicConstraints($edge_type, array $constraints) { ··· 3001 3001 /** 3002 3002 * Validate edge logic constraints for the query. 3003 3003 * 3004 - * @return this 3004 + * @return $this 3005 3005 * @task edgelogic 3006 3006 */ 3007 3007 private function validateEdgeLogicConstraints() {
+6 -6
src/infrastructure/query/policy/PhabricatorPolicyAwareQuery.php
··· 58 58 * a policy query. 59 59 * 60 60 * @param PhabricatorUser $viewer The viewing user. 61 - * @return this 61 + * @return $this 62 62 * @task config 63 63 */ 64 64 final public function setViewer(PhabricatorUser $viewer) { ··· 83 83 * that configuration like whether or not to raise policy exceptions is 84 84 * seamlessly passed along to child queries. 85 85 * 86 - * @return this 86 + * @return $this 87 87 * @task config 88 88 */ 89 89 final public function setParentQuery(PhabricatorPolicyAwareQuery $query) { ··· 106 106 /** 107 107 * Hook to configure whether this query should raise policy exceptions. 108 108 * 109 - * @return this 109 + * @return $this 110 110 * @task config 111 111 */ 112 112 final public function setRaisePolicyExceptions($bool) { ··· 475 475 * 476 476 * @param map<phid, PhabricatorPolicyInterface> $objects Objects to add to 477 477 * the query workspace. 478 - * @return this 478 + * @return $this 479 479 * @task workspace 480 480 */ 481 481 public function putObjectsInWorkspace(array $objects) { ··· 507 507 * queries. 508 508 * 509 509 * @param list<phid> $phids List of PHIDs to retrieve. 510 - * @return this 510 + * @return $this 511 511 * @task workspace 512 512 */ 513 513 public function getObjectsFromWorkspace(array $phids) { ··· 537 537 * list can prevent infinite query loops by aborting queries which cycle. 538 538 * 539 539 * @param list<phid> $phids List of PHIDs which are now in flight. 540 - * @return this 540 + * @return $this 541 541 */ 542 542 public function putPHIDsInFlight(array $phids) { 543 543 foreach ($phids as $phid) {
+3 -3
src/infrastructure/storage/connection/AphrontDatabaseConnection.php
··· 164 164 * Begin a transaction, or set a savepoint if the connection is already 165 165 * transactional. 166 166 * 167 - * @return this 167 + * @return $this 168 168 * @task xaction 169 169 */ 170 170 public function openTransaction() { ··· 189 189 * Commit a transaction, or stage a savepoint for commit once the entire 190 190 * transaction completes if inside a transaction stack. 191 191 * 192 - * @return this 192 + * @return $this 193 193 * @task xaction 194 194 */ 195 195 public function saveTransaction() { ··· 208 208 * Rollback a transaction, or unstage the last savepoint if inside a 209 209 * transaction stack. 210 210 * 211 - * @return this 211 + * @return $this 212 212 */ 213 213 public function killTransaction() { 214 214 $state = $this->getTransactionState();
+17 -17
src/infrastructure/storage/lisk/LiskDAO.php
··· 265 265 * @param mode $mode Connection mode. 266 266 * @param AphrontDatabaseConnection $connection Connection to cache. 267 267 * @param bool $force_unique (optional) 268 - * @return this 268 + * @return $this 269 269 * @task conn 270 270 */ 271 271 protected function setEstablishedConnection( ··· 548 548 * properties. This is primarily useful after entering a transaction but 549 549 * before applying changes to an object. 550 550 * 551 - * @return this 551 + * @return $this 552 552 * 553 553 * @task load 554 554 */ ··· 580 580 * @param dict $row Dictionary of properties, which should be equivalent 581 581 * to selecting a row from the table or calling 582 582 * @{method:getProperties}. 583 - * @return this 583 + * @return $this 584 584 * 585 585 * @task load 586 586 */ ··· 694 694 * method unless with `IDS_MANUAL`. 695 695 * 696 696 * @param mixed $id Unique ID. 697 - * @return this 697 + * @return $this 698 698 * @task save 699 699 */ 700 700 public function setID($id) { ··· 918 918 * method you need to call to do writes. If the object has not yet been 919 919 * inserted this will do an insert; if it has, it will do an update. 920 920 * 921 - * @return this 921 + * @return $this 922 922 * 923 923 * @task save 924 924 */ ··· 935 935 * Save this object, forcing the query to use REPLACE regardless of object 936 936 * state. 937 937 * 938 - * @return this 938 + * @return $this 939 939 * 940 940 * @task save 941 941 */ ··· 949 949 * Save this object, forcing the query to use INSERT regardless of object 950 950 * state. 951 951 * 952 - * @return this 952 + * @return $this 953 953 * 954 954 * @task save 955 955 */ ··· 963 963 * Save this object, forcing the query to use UPDATE regardless of object 964 964 * state. 965 965 * 966 - * @return this 966 + * @return $this 967 967 * 968 968 * @task save 969 969 */ ··· 1019 1019 /** 1020 1020 * Delete this object, permanently. 1021 1021 * 1022 - * @return this 1022 + * @return $this 1023 1023 * 1024 1024 * @task save 1025 1025 */ ··· 1044 1044 * 1045 1045 * @param const $mode Either "INSERT" or "REPLACE", to force the desired 1046 1046 * mode. 1047 - * @return this 1047 + * @return $this 1048 1048 * 1049 1049 * @task save 1050 1050 */ ··· 1309 1309 /** 1310 1310 * Increase transaction stack depth. 1311 1311 * 1312 - * @return this 1312 + * @return $this 1313 1313 */ 1314 1314 public function openTransaction() { 1315 1315 $this->establishConnection('w')->openTransaction(); ··· 1320 1320 /** 1321 1321 * Decrease transaction stack depth, saving work. 1322 1322 * 1323 - * @return this 1323 + * @return $this 1324 1324 */ 1325 1325 public function saveTransaction() { 1326 1326 $this->establishConnection('w')->saveTransaction(); ··· 1331 1331 /** 1332 1332 * Decrease transaction stack depth, discarding work. 1333 1333 * 1334 - * @return this 1334 + * @return $this 1335 1335 */ 1336 1336 public function killTransaction() { 1337 1337 $this->establishConnection('w')->killTransaction(); ··· 1355 1355 * $beach->endReadLocking(); 1356 1356 * $beach->saveTransaction(); 1357 1357 * 1358 - * @return this 1358 + * @return $this 1359 1359 * @task xaction 1360 1360 */ 1361 1361 public function beginReadLocking() { ··· 1367 1367 /** 1368 1368 * Ends read-locking that began at an earlier @{method:beginReadLocking} call. 1369 1369 * 1370 - * @return this 1370 + * @return $this 1371 1371 * @task xaction 1372 1372 */ 1373 1373 public function endReadLocking() { ··· 1382 1382 * MySQL documentation for details). To end write locking, call 1383 1383 * @{method:endWriteLocking}. 1384 1384 * 1385 - * @return this 1385 + * @return $this 1386 1386 * @task xaction 1387 1387 */ 1388 1388 public function beginWriteLocking() { ··· 1395 1395 * Ends write-locking that began at an earlier @{method:beginWriteLocking} 1396 1396 * call. 1397 1397 * 1398 - * @return this 1398 + * @return $this 1399 1399 * @task xaction 1400 1400 */ 1401 1401 public function endWriteLocking() {
+1 -1
src/infrastructure/util/PhabricatorGlobalLock.php
··· 89 89 * be used to lock on a specific connection. 90 90 * 91 91 * @param AphrontDatabaseConnection $conn 92 - * @return this 92 + * @return $this 93 93 */ 94 94 public function setExternalConnection(AphrontDatabaseConnection $conn) { 95 95 if ($this->conn) {
+2 -2
src/view/AphrontView.php
··· 17 17 * Set the user viewing this element. 18 18 * 19 19 * @param PhabricatorUser $viewer Viewing user. 20 - * @return this 20 + * @return $this 21 21 */ 22 22 public function setViewer(PhabricatorUser $viewer) { 23 23 $this->viewer = $viewer; ··· 101 101 * determined by @{method:canAppendChild}. 102 102 * 103 103 * @param wild $child Something renderable. 104 - * @return this 104 + * @return $this 105 105 */ 106 106 final public function appendChild($child) { 107 107 if (!$this->canAppendChild()) {
+1 -1
src/view/form/AphrontFormView.php
··· 121 121 * control to simplify rendering. 122 122 * 123 123 * @param AphrontFormControl $control Control to append. 124 - * @return this 124 + * @return $this 125 125 */ 126 126 public function appendControl(AphrontFormControl $control) { 127 127 $this->controls[] = $control;
+1 -1
src/view/phui/PHUICrumbView.php
··· 24 24 * be hidden. 25 25 * 26 26 * @param bool $always_visible True to make the crumb always visible. 27 - * @return this 27 + * @return $this 28 28 */ 29 29 public function setAlwaysVisible($always_visible) { 30 30 $this->alwaysVisible = $always_visible;
+1 -1
src/view/phui/PHUICrumbsView.php
··· 17 17 * 18 18 * @param string $text Text of the crumb. 19 19 * @param string $href (optional) href for the crumb. 20 - * @return this 20 + * @return $this 21 21 */ 22 22 public function addTextCrumb($text, $href = null) { 23 23 return $this->addCrumb(
+1 -1
support/startup/PhabricatorClientLimit.php
··· 184 184 * 185 185 * @param float $score The cost for this request; more points pushes them 186 186 * toward the limit faster. 187 - * @return this 187 + * @return $this 188 188 */ 189 189 private function addScore($score) { 190 190 $is_apcu = (bool)function_exists('apcu_fetch');