bug symfony#32057 [HttpFoundation] Fix SA/phpdoc JsonResponse (ro0NL)

fabpot · fabpot · commit a8520ae60511 · 2019-06-16T13:18:13.000+02:00
This PR was squashed before being merged into the 3.4 branch (closes symfony#32057). Discussion ---------- [HttpFoundation] Fix SA/phpdoc JsonResponse | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no  | Deprecations? | no | Tests pass? | yes  | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  Commits ------- 270f10c [HttpFoundation] Fix SA/phpdoc JsonResponse
diff --git a/src/Symfony/Component/HttpFoundation/JsonResponse.php b/src/Symfony/Component/HttpFoundation/JsonResponse.php
@@ -55,10 +55,10 @@ public function __construct($data = null, $status = 200, $headers = [], $json =
      *
      * Example:
      *
-     *     return JsonResponse::create($data, 200)
+     *     return JsonResponse::create(['key' => 'value'])
      *         ->setSharedMaxAge(300);
      *
-     * @param mixed $data    The json response data
+     * @param mixed $data    The JSON response data
      * @param int   $status  The response status code
      * @param array $headers An array of response headers
      *
@@ -70,7 +70,18 @@ public static function create($data = null, $status = 200, $headers = [])
     }
 
     /**
-     * Make easier the creation of JsonResponse from raw json.
+     * Factory method for chainability.
+     *
+     * Example:
+     *
+     *     return JsonResponse::fromJsonString('{"key": "value"}')
+     *         ->setSharedMaxAge(300);
+     *
+     * @param string|null $data    The JSON response string
+     * @param int         $status  The response status code
+     * @param array       $headers An array of response headers
+     *
+     * @return static
      */
     public static function fromJsonString($data = null, $status = 200, $headers = [])
     {

Original file line number	Diff line number	Diff line change
`@@ -55,10 +55,10 @@ public function __construct($data = null, $status = 200, $headers = [], $json =`
`55`	`55`	`*`
`56`	`56`	`* Example:`
`57`	`57`	`*`
`58`		`- * return JsonResponse::create($data, 200)`
	`58`	`+ * return JsonResponse::create(['key' => 'value'])`
`59`	`59`	`* ->setSharedMaxAge(300);`
`60`	`60`	`*`
`61`		`- * @param mixed $data The json response data`
	`61`	`+ * @param mixed $data The JSON response data`
`62`	`62`	`* @param int $status The response status code`
`63`	`63`	`* @param array $headers An array of response headers`
`64`	`64`	`*`
`@@ -70,7 +70,18 @@ public static function create($data = null, $status = 200, $headers = [])`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`/**`
`73`		`- * Make easier the creation of JsonResponse from raw json.`
	`73`	`+ * Factory method for chainability.`
	`74`	`+ *`
	`75`	`+ * Example:`
	`76`	`+ *`
	`77`	`+ * return JsonResponse::fromJsonString('{"key": "value"}')`
	`78`	`+ * ->setSharedMaxAge(300);`
	`79`	`+ *`
	`80`	`+ * @param string\|null $data The JSON response string`
	`81`	`+ * @param int $status The response status code`
	`82`	`+ * @param array $headers An array of response headers`
	`83`	`+ *`
	`84`	`+ * @return static`
`74`	`85`	`*/`
`75`	`86`	`public static function fromJsonString($data = null, $status = 200, $headers = [])`
`76`	`87`	`{`