From 5544c0b57e3c45f3abdfbd7b2d637b75c6f3a104 Mon Sep 17 00:00:00 2001 From: Andre Klapper Date: Sat, 17 Jan 2026 11:32:58 +0100 Subject: [PATCH] Correct some PhpDoc return types Summary: Fix a bunch of PhpDoc return type fixes to make PhpStan complain less. ``` Line src/applications/differential/render/DifferentialChangesetOneUpMailRenderer.php 27 Method DifferentialChangesetOneUpMailRenderer::renderShield() should return string but returns null. ------ Line src/applications/diffusion/request/DiffusionRequest.php 166 Method DiffusionRequest::newFromIdentifier() should return DiffusionRequest but returns null. ------ Line src/applications/files/transform/PhabricatorFileImageTransform.php 219 Method PhabricatorFileImageTransform::newEmptyImage() should return resource but returns GdImage. 366 Method PhabricatorFileImageTransform::getImage() should return resource but returns GdImage. ------ Line src/applications/home/view/PHUIHomeView.php 93 Method PHUIHomeView::buildRevisionPanel() should return PHUIObjectBoxView but returns null. ------ Line src/applications/search/controller/PhabricatorApplicationSearchController.php 980 Method PhabricatorApplicationSearchController::newBuiltinUseActions() should return PhabricatorActionView but returns list. ------ Line src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php 2329 Method PhabricatorApplicationTransactionEditor::newFileTransaction() should return PhabricatorApplicationTransaction but returns null. ``` Test Plan: Read the code. Reviewers: O1 Blessed Committers, mainframe98 Reviewed By: O1 Blessed Committers, mainframe98 Subscribers: mainframe98, tobiaswiese, valerio.bozzolan, Matthew, Cigaryno Differential Revision: https://we.phorge.it/D26691 --- .../render/DifferentialChangesetRenderer.php | 2 +- .../diffusion/request/DiffusionRequest.php | 10 +++++----- .../files/transform/PhabricatorFileImageTransform.php | 4 ++-- src/applications/home/view/PHUIHomeView.php | 2 +- .../PhabricatorApplicationSearchController.php | 2 +- .../editor/PhabricatorApplicationTransactionEditor.php | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/applications/differential/render/DifferentialChangesetRenderer.php b/src/applications/differential/render/DifferentialChangesetRenderer.php index 3217a51e30..c7fcc66118 100644 --- a/src/applications/differential/render/DifferentialChangesetRenderer.php +++ b/src/applications/differential/render/DifferentialChangesetRenderer.php @@ -454,7 +454,7 @@ abstract class DifferentialChangesetRenderer extends Phobject { * * @param string $message Message explaining why the diff is hidden. * @param string|null $force Force mode, see above. - * @return string Shield markup. + * @return string|null Shield markup. */ abstract public function renderShield($message, $force = 'default'); diff --git a/src/applications/diffusion/request/DiffusionRequest.php b/src/applications/diffusion/request/DiffusionRequest.php index 5eb113e0f8..7a3a5b9466 100644 --- a/src/applications/diffusion/request/DiffusionRequest.php +++ b/src/applications/diffusion/request/DiffusionRequest.php @@ -134,11 +134,11 @@ abstract class DiffusionRequest extends Phobject { /** * Internal. Use @{method:newFromDictionary}, not this method. * - * @param string $identifier Repository identifier. - * @param PhabricatorUser $viewer Viewing user. - * @param bool $need_edit (optional) - * @return DiffusionRequest New request object, or null if no repository is - * found. + * @param string $identifier Repository identifier. + * @param PhabricatorUser $viewer Viewing user. + * @param bool $need_edit (optional) + * @return DiffusionRequest|null New request object, or null if no + * repository is found. * @task new */ private static function newFromIdentifier( diff --git a/src/applications/files/transform/PhabricatorFileImageTransform.php b/src/applications/files/transform/PhabricatorFileImageTransform.php index 0a88ba18a8..5726f0d34e 100644 --- a/src/applications/files/transform/PhabricatorFileImageTransform.php +++ b/src/applications/files/transform/PhabricatorFileImageTransform.php @@ -161,7 +161,7 @@ abstract class PhabricatorFileImageTransform extends PhabricatorFileTransform { * * @param int $w Desired image width. * @param int $h Desired image height. - * @return resource New image resource. + * @return GdImage|resource New GD image resource. */ protected function newEmptyImage($w, $h) { $w = (int)$w; @@ -283,7 +283,7 @@ abstract class PhabricatorFileImageTransform extends PhabricatorFileTransform { /** * Get the GD image resource for the image being transformed. * - * @return resource GD image resource. + * @return GdImage|resource GD image resource. */ protected function getImage() { if ($this->image !== null) { diff --git a/src/applications/home/view/PHUIHomeView.php b/src/applications/home/view/PHUIHomeView.php index 900eabe387..a645329729 100644 --- a/src/applications/home/view/PHUIHomeView.php +++ b/src/applications/home/view/PHUIHomeView.php @@ -85,7 +85,7 @@ final class PHUIHomeView } /** - * @return PHUIObjectBoxView + * @return PHUIObjectBoxView|null */ private function buildRevisionPanel() { $viewer = $this->getViewer(); diff --git a/src/applications/search/controller/PhabricatorApplicationSearchController.php b/src/applications/search/controller/PhabricatorApplicationSearchController.php index 4cbeb68b94..f579a7cb32 100644 --- a/src/applications/search/controller/PhabricatorApplicationSearchController.php +++ b/src/applications/search/controller/PhabricatorApplicationSearchController.php @@ -919,7 +919,7 @@ final class PhabricatorApplicationSearchController } /** - * @return PhabricatorActionView + * @return array */ private function newBuiltinUseActions() { $actions = array(); diff --git a/src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php b/src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php index ebd233e28a..55976ec2a3 100644 --- a/src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php +++ b/src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php @@ -2260,7 +2260,7 @@ abstract class PhabricatorApplicationTransactionEditor * @param PhabricatorLiskDAO $object * @param array $xactions * @param array $remarkup_changes - * @return PhabricatorApplicationTransaction + * @return PhabricatorApplicationTransaction|null */ private function newFileTransaction( PhabricatorLiskDAO $object, -- 2.51.2