class ServerBag extends ParameterBag
ServerBag is a container for HTTP headers from the $_SERVER variable.
protected
|
$parameters |
Parameter storage. | from ParameterBag |
public
|
|
__construct(array $parameters = array())
|
No description | from ParameterBag |
public
|
array |
all()
|
Returns the parameters. | from ParameterBag |
public
|
array |
keys()
|
Returns the parameter keys. | from ParameterBag |
public
|
|
replace(array $parameters = array())
|
Replaces the current parameters by a new set. | from ParameterBag |
public
|
|
add(array $parameters = array())
|
Adds parameters. | from ParameterBag |
public
|
mixed |
get(string $key, mixed $default = null)
|
Returns a parameter by name. | from ParameterBag |
public
|
|
set(string $key, mixed $value)
|
Sets a parameter by name. | from ParameterBag |
public
|
bool |
has(string $key)
|
Returns true if the parameter is defined. | from ParameterBag |
public
|
|
remove(string $key)
|
Removes a parameter. | from ParameterBag |
public
|
string |
getAlpha(string $key, string $default = '')
|
Returns the alphabetic characters of the parameter value. | from ParameterBag |
public
|
string |
getAlnum(string $key, string $default = '')
|
Returns the alphabetic characters and digits of the parameter value. | from ParameterBag |
public
|
string |
getDigits(string $key, string $default = '')
|
Returns the digits of the parameter value. | from ParameterBag |
public
|
int |
getInt(string $key, int $default)
|
Returns the parameter value converted to integer. | from ParameterBag |
public
|
bool |
getBoolean(string $key, mixed $default = false)
|
Returns the parameter value converted to boolean. | from ParameterBag |
public
|
mixed |
filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())
|
Filter key. | from ParameterBag |
public
|
ArrayIterator |
getIterator()
|
Returns an iterator for parameters. | from ParameterBag |
public
|
int |
count()
|
Returns the number of parameters. | from ParameterBag |
public
|
array |
getHeaders()
|
Gets the HTTP headers. |
__construct()public __construct(array $parameters = array())
array |
$parameters |
An array of parameters |
all()public array all()
Returns the parameters.
array |
An array of parameters |
keys()public array keys()
Returns the parameter keys.
array |
An array of parameter keys |
replace()public replace(array $parameters = array())
Replaces the current parameters by a new set.
array |
$parameters |
An array of parameters |
add()public add(array $parameters = array())
Adds parameters.
array |
$parameters |
An array of parameters |
get()public mixed get(string $key, mixed $default = null)
Returns a parameter by name.
string |
$key |
The key |
mixed |
$default |
The default value if the parameter key does not exist |
mixed |
set()public set(string $key, mixed $value)
Sets a parameter by name.
string |
$key |
The key |
mixed |
$value |
The value |
has()public bool has(string $key)
Returns true if the parameter is defined.
string |
$key |
The key |
bool |
true if the parameter exists, false otherwise |
remove()public remove(string $key)
Removes a parameter.
string |
$key |
The key |
getAlpha()public string getAlpha(string $key, string $default = '')
Returns the alphabetic characters of the parameter value.
string |
$key |
The parameter key |
string |
$default |
The default value if the parameter key does not exist |
string |
The filtered value |
getAlnum()public string getAlnum(string $key, string $default = '')
Returns the alphabetic characters and digits of the parameter value.
string |
$key |
The parameter key |
string |
$default |
The default value if the parameter key does not exist |
string |
The filtered value |
getDigits()public string getDigits(string $key, string $default = '')
Returns the digits of the parameter value.
string |
$key |
The parameter key |
string |
$default |
The default value if the parameter key does not exist |
string |
The filtered value |
getInt()public int getInt(string $key, int $default)
Returns the parameter value converted to integer.
string |
$key |
The parameter key |
int |
$default |
The default value if the parameter key does not exist |
int |
The filtered value |
getBoolean()public bool getBoolean(string $key, mixed $default = false)
Returns the parameter value converted to boolean.
string |
$key |
The parameter key |
mixed |
$default |
The default value if the parameter key does not exist |
bool |
The filtered value |
filter()public mixed filter(string $key, mixed $default = null, int $filter = FILTER_DEFAULT, mixed $options = array())
Filter key.
string |
$key |
Key |
mixed |
$default |
Default = null |
int |
$filter |
FILTER_* constant |
mixed |
$options |
Filter options |
mixed |
| http://php.net/manual/en/function.filter-var.php |
getIterator()public ArrayIterator getIterator()
count()public int count()
Returns the number of parameters.
int |
The number of parameters |
getHeaders()public array getHeaders()
Gets the HTTP headers.
array |
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Khan\Component\HttpFoundation;
/**
* ServerBag is a container for HTTP headers from the $_SERVER variable.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
* @author Robert Kiss <kepten@gmail.com>
*/
class ServerBag extends ParameterBag
{
/**
* Gets the HTTP headers.
*
* @return array
*/
public function getHeaders()
{
$headers = array();
$contentHeaders = array('CONTENT_LENGTH' => true, 'CONTENT_MD5' => true, 'CONTENT_TYPE' => true);
foreach ($this->parameters as $key => $value) {
if (0 === strpos($key, 'HTTP_')) {
$headers[substr($key, 5)] = $value;
}
// CONTENT_* are not prefixed with HTTP_
elseif (isset($contentHeaders[$key])) {
$headers[$key] = $value;
}
}
if (isset($this->parameters['PHP_AUTH_USER'])) {
$headers['PHP_AUTH_USER'] = $this->parameters['PHP_AUTH_USER'];
$headers['PHP_AUTH_PW'] = isset($this->parameters['PHP_AUTH_PW']) ? $this->parameters['PHP_AUTH_PW'] : '';
} else {
/*
* php-cgi under Apache does not pass HTTP Basic user/pass to PHP by default
* For this workaround to work, add these lines to your .htaccess file:
* RewriteCond %{HTTP:Authorization} ^(.+)$
* RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
*
* A sample .htaccess file:
* RewriteEngine On
* RewriteCond %{HTTP:Authorization} ^(.+)$
* RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
* RewriteCond %{REQUEST_FILENAME} !-f
* RewriteRule ^(.*)$ app.php [QSA,L]
*/
$authorizationHeader = null;
if (isset($this->parameters['HTTP_AUTHORIZATION'])) {
$authorizationHeader = $this->parameters['HTTP_AUTHORIZATION'];
} elseif (isset($this->parameters['REDIRECT_HTTP_AUTHORIZATION'])) {
$authorizationHeader = $this->parameters['REDIRECT_HTTP_AUTHORIZATION'];
}
if (null !== $authorizationHeader) {
if (0 === stripos($authorizationHeader, 'basic ')) {
// Decode AUTHORIZATION header into PHP_AUTH_USER and PHP_AUTH_PW when authorization header is basic
$exploded = explode(':', base64_decode(substr($authorizationHeader, 6)), 2);
if (2 == count($exploded)) {
list($headers['PHP_AUTH_USER'], $headers['PHP_AUTH_PW']) = $exploded;
}
} elseif (empty($this->parameters['PHP_AUTH_DIGEST']) && (0 === stripos($authorizationHeader, 'digest '))) {
// In some circumstances PHP_AUTH_DIGEST needs to be set
$headers['PHP_AUTH_DIGEST'] = $authorizationHeader;
$this->parameters['PHP_AUTH_DIGEST'] = $authorizationHeader;
} elseif (0 === stripos($authorizationHeader, 'bearer ')) {
/*
* XXX: Since there is no PHP_AUTH_BEARER in PHP predefined variables,
* I'll just set $headers['AUTHORIZATION'] here.
* http://php.net/manual/en/reserved.variables.server.php
*/
$headers['AUTHORIZATION'] = $authorizationHeader;
}
}
}
if (isset($headers['AUTHORIZATION'])) {
return $headers;
}
// PHP_AUTH_USER/PHP_AUTH_PW
if (isset($headers['PHP_AUTH_USER'])) {
$headers['AUTHORIZATION'] = 'Basic '.base64_encode($headers['PHP_AUTH_USER'].':'.$headers['PHP_AUTH_PW']);
} elseif (isset($headers['PHP_AUTH_DIGEST'])) {
$headers['AUTHORIZATION'] = $headers['PHP_AUTH_DIGEST'];
}
return $headers;
}
}