Yaf_Response_Abstract::getHeader

(Yaf >=1.0.0)

Yaf_Response_Abstract::getHeaderRetrieve an HTTP response header

Description

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

Retrieve 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. If omitted, all headers are returned as an array.

Return Values

The header value as a string, or an array of all headers when the name is omitted. Returns null if the requested header is not set.

Examples

Example #1 Yaf_Response_Abstract::getHeader() example

<?php
class IndexController extends Yaf_Controller_Abstract
{
    public function indexAction()
    {
        $response = $this->getResponse();
        $response->setHeader("Content-Type", "application/json");

        var_dump($response->getHeader("Content-Type"));
        var_dump($response->getHeader()); // all headers
        var_dump($response->getHeader("X-Missing"));
    }
}
?>

The above example will output something similar to:

string(16) "application/json"
array(1) {
  ["Content-Type"]=>
  string(16) "application/json"
}
NULL

See Also

add a note

User Contributed Notes

There are no user contributed notes for this page.