This interface represents a HTTP response. More...
Inheritance diagram for Sabre\HTTP\ResponseInterface:
Collaboration diagram for Sabre\HTTP\ResponseInterface:
Public Member Functions | |
| getStatus () | |
| Returns the current HTTP status code. More... | |
| getStatusText () | |
| Returns the human-readable status string. More... | |
| setStatus ($status) | |
| Sets the HTTP status code. More... | |
| Public Member Functions inherited from Sabre\HTTP\MessageInterface | |
| getBodyAsStream () | |
| Returns the body as a readable stream resource. More... | |
| getBodyAsString () | |
| Returns the body as a string. More... | |
| getBody () | |
| Returns the message body, as it's internal representation. More... | |
| setBody ($body) | |
| Updates the body resource with a new stream. More... | |
| getHeaders () | |
| Returns all the HTTP headers as an array. More... | |
| hasHeader ($name) | |
| Will return true or false, depending on if a HTTP header exists. More... | |
| getHeader ($name) | |
| Returns a specific HTTP header, based on it's name. More... | |
| getHeaderAsArray ($name) | |
| Returns a HTTP header as an array. More... | |
| setHeader ($name, $value) | |
| Updates a HTTP header. More... | |
| setHeaders (array $headers) | |
| Sets a new set of HTTP headers. More... | |
| addHeader ($name, $value) | |
| Adds a HTTP header. More... | |
| addHeaders (array $headers) | |
| Adds a new set of HTTP headers. More... | |
| removeHeader ($name) | |
| Removes a HTTP header. More... | |
| setHttpVersion ($version) | |
| Sets the HTTP version. More... | |
| getHttpVersion () | |
| Returns the HTTP version. More... | |
Detailed Description
This interface represents a HTTP response.
- Copyright
- Copyright (C) fruux GmbH (https://fruux.com/)
Definition at line 12 of file ResponseInterface.php.
Member Function Documentation
◆ getStatus()
| Sabre\HTTP\ResponseInterface::getStatus | ( | ) |
Returns the current HTTP status code.
- Returns
- int
Implemented in Sabre\HTTP\Response, and Sabre\HTTP\ResponseDecorator.
Referenced by Sabre\HTTP\ClientHttpException\__construct(), Sabre\DAV\Auth\Backend\AbstractDigest\challenge(), Sabre\DAV\Server\invokeMethod(), and Sabre\HTTP\Sapi\sendResponse().
Here is the caller graph for this function:
◆ getStatusText()
| Sabre\HTTP\ResponseInterface::getStatusText | ( | ) |
Returns the human-readable status string.
In the case of a 200, this may for example be 'OK'.
- Returns
- string
Implemented in Sabre\HTTP\Response, and Sabre\HTTP\ResponseDecorator.
Referenced by Sabre\HTTP\ClientHttpException\__construct(), and Sabre\HTTP\Sapi\sendResponse().
Here is the caller graph for this function:
◆ setStatus()
| Sabre\HTTP\ResponseInterface::setStatus | ( | $status | ) |
Sets the HTTP status code.
This can be either the full HTTP status code with human readable string, for example: "403 I can't let you do that, Dave".
Or just the code, in which case the appropriate default message will be added.
- Parameters
-
string | int $status
- Exceptions
-
Implemented in Sabre\HTTP\Response, and Sabre\HTTP\ResponseDecorator.
Referenced by Sabre\DAV\Auth\Backend\AbstractDigest\challenge(), Sabre\DAV\Server\checkPreconditions(), Sabre\DAV\Mount\Plugin\davMount(), Sabre\CalDAV\ICSExportPlugin\generateResponse(), Sabre\CalDAV\Schedule\Plugin\handleFreeBusyRequest(), Sabre\DAVACL\Plugin\httpAcl(), Sabre\DAV\CorePlugin\httpCopy(), Sabre\DAV\TemporaryFileFilterPlugin\httpDelete(), Sabre\DAV\CorePlugin\httpDelete(), Sabre\CardDAV\VCFExportPlugin\httpGet(), Sabre\DAV\CorePlugin\httpGet(), Sabre\DAV\Browser\Plugin\httpGet(), Sabre\CalDAV\Notifications\Plugin\httpGet(), Sabre\DAV\TemporaryFileFilterPlugin\httpGet(), Sabre\DAV\CorePlugin\httpHead(), Sabre\DAV\Locks\Plugin\httpLock(), Sabre\CalDAV\Plugin\httpMkCalendar(), Sabre\DAV\CorePlugin\httpMkcol(), Sabre\DAV\CorePlugin\httpMove(), Sabre\DAV\CorePlugin\httpOptions(), Sabre\DAV\PartialUpdate\Plugin\httpPatch(), Sabre\DAV\Browser\Plugin\httpPOST(), Sabre\DAV\Sharing\Plugin\httpPost(), Sabre\CalDAV\SharingPlugin\httpPost(), Sabre\DAV\TemporaryFileFilterPlugin\httpPropfind(), Sabre\DAV\CorePlugin\httpPropFind(), Sabre\DAV\CorePlugin\httpPropPatch(), Sabre\DAV\TemporaryFileFilterPlugin\httpPut(), Sabre\DAV\CorePlugin\httpPut(), and Sabre\DAV\Locks\Plugin\httpUnlock().
Here is the caller graph for this function:
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/http/lib/ResponseInterface.php
