From 8f6ea900f2f75bfdfadb7f484ec64ac7ea78623c Mon Sep 17 00:00:00 2001 From: Thomas Tanghus Date: Sun, 9 Mar 2014 23:01:16 +0100 Subject: Chainable Response in AppFramework --- lib/public/appframework/http/jsonresponse.php | 2 ++ lib/public/appframework/http/response.php | 9 +++++++++ lib/public/appframework/http/templateresponse.php | 4 ++++ 3 files changed, 15 insertions(+) (limited to 'lib/public/appframework') diff --git a/lib/public/appframework/http/jsonresponse.php b/lib/public/appframework/http/jsonresponse.php index b54b23a34e6..bcfe469ef1b 100644 --- a/lib/public/appframework/http/jsonresponse.php +++ b/lib/public/appframework/http/jsonresponse.php @@ -69,6 +69,8 @@ class JSONResponse extends Response { */ public function setData($data){ $this->data = $data; + + return $this; } diff --git a/lib/public/appframework/http/response.php b/lib/public/appframework/http/response.php index d223621d4fd..e704acca7f0 100644 --- a/lib/public/appframework/http/response.php +++ b/lib/public/appframework/http/response.php @@ -80,6 +80,7 @@ class Response { $this->addHeader('Cache-Control', 'no-cache, must-revalidate'); } + return $this; } @@ -95,6 +96,8 @@ class Response { } else { $this->headers[$name] = $value; } + + return $this; } @@ -133,6 +136,8 @@ class Response { */ public function setStatus($status) { $this->status = $status; + + return $this; } @@ -168,6 +173,8 @@ class Response { */ public function setETag($ETag) { $this->ETag = $ETag; + + return $this; } @@ -177,6 +184,8 @@ class Response { */ public function setLastModified($lastModified) { $this->lastModified = $lastModified; + + return $this; } diff --git a/lib/public/appframework/http/templateresponse.php b/lib/public/appframework/http/templateresponse.php index 2200a38beca..1ae22dde7ff 100644 --- a/lib/public/appframework/http/templateresponse.php +++ b/lib/public/appframework/http/templateresponse.php @@ -77,6 +77,8 @@ class TemplateResponse extends Response { */ public function setParams(array $params){ $this->params = $params; + + return $this; } @@ -107,6 +109,8 @@ class TemplateResponse extends Response { */ public function renderAs($renderAs){ $this->renderAs = $renderAs; + + return $this; } -- cgit v1.2.3 From a1aacc18dff11351b555304a5361a73e13684bd1 Mon Sep 17 00:00:00 2001 From: Thomas Tanghus Date: Mon, 10 Mar 2014 09:31:30 +0100 Subject: Add @return PHPDocs --- lib/public/appframework/http/jsonresponse.php | 1 + lib/public/appframework/http/response.php | 4 ++++ lib/public/appframework/http/templateresponse.php | 2 ++ 3 files changed, 7 insertions(+) (limited to 'lib/public/appframework') diff --git a/lib/public/appframework/http/jsonresponse.php b/lib/public/appframework/http/jsonresponse.php index bcfe469ef1b..6628c4514d9 100644 --- a/lib/public/appframework/http/jsonresponse.php +++ b/lib/public/appframework/http/jsonresponse.php @@ -66,6 +66,7 @@ class JSONResponse extends Response { * Sets values in the data json array * @param array|object $data an array or object which will be transformed * to JSON + * @return JSONResponse Reference to this object */ public function setData($data){ $this->data = $data; diff --git a/lib/public/appframework/http/response.php b/lib/public/appframework/http/response.php index e704acca7f0..45402d9b3b3 100644 --- a/lib/public/appframework/http/response.php +++ b/lib/public/appframework/http/response.php @@ -89,6 +89,7 @@ class Response { * function * @param string $name The name of the HTTP header * @param string $value The value, null will delete it + * @return Response Reference to this object */ public function addHeader($name, $value) { if(is_null($value)) { @@ -133,6 +134,7 @@ class Response { /** * Set response status * @param int $status a HTTP status code, see also the STATUS constants + * @return Response Reference to this object */ public function setStatus($status) { $this->status = $status; @@ -170,6 +172,7 @@ class Response { /** * Set the ETag * @param string $ETag + * @return Response Reference to this object */ public function setETag($ETag) { $this->ETag = $ETag; @@ -181,6 +184,7 @@ class Response { /** * Set "last modified" date * @param \DateTime $lastModified + * @return Response Reference to this object */ public function setLastModified($lastModified) { $this->lastModified = $lastModified; diff --git a/lib/public/appframework/http/templateresponse.php b/lib/public/appframework/http/templateresponse.php index 1ae22dde7ff..f5baf788ada 100644 --- a/lib/public/appframework/http/templateresponse.php +++ b/lib/public/appframework/http/templateresponse.php @@ -74,6 +74,7 @@ class TemplateResponse extends Response { * Sets template parameters * @param array $params an array with key => value structure which sets template * variables + * @return TemplateResponse Reference to this object */ public function setParams(array $params){ $this->params = $params; @@ -106,6 +107,7 @@ class TemplateResponse extends Response { * settings header and footer, user renders the normal * normal page including footer and header and blank * just renders the plain template + * @return TemplateResponse Reference to this object */ public function renderAs($renderAs){ $this->renderAs = $renderAs; -- cgit v1.2.3