snapshot of https://github.com/espocrm/espocrm.git (master, 2026-09-18; blobs > 131072B omitted)

application/Espo/Core/Api/Response.php

@@ -0,0 +1,117 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2026 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * 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 <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero 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\ResponseInterface as Psr7Response;
+use Psr\Http\Message\StreamInterface;
+
+/**
+ * Representation of an HTTP response. An instance is mutable.
+ */
+interface Response
+{
+    /**
+     * Get a status code.
+     */
+    public function getStatusCode(): int;
+
+    /**
+     * Get a status reason phrase.
+     */
+    public function getReasonPhrase(): string;
+
+    /**
+     * 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 all set header names.
+     *
+     * @return string[]
+     */
+    public function getHeaderNames(): array;
+
+    /**
+     * 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;
+
+    /**
+     * Get a body.
+     */
+    public function getBody(): StreamInterface;
+
+    /**
+     * Apply a PSR-7 response.
+     *
+     * @since 10.1.0
+     */
+    public function applyPsr7(Psr7Response $psr7Response): self;
+
+    /**
+     * Get the PSR-7 response.
+     *
+     * @since 10.1.0
+     */
+    public function toPsr7(): Psr7Response;
+}