Page MenuHomePhorge
Differential D25958

PHPDoc: Fix @return string for methods which can also return null
Needs ReviewPublic
Actions

Authored by aklapper on Fri, Apr 11, 09:51.
Tags
None
Referenced Files
F3477308: D25958.1744759729.diff
Mon, Apr 14, 23:28
F3450732: D25958.1744715105.diff
Mon, Apr 14, 11:05
F3448212: D25958.1744707915.diff
Mon, Apr 14, 09:05
F3422236: D25958.1744635756.diff
Sun, Apr 13, 13:02
F3417130: D25958.1744613471.diff
Sun, Apr 13, 06:51
F3405915: D25958.1744584806.diff
Sat, Apr 12, 22:53
F3402380: D25958.1744569529.diff
Sat, Apr 12, 18:38
F3401115: D25958.1744562282.diff
Sat, Apr 12, 16:38
View All 12 Files
Subscribers
Cigaryno
Matthew
tobiaswiese
valerio.bozzolan

Details

Reviewers
None
Group Reviewers
O1: Blessed Committers
Summary

Correct docs.

Test Plan

Read the method code, run static code analysis (PHPStan) which complains "should return string but returns null".

Diff Detail

Repository
rP Phorge
Branch
phpDocReturnStringNull (branched from master)
Lint
Lint Passed
Unit
Tests Passed
Build Status
Buildable 1859
Build 1859: arc lint + arc unit

Revision Contents
Changeset List

PathSizeCoverage (All)Coverage (Touched)Packages
src/
aphront/
configuration/
4 lines0%
Loading...
O1: Blessed Committers
httpparametertype/
2 lines7%
Loading...
O1: Blessed Committers
applications/
auth/
constants/
5 lines8%
Loading...
O1: Blessed Committers
config/
option/
2 lines0%
Loading...
O1: Blessed Committers
diffusion/
request/
8 lines9%
Loading...
O1: Blessed Committers
metamta/
command/
2 lines25%
Loading...
O1: Blessed Committers
phame/
storage/
4 lines1%
Loading...
O1: Blessed Committers
policy/
capability/
4 lines90%
Loading...
O1: Blessed Committers
transactions/
editfield/
2 lines0%
Loading...
O1: Blessed Committers
infrastructure/
customfield/
field/
7 lines13%
Loading...
O1: Blessed Committers
edges/
query/
2 lines58%
Loading...
O1: Blessed Committers
query/
policy/
5 lines22%
Loading...
O1: Blessed Committers

Diff 2861

View Options

src/aphront/configuration/AphrontApplicationConfiguration.php

Show All 37 Lines if ($id) {
$credential = PassphraseCredential::initializeNewCredential($viewer) $credential = PassphraseCredential::initializeNewCredential($viewer)
->setCredentialType($type->getCredentialType()) ->setCredentialType($type->getCredentialType())
->setProvidesType($type->getProvidesType()) ->setProvidesType($type->getProvidesType())
->attachImplementation($type); ->attachImplementation($type);
$is_new = true; $is_new = true;
// Prefill username if provided. // Prefill username if provided.
$credential->setUsername((string)$request->getStr('username')); $credential->setUsername((string)$request->getStr('username'));
valerio.bozzolanAuthorUnsubmitted
Done
Inline Actions

I honestly don't know why here we use (string). Probably we just want to set an empty default to prevent that case? Anyway I've copy-pasted that switching-off my brain. I have no intention to discuss that now, but it's just nice to mention that I'm confused.

valerio.bozzolan: I honestly don't know why here we use `(string)`. Probably we just want to set an empty default…
aviveyUnsubmitted
Not Done
Inline Actions

I got curios, so I looked it up: https://secure.phabricator.com/D13261#140865 - looks like it's to convert null to '' for the DB schema. I'm not sure if it's still relevant, but there's probably no harm in keeping it.

avivey: I got curios, so I looked it up: https://secure.phabricator.com/D13261#140865 - looks like it's…
// Prefill name if provided.
$credential->setName((string)$request->getStr('name'));
// Prefill description if provided.
$credential->setDescription((string)$request->getStr('description'));
valerio.bozzolanAuthorUnsubmitted
Done
Inline Actions

I honestly don't kno

valerio.bozzolan: I honestly don't kno
if (!$request->getStr('isInitialized')) { if (!$request->getStr('isInitialized')) {
$type->didInitializeNewCredential($viewer, $credential); $type->didInitializeNewCredential($viewer, $credential);
} }
} }
$errors = array(); $errors = array();
$v_name = $credential->getName(); $v_name = $credential->getName();
▲ Show 20 Lines • Show All 344 Lines • Show Last 20 Lines
View Options

