0
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2025-02-25 17:30:20 +00:00
nextcloud_server/lib/public/AppFramework/Http/TextPlainResponse.php
jld3103 b0001c6010
Add template types to responses
Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-06-30 09:33:29 +02:00

66 lines
1.8 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright 2021 Lukas Reschke <lukas@statuscode.ch>
*
* @author 2021 Lukas Reschke <lukas@statuscode.ch>
* @author Kate Döen <kate.doeen@nextcloud.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\AppFramework\Http;
use OCP\AppFramework\Http;
/**
* A renderer for text responses
* @since 22.0.0
* @template S of int
* @template H of array<string, mixed>
* @template-extends Response<int, array<string, mixed>>
*/
class TextPlainResponse extends Response {
/** @var string */
private $text = '';
/**
* constructor of TextPlainResponse
* @param string $text The text body
* @param S $statusCode the Http status code, defaults to 200
* @param H $headers
* @since 22.0.0
*/
public function __construct(string $text = '', int $statusCode = Http::STATUS_OK, array $headers = []) {
parent::__construct($statusCode, $headers);
$this->text = $text;
$this->addHeader('Content-Type', 'text/plain');
}
/**
* Returns the text
* @return string
* @since 22.0.0
* @throws \Exception If data could not get encoded
*/
public function render() : string {
return $this->text;
}
}