revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-11-22 06:42:42 +01:00
Code Issues Releases Wiki Activity

Correct PHPDoc return value for loadObject() in PhabricatorObjectMailReceiver

Browse source 
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
This commit is contained in:
Andre Klapper 2024-05-17 10:57:19 +02:00
parent 98884f758a
commit 5f565e2ab6
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php
View file

@ -22,7 +22,8 @@ abstract class PhabricatorObjectMailReceiver extends PhabricatorMailReceiver {
* @param string A string matched by @{method:getObjectPattern} * @param string A string matched by @{method:getObjectPattern}
* fragment. * fragment.
* @param PhabricatorUser The viewing user. * @param PhabricatorUser The viewing user.
* @return void * @return object|null The object to receive mail, or null if no such
* object exists.
*/ */
abstract protected function loadObject($pattern, PhabricatorUser $viewer); abstract protected function loadObject($pattern, PhabricatorUser $viewer);