src/aphront/httpparametertype/AphrontHTTPParameterType.php

Show All 37 Lines if ($id) {
$credential = PassphraseCredential::initializeNewCredential($viewer) $credential = PassphraseCredential::initializeNewCredential($viewer)
->setCredentialType($type->getCredentialType()) ->setCredentialType($type->getCredentialType())
->setProvidesType($type->getProvidesType()) ->setProvidesType($type->getProvidesType())
->attachImplementation($type); ->attachImplementation($type);
$is_new = true; $is_new = true;
// Prefill username if provided. // Prefill username if provided.
$credential->setUsername((string)$request->getStr('username')); $credential->setUsername((string)$request->getStr('username'));
valerio.bozzolanAuthorUnsubmitted
Done
Inline Actions

I honestly don't know why here we use (string). Probably we just want to set an empty default to prevent that case? Anyway I've copy-pasted that switching-off my brain. I have no intention to discuss that now, but it's just nice to mention that I'm confused.

valerio.bozzolan: I honestly don't know why here we use `(string)`. Probably we just want to set an empty default…
aviveyUnsubmitted
Not Done
Inline Actions

I got curios, so I looked it up: https://secure.phabricator.com/D13261#140865 - looks like it's to convert null to '' for the DB schema. I'm not sure if it's still relevant, but there's probably no harm in keeping it.

avivey: I got curios, so I looked it up: https://secure.phabricator.com/D13261#140865 - looks like it's…
// Prefill name if provided.
$credential->setName((string)$request->getStr('name'));
// Prefill description if provided.
$credential->setDescription((string)$request->getStr('description'));
valerio.bozzolanAuthorUnsubmitted
Done
Inline Actions

I honestly don't kno

valerio.bozzolan: I honestly don't kno
if (!$request->getStr('isInitialized')) { if (!$request->getStr('isInitialized')) {
$type->didInitializeNewCredential($viewer, $credential); $type->didInitializeNewCredential($viewer, $credential);
} }
} }
$errors = array(); $errors = array();
$v_name = $credential->getName(); $v_name = $credential->getName();
▲ Show 20 Lines • Show All 344 Lines • Show Last 20 Lines
View Options

src/applications/auth/constants/PhabricatorCookies.php

