Home/ Manual/ yaf / yaf_response_abstract/ Yaf_Response_Abstract::setHeader

Yaf_Response_Abstract::setHeader

PHP function Edit on GitHub ✎

(Yaf >=1.0.0)

Set an HTTP response header

Description

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

Set an HTTP response header.

Note

This method is only fully implemented in the Yaf_Response_Http subclass. In the abstract class it is a stub.

Parameters

name: The header name.
value: The header value.
replace: Whether to replace any existing header with the same name. If false, the new value is appended to the existing one, separated by a comma. Note that, although the declared default is false, the current implementation replaces the existing header when this parameter is omitted.
response_code: If non-zero, the HTTP response code to set on the response.

Return Values

Returns true on success, or false on failure.

Examples

Yaf_Response_Abstract::setHeader example

php

<?php
class IndexController extends Yaf_Controller_Abstract
{
    public function indexAction()
    {
        $response = $this->getResponse();

        $response->setHeader("Content-Type", "application/json");

        /* send a 401 and ask for credentials */
        $response->setHeader("WWW-Authenticate", 'Basic realm="Member Area"', true, 401);
    }
}
?>

Yaf_Response_Abstract::setHeader

Description

Parameters

Return Values

Examples

See Also