Files
espocrm/application/Espo/Core/Api/Response.php
Taras Machyshyn 095f82df1c 2022 year
2022-02-10 12:12:23 +02:00

81 lines
2.3 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Core\Api;
use Psr\Http\Message\StreamInterface;
/**
* Representation of an HTTP response. An instance is mutable.
*/
interface Response
{
/**
* Set a status code.
*/
public function setStatus(int $code, ?string $reason = null): self;
/**
* Set a specific header.
*/
public function setHeader(string $name, string $value): self;
/**
* Add a specific header.
*/
public function addHeader(string $name, string $value): self;
/**
* Get a header value.
*/
public function getHeader(string $name): ?string;
/**
* Whether a header is set.
*/
public function hasHeader(string $name): bool;
/**
* Get a header values as an array.
*
* @return string[]
*/
public function getHeaderAsArray(string $name): array;
/**
* Write a body.
*/
public function writeBody(string $string): self;
/**
* Set a body.
*/
public function setBody(StreamInterface $body): self;
}