Show All 37 Lines if ($id) {
$credential = PassphraseCredential::initializeNewCredential($viewer) $credential = PassphraseCredential::initializeNewCredential($viewer)
->setCredentialType($type->getCredentialType()) ->setCredentialType($type->getCredentialType())
->setProvidesType($type->getProvidesType()) ->setProvidesType($type->getProvidesType())
->attachImplementation($type); ->attachImplementation($type);
$is_new = true; $is_new = true;
// Prefill username if provided. // Prefill username if provided.
$credential->setUsername((string)$request->getStr('username')); $credential->setUsername((string)$request->getStr('username'));
valerio.bozzolanAuthorUnsubmitted
Done
Inline Actions

I honestly don't know why here we use (string). Probably we just want to set an empty default to prevent that case? Anyway I've copy-pasted that switching-off my brain. I have no intention to discuss that now, but it's just nice to mention that I'm confused.

valerio.bozzolan: I honestly don't know why here we use `(string)`. Probably we just want to set an empty default…
aviveyUnsubmitted
Not Done
Inline Actions

I got curios, so I looked it up: https://secure.phabricator.com/D13261#140865 - looks like it's to convert null to '' for the DB schema. I'm not sure if it's still relevant, but there's probably no harm in keeping it.

avivey: I got curios, so I looked it up: https://secure.phabricator.com/D13261#140865 - looks like it's…
// Prefill name if provided.
$credential->setName((string)$request->getStr('name'));
// Prefill description if provided.
$credential->setDescription((string)$request->getStr('description'));
valerio.bozzolanAuthorUnsubmitted
Done
Inline Actions

I honestly don't kno

valerio.bozzolan: I honestly don't kno
if (!$request->getStr('isInitialized')) { if (!$request->getStr('isInitialized')) {
$type->didInitializeNewCredential($viewer, $credential); $type->didInitializeNewCredential($viewer, $credential);
} }
} }
$errors = array(); $errors = array();
$v_name = $credential->getName(); $v_name = $credential->getName();
▲ Show 20 Lines • Show All 344 Lines • Show Last 20 Lines
View Options

src/applications/config/option/PhabricatorApplicationConfigOptions.php

Show All 37 Lines if ($id) {
$credential = PassphraseCredential::initializeNewCredential($viewer) $credential = PassphraseCredential::initializeNewCredential($viewer)
->setCredentialType($type->getCredentialType()) ->setCredentialType($type->getCredentialType())
->setProvidesType($type->getProvidesType()) ->setProvidesType($type->getProvidesType())
->attachImplementation($type); ->attachImplementation($type);
$is_new = true; $is_new = true;
// Prefill username if provided. // Prefill username if provided.
$credential->setUsername((string)$request->getStr('username')); $credential->setUsername((string)$request->getStr('username'));
valerio.bozzolanAuthorUnsubmitted
Done
Inline Actions

I honestly don't know why here we use (string). Probably we just want to set an empty default to prevent that case? Anyway I've copy-pasted that switching-off my brain. I have no intention to discuss that now, but it's just nice to mention that I'm confused.

valerio.bozzolan: I honestly don't know why here we use `(string)`. Probably we just want to set an empty default…
aviveyUnsubmitted
Not Done
Inline Actions

I got curios, so I looked it up: https://secure.phabricator.com/D13261#140865 - looks like it's to convert null to '' for the DB schema. I'm not sure if it's still relevant, but there's probably no harm in keeping it.

avivey: I got curios, so I looked it up: https://secure.phabricator.com/D13261#140865 - looks like it's…
// Prefill name if provided.
$credential->setName((string)$request->getStr('name'));
// Prefill description if provided.
$credential->setDescription((string)$request->getStr('description'));
valerio.bozzolanAuthorUnsubmitted
Done
Inline Actions

I honestly don't kno

valerio.bozzolan: I honestly don't kno
if (!$request->getStr('isInitialized')) { if (!$request->getStr('isInitialized')) {
$type->didInitializeNewCredential($viewer, $credential); $type->didInitializeNewCredential($viewer, $credential);
} }
} }
$errors = array(); $errors = array();
$v_name = $credential->getName(); $v_name = $credential->getName();
▲ Show 20 Lines • Show All 344 Lines • Show Last 20 Lines
View Options

src/applications/diffusion/request/DiffusionRequest.php

Loading...
View Options

src/applications/metamta/command/MetaMTAEmailTransactionCommand.php

Loading...
View Options

src/applications/phame/storage/PhameBlog.php

Loading...
View Options

src/applications/policy/capability/PhabricatorPolicyCapability.php

Loading...
View Options

src/applications/transactions/editfield/PhabricatorEditField.php

Loading...
View Options

src/infrastructure/customfield/field/PhabricatorCustomField.php

Loading...
View Options

src/infrastructure/edges/query/PhabricatorEdgeQuery.php

Loading...
View Options

src/infrastructure/query/policy/PhabricatorCursorPagedPolicyAwareQuery.php

Loading...
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0