@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
Correct PHPDoc return value for loadObject() in PhabricatorObjectMailReceiver
Summary:
The PHPDoc for the abstract function `loadObject()` defines `@return void`, however the function's return value is used twice in `PhabricatorObjectMailReceiver` and all 17 `loadObject()` implementations in child classes return an object provided by some type of `PhabricatorCursorPagedPolicyAwareQuery`.
Thus correct the PHPDoc to make static code analyzers happier.
Test Plan: Carefully read and compare the code.
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/D25654
+2
-1
+2
-1
src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php
+2
-1
src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php
···
22
22
* @param string A string matched by @{method:getObjectPattern}
23
23
* fragment.
24
24
* @param PhabricatorUser The viewing user.
25
-
* @return void
25
+
* @return object|null The object to receive mail, or null if no such
26
+
* object exists.
26
27
*/
27
28
abstract protected function loadObject($pattern, PhabricatorUser $viewer);
28
29