From 5ac36d28a568c8354d2bce85cfff8164a9d1aa55 Mon Sep 17 00:00:00 2001 From: Sebastian Blank Date: Tue, 1 Dec 2020 14:04:11 +0100 Subject: [PATCH] PHPDoc: Missing returns (#7624) * PHPDoc: Missing returns * getVersionPreview should return string --- .../VoucherService/Token/Listing.php | 2 ++ .../26_Best_Practice/70_Open_By-External_Id.md | 4 +++- models/Asset/MetaData/ClassDefinition/Data/Data.php | 6 +++++- models/Asset/MetaData/ClassDefinition/Data/Date.php | 4 +++- models/GridConfigFavourite/Listing.php | 2 ++ models/GridConfigShare/Listing.php | 2 ++ models/ImportConfigShare/Listing.php | 2 ++ 7 files changed, 19 insertions(+), 3 deletions(-) diff --git a/bundles/EcommerceFrameworkBundle/VoucherService/Token/Listing.php b/bundles/EcommerceFrameworkBundle/VoucherService/Token/Listing.php index 12c9ee15837..1ba75b7f5af 100644 --- a/bundles/EcommerceFrameworkBundle/VoucherService/Token/Listing.php +++ b/bundles/EcommerceFrameworkBundle/VoucherService/Token/Listing.php @@ -346,6 +346,8 @@ public function getTokens() /** * @param array $tokens + * + * @return static */ public function setTokens($tokens) { diff --git a/doc/Development_Documentation/26_Best_Practice/70_Open_By-External_Id.md b/doc/Development_Documentation/26_Best_Practice/70_Open_By-External_Id.md index e54951ef40a..752cc52589b 100644 --- a/doc/Development_Documentation/26_Best_Practice/70_Open_By-External_Id.md +++ b/doc/Development_Documentation/26_Best_Practice/70_Open_By-External_Id.md @@ -90,6 +90,8 @@ class BackendController /** * @param Request $request * @Route("/admin/find-by-external-id") + * + * @return JsonResponse */ public function findByWordpressId(Request $request) { if($id = (int)$request->get('external-id')) { @@ -102,4 +104,4 @@ class BackendController } } -``` \ No newline at end of file +``` diff --git a/models/Asset/MetaData/ClassDefinition/Data/Data.php b/models/Asset/MetaData/ClassDefinition/Data/Data.php index cb4b5e39e23..94ad3245503 100644 --- a/models/Asset/MetaData/ClassDefinition/Data/Data.php +++ b/models/Asset/MetaData/ClassDefinition/Data/Data.php @@ -167,10 +167,12 @@ public function resolveDependencies($data, $params = []) /** * @param mixed $value * @param array $params + * + * @return string */ public function getVersionPreview($value, $params = []) { - return $value; + return (string)$value; } /** @@ -184,5 +186,7 @@ public function getDataForSearchIndex($data, $params = []) if (is_scalar($data)) { return $params['name'] . ':' . $data; } + + return null; } } diff --git a/models/Asset/MetaData/ClassDefinition/Data/Date.php b/models/Asset/MetaData/ClassDefinition/Data/Date.php index a68b72216ec..e5d37ba3da0 100644 --- a/models/Asset/MetaData/ClassDefinition/Data/Date.php +++ b/models/Asset/MetaData/ClassDefinition/Data/Date.php @@ -37,9 +37,11 @@ public function marshal($value, $params = []) /** * @param mixed $value * @param array $params + * + * @return string */ public function getVersionPreview($value, $params = []) { - return date('m/d/Y', $value); + return (string)date('m/d/Y', $value); } } diff --git a/models/GridConfigFavourite/Listing.php b/models/GridConfigFavourite/Listing.php index 8c1f92669fd..88bf2751e37 100644 --- a/models/GridConfigFavourite/Listing.php +++ b/models/GridConfigFavourite/Listing.php @@ -36,6 +36,8 @@ public function getGridconfigFavourites() /** * @param array $gridconfigFavourites + * + * @return static */ public function setGridconfigFavourites($gridconfigFavourites) { diff --git a/models/GridConfigShare/Listing.php b/models/GridConfigShare/Listing.php index b63455bbae9..9ffb282040f 100644 --- a/models/GridConfigShare/Listing.php +++ b/models/GridConfigShare/Listing.php @@ -36,6 +36,8 @@ public function getGridconfigShares() /** * @param array $gridconfigShares + * + * @return static */ public function setGridconfigShares($gridconfigShares) { diff --git a/models/ImportConfigShare/Listing.php b/models/ImportConfigShare/Listing.php index e84a09a5751..8ad8bcb84de 100644 --- a/models/ImportConfigShare/Listing.php +++ b/models/ImportConfigShare/Listing.php @@ -36,6 +36,8 @@ public function getImportConfigShares(): array /** * @param array $importConfigShares + * + * @return static */ public function setImportConfigShares(array $importConfigShares) {