Slim\Http\Environment Class Reference

Environment. More...

Inheritance diagram for Slim\Http\Environment:

Collaboration diagram for Slim\Http\Environment:

Static Public Member Functions
static	mock (array $userData=[])
	Create mock environment. More...
static	mock (array $settings=[])

Additional Inherited Members
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...
	set ($key, $value)
	get ($key, $default=null)
	replace (array $items)
	all ()
	has ($key)
	remove ($key)
	clear ()
Protected Attributes inherited from Slim\Collection
	$data = []

Detailed Description

Environment.

This class decouples the Slim application from the global PHP environment. This is particularly useful for unit testing, but it also lets us create custom sub-requests.

Definition at line 21 of file Environment.php.

Member Function Documentation

mock()

static Slim\Http\Environment::mock ( array  $userData = [] )

static

Create mock environment.

Parameters

array

$userData

Array of custom environment keys and values

Returns

self

Implements Slim\Interfaces\Http\EnvironmentInterface.

Definition at line 30 of file Environment.php.

    {
        //Validates if default protocol is HTTPS to set default port 443
        if ((isset($userData['HTTPS']) && $userData['HTTPS'] !== 'off') ||
            ((isset($userData['REQUEST_SCHEME']) && $userData['REQUEST_SCHEME'] === 'https'))) {
            $defscheme = 'https';
            $defport = 443;
        } else {
            $defscheme = 'http';
            $defport = 80;
        }
 
        $data = array_merge([
            'SERVER_PROTOCOL'      => 'HTTP/1.1',
            'REQUEST_METHOD'       => 'GET',
            'REQUEST_SCHEME'       => $defscheme,
            'SCRIPT_NAME'          => '',
            'REQUEST_URI'          => '',
            'QUERY_STRING'         => '',
            'SERVER_NAME'          => 'localhost',
            'SERVER_PORT'          => $defport,
            'HTTP_HOST'            => 'localhost',
            'HTTP_ACCEPT'          => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
            'HTTP_ACCEPT_LANGUAGE' => 'en-US,en;q=0.8',
            'HTTP_ACCEPT_CHARSET'  => 'ISO-8859-1,utf-8;q=0.7,*;q=0.3',
            'HTTP_USER_AGENT'      => 'Slim Framework',
            'REMOTE_ADDR'          => '127.0.0.1',
            'REQUEST_TIME'         => time(),
            'REQUEST_TIME_FLOAT'   => microtime(true),
        ], $userData);
 
        return new static($data);
    }

References Slim\Collection\$data.

---

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

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