The Yaf_Response_Abstract class

(Yaf >=1.0.0)

Introduction

Yaf_Response_Abstract is the base class of the response object, which carries the headers and the content blocks to be sent to the client. It is instantiated by Yaf_Dispatcher; use Yaf_Dispatcher::getResponse() to access it, typically inside controllers, actions or plugins.

The concrete subclasses are Yaf_Response_Http (used in web SAPIs, which actually sends HTTP headers) and Yaf_Response_Cli (used on the command line).

Class synopsis

class Yaf_Response_Abstract {

/* Constants */

const string DEFAULT_BODY = "content";

/* Properties */

protected $_header;

protected $_body;

protected $_sendheader;

/* Methods */

public function __construct()

public function appendBody(string $body, string $key = ?): Yaf_Response_Abstract|false|null

public function clearBody(string $key = ?): Yaf_Response_Abstract|false|null

public function clearHeaders(): Yaf_Response_Abstract|false|null

public function getBody(string $key = ?): mixed

public function getHeader(string $name = ?): string|array|null

public function prependBody(string $body, string $key = ?): Yaf_Response_Abstract|false|null

public function response(): ?bool

public function setAllHeaders(array $headers): bool

public function setBody(string $body, string $key = ?): Yaf_Response_Abstract|false|null

public function setHeader(
    string $name,
    string $value,
    bool $replace = false,
    int $response_code = 0
): bool

public function setRedirect(string $url): ?bool

private function __toString(): string

}

Properties

_header: The HTTP headers set so far, as an array of header name/value pairs. Only meaningful for Yaf_Response_Http.
_body: The content blocks, keyed by the content key (by default content, i.e. Yaf_Response_Abstract::DEFAULT_BODY).
_sendheader: Whether headers should be sent together with the content. In Yaf_Response_Http it also tracks whether the headers have been sent already.

Yaf_Response_Abstract::appendBody — Append to the response body
Yaf_Response_Abstract::clearBody — Discard all existing response bodies
Yaf_Response_Abstract::clearHeaders — Remove all response headers
Yaf_Response_Abstract::__construct — Construct a response
Yaf_Response_Abstract::getBody — Retrieve a response body block
Yaf_Response_Abstract::getHeader — Retrieve an HTTP response header
Yaf_Response_Abstract::prependBody — Prepend to the response body
Yaf_Response_Abstract::response — Send the response
Yaf_Response_Abstract::setAllHeaders — Set all HTTP response headers
Yaf_Response_Abstract::setBody — Set content to the response
Yaf_Response_Abstract::setHeader — Set an HTTP response header
Yaf_Response_Abstract::setRedirect — Redirect to another URL
Yaf_Response_Abstract::__toString — Retrieve all bodys as string

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.