Override setStatus and setHeaders methods in responses

Signed-off-by: jld3103 <[email protected]>
nextcloud · Jun 23, 2023 · c763163 · c763163
1 parent 6077be9
commit c763163
Show file tree

Hide file tree

Showing 16 changed files with 399 additions and 0 deletions.
diff --git a/lib/public/AppFramework/Http/DataDisplayResponse.php b/lib/public/AppFramework/Http/DataDisplayResponse.php
@@ -90,4 +90,30 @@ public function setData($data) {
 	public function getData() {
 		return $this->data;
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/DataDownloadResponse.php b/lib/public/AppFramework/Http/DataDownloadResponse.php
@@ -66,4 +66,30 @@ public function setData($data) {
 	public function render() {
 		return $this->data;
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, C, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, C, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/DataResponse.php b/lib/public/AppFramework/Http/DataResponse.php
@@ -83,4 +83,30 @@ public function setData($data) {
 	public function getData() {
 		return $this->data;
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, T, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, T, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/DownloadResponse.php b/lib/public/AppFramework/Http/DownloadResponse.php
@@ -49,4 +49,30 @@ public function __construct(string $filename, string $contentType) {
 		$this->addHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
 		$this->addHeader('Content-Type', $contentType);
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, C, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, C, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/FileDisplayResponse.php b/lib/public/AppFramework/Http/FileDisplayResponse.php
@@ -71,4 +71,30 @@ public function callback(IOutput $output) {
 			$output->setOutput($this->file->getContent());
 		}
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/JSONResponse.php b/lib/public/AppFramework/Http/JSONResponse.php
@@ -93,4 +93,30 @@ public function setData($data) {
 	public function getData() {
 		return $this->data;
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, T, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, T, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/NotFoundResponse.php b/lib/public/AppFramework/Http/NotFoundResponse.php
@@ -43,4 +43,26 @@ public function __construct() {
 		$this->setContentSecurityPolicy(new ContentSecurityPolicy());
 		$this->setStatus(Http::STATUS_NOT_FOUND);
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @depreacted Do not use this method. It modifies the status code which you are not supposed to do on a NotFoundResponse
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/RedirectResponse.php b/lib/public/AppFramework/Http/RedirectResponse.php
@@ -58,4 +58,26 @@ public function __construct($redirectURL) {
 	public function getRedirectURL() {
 		return $this->redirectURL;
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @depreacted Do not use this method. It modifies the status code which you are not supposed to do on a RedirectResponse
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php b/lib/public/AppFramework/Http/RedirectToDefaultAppResponse.php
@@ -49,4 +49,26 @@ public function __construct() {
 		$urlGenerator = \OC::$server->get(IURLGenerator::class);
 		parent::__construct($urlGenerator->linkToDefaultPageUrl());
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @depreacted Do not use this method. It modifies the status code which you are not supposed to do on a RedirectToDefaultAppResponse
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/StandaloneTemplateResponse.php b/lib/public/AppFramework/Http/StandaloneTemplateResponse.php
@@ -38,4 +38,29 @@
  * @template-extends TemplateResponse<int, array<string, mixed>>
  */
 class StandaloneTemplateResponse extends TemplateResponse {
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/StreamResponse.php b/lib/public/AppFramework/Http/StreamResponse.php
@@ -68,4 +68,30 @@ public function callback(IOutput $output) {
 			}
 		}
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/Template/PublicTemplateResponse.php b/lib/public/AppFramework/Http/Template/PublicTemplateResponse.php
@@ -157,4 +157,30 @@ public function render(): string {
 		$this->setParams($params);
 		return  parent::render();
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }
diff --git a/lib/public/AppFramework/Http/TemplateResponse.php b/lib/public/AppFramework/Http/TemplateResponse.php
@@ -216,4 +216,30 @@ public function render() {
 
 		return $template->fetchPage($this->params);
 	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewH as array<string, mixed>
+	 * @param NewH $headers value header pairs
+	 * @psalm-this-out self<S, NewH>
+	 * @return $this
+	 * @since 8.0.0
+	 */
+	public function setHeaders(array $headers) {
+		parent::setHeaders($headers);
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @template NewS as int
+	 * @param NewS $status
+	 * @psalm-this-out self<NewS, H>
+	 * @return $this
+	 * @since 6.0.0 - return value was added in 7.0.0
+	 */
+	public function setStatus($status) {
+		parent::setStatus($status);
+		return $this;
+	}
 }