From 5f565e2ab665bf68d8e491a035785fc3d6f3b9e3 Mon Sep 17 00:00:00 2001 From: Andre Klapper Date: Fri, 17 May 2024 10:57:19 +0200 Subject: [PATCH] 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 --- .../metamta/receiver/PhabricatorObjectMailReceiver.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php b/src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php index 0342a94a60..65c6089f3b 100644 --- a/src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php +++ b/src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php @@ -22,7 +22,8 @@ abstract class PhabricatorObjectMailReceiver extends PhabricatorMailReceiver { * @param string A string matched by @{method:getObjectPattern} * fragment. * @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); -- 2.51.2