summaryrefslogtreecommitdiff
path: root/vendor/symfony/http-foundation/JsonResponse.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/symfony/http-foundation/JsonResponse.php')
-rw-r--r--vendor/symfony/http-foundation/JsonResponse.php19
1 files changed, 15 insertions, 4 deletions
diff --git a/vendor/symfony/http-foundation/JsonResponse.php b/vendor/symfony/http-foundation/JsonResponse.php
index 4dae091faa..c0a6916f05 100644
--- a/vendor/symfony/http-foundation/JsonResponse.php
+++ b/vendor/symfony/http-foundation/JsonResponse.php
@@ -18,7 +18,7 @@ namespace Symfony\Component\HttpFoundation;
* object. It is however recommended that you do return an object as it
* protects yourself against XSSI and JSON-JavaScript Hijacking.
*
- * @see https://www.owasp.org/index.php/OWASP_AJAX_Security_Guidelines#Always_return_JSON_with_an_Object_on_the_outside
+ * @see https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/AJAX_Security_Cheat_Sheet.md#always-return-json-with-an-object-on-the-outside
*
* @author Igor Wiedler <igor@wiedler.ch>
*/
@@ -55,10 +55,10 @@ class JsonResponse extends Response
*
* 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 @@ class JsonResponse extends Response
}
/**
- * 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 = [])
{