PHPDoc: Missing returns (#7624)

* PHPDoc: Missing returns * getVersionPreview should return string
pimcore · Dec 1, 2020 · 5ac36d2 · 5ac36d2
1 parent 31ca2e7
commit 5ac36d2
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 3 deletions.
diff --git 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
@@ -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
     }
 }
 
-```
+```
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -36,6 +36,8 @@ public function getImportConfigShares(): array
 
     /**
      * @param array $importConfigShares
+     *
+     * @return static
      */
     public function setImportConfigShares(array $importConfigShares)
     {