3 namespace Org\Mxchange\CoreFramework\Response;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
9 * An interface for responses
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface Responseable extends FrameworkInterface {
34 * @param $status New response status
37 function setResponseStatus (string $status);
40 * Adds a header to the response. This method "wraps" the direct header()
41 * function call and so it can be done "generic". E.g. if a local
42 * application like my hub does not support redirects, this method can be
43 * kept empty or it can be done something else which would not be possible
44 * with a direct header() call.
46 * @param $name Name of header element
47 * @param $value Value of header element
50 function addHeader (string $name, $value);
53 * "Writes" data to the response body
55 * @param $output Output we shall sent in the HTTP response
58 function writeToBody (string $output);
61 * Flushs the cached HTTP response to the outer world
63 * @param $force Whether we shall force the output or abort if headers are
64 * already sent with an exception
66 * @throws ResponseHeadersAlreadySentException Thrown if headers are
69 function flushBuffer (bool $force = false);
72 * Adds a fatal message id to the response. The added messages can then be
73 * processed and outputed to the world
75 * @param $messageId The message id we shall add
78 function addFatalMessage (string $messageId);
81 * Adds a cookie to the response
83 * @param $cookieName Cookie's name
84 * @param $cookieValue Value to store in the cookie
85 * @param $encrypted Do some extra encryption on the value
86 * @param $expires Timestamp of expiration (default: configured)
88 * @throws ResponseHeadersAlreadySentException If headers are already sent
90 function addCookie (string $cookieName, $cookieValue, bool $encrypted = FALSE, int $expires = NULL);
93 * Redirect to a configured URL. The URL can be absolute or relative. In
94 * case of relative URL it will be extended automatically with the
95 * 'base_url' from configuration.
97 * @param $configEntry The configuration entry which holds our URL
99 * @throws ResponseHeadersAlreadySentException If headers are already sent
101 function redirectToConfiguredUrl (string $configEntry);
104 * Expires the given cookie if it is set
106 * @param $cookieName Cookie to expire
109 function expireCookie (string $cookieName);
112 * Refreshs a given cookie. This will make the cookie live longer
114 * @param $cookieName Cookie to refresh
117 function refreshCookie (string $cookieName);