Slim\Http\Headers Class Reference

Headers. More...

Inheritance diagram for Slim\Http\Headers:

Collaboration diagram for Slim\Http\Headers:

Public Member Functions
	all ()
	Return array of HTTP header names and values. More...
	set ($key, $value)
	Set HTTP header value. More...
	get ($key, $default=null)
	Get HTTP header value. More...
	getOriginalKey ($key, $default=null)
	Get HTTP header key as originally specified. More...
	add ($key, $value)
	Add HTTP header value. More...
	has ($key)
	Does this collection have a given header? More...
	remove ($key)
	Remove header from collection. More...
	normalizeKey ($key)
	Normalize header name. More...
Public Member Functions inherited from Slim\Collection
	__construct (array $items=[])
	Create new collection. More...
	set ($key, $value)
	Set collection item. More...
	get ($key, $default=null)
	Get collection item for key. More...
	replace (array $items)
	Add item to collection, replacing existing items with the same data key. More...
	all ()
	Get all items in collection. More...
	keys ()
	Get collection keys. More...
	has ($key)
	Does this collection have a given key? More...
	remove ($key)
	Remove item from collection. More...
	clear ()
	Remove all items from collection. More...
	offsetExists ($key)
	Does this collection have a given key? More...
	offsetGet ($key)
	Get collection item for key. More...
	offsetSet ($key, $value)
	Set collection item. More...
	offsetUnset ($key)
	Remove item from collection. More...
	count ()
	Get number of items in collection. More...
	getIterator ()
	Get collection iterator. More...

Static Public Member Functions
static static	createFromEnvironment (Environment $environment)
	Create new headers collection with data extracted from the application Environment object. More...
static	determineAuthorization (Environment $environment)
	If HTTP_AUTHORIZATION does not exist tries to get it from getallheaders() when available. More...

Static Protected Attributes
static	$special

Additional Inherited Members
Protected Attributes inherited from Slim\Collection
	$data = []

Detailed Description

Headers.

This class represents a collection of HTTP headers that is used in both the HTTP request and response objects. It also enables header name case-insensitivity when getting or setting a header value.

Each HTTP header can have multiple values. This class stores values into an array for each header name. When you request a header value, you receive an array of values for that header.

Definition at line 27 of file Headers.php.

Member Function Documentation

add()

Slim\Http\Headers::add	(		$key,
			$value
	)

Add HTTP header value.

This method appends a header value. Unlike the set() method, this method appends this new value to any values that already exist for this header name.

Parameters

string	$key	The case-insensitive header name
array | string	$value	The new header value(s)

Implements Slim\Interfaces\Http\HeadersInterface.

Definition at line 173 of file Headers.php.

References $key.

    {
        $oldValues = $this->get($key, []);
        $newValues = is_array($value) ? $value : [$value];
        $this->set($key, array_merge($oldValues, array_values($newValues)));
    }

all()

Slim\Http\Headers::all

(

)

Return array of HTTP header names and values.

This method returns the original header name as specified by the end user.

Returns

array

Implements Slim\Interfaces\CollectionInterface.

Definition at line 98 of file Headers.php.

References $key, and $out.

    {
        $all = parent::all();
        $out = [];
        foreach ($all as $key => $props) {
            $out[$props['originalKey']] = $props['value'];
        }

        return $out;
    }

createFromEnvironment()

static static Slim\Http\Headers::createFromEnvironment ( Environment  $environment )

static

Create new headers collection with data extracted from the application Environment object.

Parameters

Environment

$environment

The Slim application Environment

Returns

self

Definition at line 51 of file Headers.php.

References Slim\Collection\$data, and $key.

Referenced by Slim\Http\Request\createFromEnvironment().

    {
        $data = [];
        $environment = self::determineAuthorization($environment);
        foreach ($environment as $key => $value) {
            $key = strtoupper($key);
            if (isset(static::$special[$key]) || strpos($key, 'HTTP_') === 0) {
                if ($key !== 'HTTP_CONTENT_LENGTH') {
                    $data[$key] =  $value;
                }
            }
        }

        return new static($data);
    }

Here is the caller graph for this function:

determineAuthorization()

static Slim\Http\Headers::determineAuthorization ( Environment  $environment )

static

If HTTP_AUTHORIZATION does not exist tries to get it from getallheaders() when available.

