GyroHeaders Class Reference

This class works around some limitations in PHP header handling. More...

List of all members.

Static Public Member Functions
static	headers ()
	Get all set headers as assoziative array with (lower case) header name as key and full header as value.
static	is_set ($name)
	Returns TRUE, if header with given name was alreday set or send.
static	remove ($name)
	Remove given header.
static	restore ($arr_headers)
	Restore headers.
static	send ()
	Send all headers set.
static	set ($name, $value=false, $override=true)
	Set a header.
static	split ($header)
	Split header into array with name as first element, and value as second.
static	sync ()
	Read headers send into internal array.
static	values ()
	Get all set headers as assoziative array with (lower case) header name as key and value as value.

---

Detailed Description

This class works around some limitations in PHP header handling.

LImitations are:

• headers cannot be removes prior to PHP 5.3
• if headers are removed, one cannot tell, so they may be set from other parts of application

Definition at line 10 of file headers.cls.php.

---

Member Function Documentation

static GyroHeaders::headers

(

)

[static]

Get all set headers as assoziative array with (lower case) header name as key and full header as value.

Returns:

array

Definition at line 71 of file headers.cls.php.

                                         {
                $ret = array();
                foreach(self::$headers as $name => $value) {
                        if ($value) {
                                $value = $name . ': ' . $value; 
                        }
                        $ret[strtolower($name)] = $value;
                }
                return $ret;
        }

static GyroHeaders::is_set

(

$

name

)

[static]

Returns TRUE, if header with given name was alreday set or send.

Parameters:

string

$name

Returns:

bool

Definition at line 51 of file headers.cls.php.

                                             {
                $ret = false;
                
                $name = strtolower($name);
                foreach(self::$headers as $hdr => $value) {
                        $hdr = strtolower($hdr);
                        if ($hdr == $name) {
                                $ret = true;
                                break;
                        }       
                }
                return $ret;            
        }

static GyroHeaders::remove

(

$

name

)

[static]

Remove given header.

Definition at line 41 of file headers.cls.php.

                                             {
                self::$headers[$name] = '';             
        }

static GyroHeaders::restore

(

$

arr_headers

)

[static]

Restore headers.

Headers not in passed array wil be removed, headers from array will be set

Attention:

Expects array

Parameters:

$arr_headers

Array of headers with header name as key and full header as value

Definition at line 105 of file headers.cls.php.

                                                     {
                $current = self::headers();
                // array_diff_key exists as of PHP 5.1.0 only
                foreach(array_diff(array_keys($current), array_keys($arr_headers)) as $name) {
                        self::remove($name);
                }
                foreach($arr_headers as $name => $value) {
                        self::set($value, false, true);
                }
        }

static GyroHeaders::send

(

)

[static]

Send all headers set.

Exceptions:

Exception

if headers were already sent

Returns:

void

Definition at line 133 of file headers.cls.php.

                                      {
                $file = '';
                $line = 0;
                if (headers_sent($file, $line)) {
                        throw new Exception('GyroHeaders: Headers already sent in file "' . $file . '" on line ' . $line);
                }
                $has_remove = function_exists('header_remove');
                foreach(self::$headers as $name => $value) {
                        if ($value) {
                                header($name . ': ' . $value);
                        }
                        else if ($has_remove) {
                                // As of PHP 5.3
                                header_remove($name);
                        } 
                }
        }

static GyroHeaders::set	(	$	name,
		$	value = false,
		$	override = true
	)			[static]

Set a header.

Parameters:

	string	$name Name of header or complete header (if $value is false)
	string	$value Value of header
	bool	If FALSE, header will not be set, if header with same name was already set

Definition at line 27 of file headers.cls.php.

                                                                            {
                if ($value === false) {
                        $tmp = self::split($name);
                        $name = array_shift($tmp);
                        $value = array_shift($tmp);
                }
                if ($override || !self::is_set($name)) {
                        self::$headers[$name] = $value; 
                }
        }

static GyroHeaders::split

(

$

header

)

[static]

Split header into array with name as first element, and value as second.

Returns:

array

Definition at line 156 of file headers.cls.php.

                                              {
                $ret = explode(':', $header, 2);
                if (count($ret) == 1) {
                        $ret = explode(' ', $header, 2);
                }
                if (count($ret) == 1) {
                        $ret[] = '';
                }
                array_walk($ret, 'trim');
                return $ret;
        }               

static GyroHeaders::sync

(

)

[static]

Read headers send into internal array.

Returns:

void

Definition at line 121 of file headers.cls.php.

                                      {
                foreach(headers_list() as $header) {
                        self::set($header, false, false);
                }
        }

static GyroHeaders::values

(

)

[static]

Get all set headers as assoziative array with (lower case) header name as key and value as value.

Returns:

array

Definition at line 88 of file headers.cls.php.

                                        {
                $ret = array();
                foreach(self::$headers as $name => $value) {
                        $ret[strtolower($name)] = $value;
                }
                return $ret;
        }

---

The documentation for this class was generated from the following file:

• gyro/core/lib/helpers/headers.cls.php