Parameters

Environment

$environment

The Slim application Environment

Returns

Environment

Definition at line 76 of file Headers.php.

References Slim\Collection\get(), and Slim\Collection\set().

    {
        $authorization = $environment->get('HTTP_AUTHORIZATION');

        if (empty($authorization) && is_callable('getallheaders')) {
            $headers = getallheaders();
            $headers = array_change_key_case($headers, CASE_LOWER);
            if (isset($headers['authorization'])) {
                $environment->set('HTTP_AUTHORIZATION', $headers['authorization']);
            }
        }

        return $environment;
    }

Here is the call graph for this function:

get()

Slim\Http\Headers::get	(		$key,
			$default = null
	)

Get HTTP header value.

Parameters

string	$key	The case-insensitive header name
mixed	$default	The default value if key does not exist

Returns

string[]

Implements Slim\Interfaces\CollectionInterface.

Definition at line 137 of file Headers.php.

References $key, Slim\Http\Headers\has(), and Slim\Http\Headers\normalizeKey().

    {
        if ($this->has($key)) {
            return parent::get($this->normalizeKey($key))['value'];
        }

        return $default;
    }

Here is the call graph for this function:

getOriginalKey()

Slim\Http\Headers::getOriginalKey	(		$key,
			$default = null
	)

Get HTTP header key as originally specified.

Parameters

string	$key	The case-insensitive header name
mixed	$default	The default value if key does not exist

Returns

string

Definition at line 154 of file Headers.php.

References $key, Slim\Http\Headers\has(), and Slim\Http\Headers\normalizeKey().

    {
        if ($this->has($key)) {
            return parent::get($this->normalizeKey($key))['originalKey'];
        }

        return $default;
    }

Here is the call graph for this function:

has()

Slim\Http\Headers::has

(

$key

)

Does this collection have a given header?

Parameters

string

$key

The case-insensitive header name

Returns

bool

Implements Slim\Interfaces\CollectionInterface.

Definition at line 187 of file Headers.php.

References $key, and Slim\Http\Headers\normalizeKey().

Referenced by Slim\Http\Headers\get(), and Slim\Http\Headers\getOriginalKey().

    {
        return parent::has($this->normalizeKey($key));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

normalizeKey()

Slim\Http\Headers::normalizeKey

(

$key

)

Normalize header name.

This method transforms header names into a normalized form. This is how we enable case-insensitive header names in the other methods in this class.

Parameters

string

$key

The case-insensitive header name

Returns

string Normalized header name

Implements Slim\Interfaces\Http\HeadersInterface.

Definition at line 213 of file Headers.php.

References $key.

Referenced by Slim\Http\Headers\get(), Slim\Http\Headers\getOriginalKey(), Slim\Http\Headers\has(), Slim\Http\Headers\remove(), and Slim\Http\Headers\set().

    {
        $key = strtr(strtolower($key), '_', '-');
        if (strpos($key, 'http-') === 0) {
            $key = substr($key, 5);
        }

        return $key;
    }

Here is the caller graph for this function:

remove()

Slim\Http\Headers::remove

(

$key

)

Remove header from collection.

Parameters

string

$key

The case-insensitive header name

Implements Slim\Interfaces\CollectionInterface.

Definition at line 197 of file Headers.php.

References $key, Slim\Http\Headers\normalizeKey(), and remove().

    {
        parent::remove($this->normalizeKey($key));
    }

Here is the call graph for this function:

set()

Slim\Http\Headers::set	(		$key,
			$value
	)

Set HTTP header value.

This method sets a header value. It replaces any values that may already exist for the header name.

Parameters

string	$key	The case-insensitive header name
string	$value	The header value

Implements Slim\Interfaces\CollectionInterface.

Definition at line 118 of file Headers.php.

References $key, and Slim\Http\Headers\normalizeKey().

    {
        if (!is_array($value)) {
            $value = [$value];
        }
        parent::set($this->normalizeKey($key), [
            'value' => $value,
            'originalKey' => $key
        ]);
    }

Here is the call graph for this function:

Field Documentation

$special

Slim\Http\Headers::$special

staticprotected

Initial value:

= [
        'CONTENT_TYPE' => 1

Definition at line 34 of file Headers.php.

---

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

• libs/composer/vendor/slim/slim/Slim/Http/Headers.php