Подробное описание

Класс содержит методы по отдаче значений переменных из глобальных массивов.

Открытые члены
	__construct ()

	addFromArray (array $array, $storage)

	set ($key, $value, $storage)

	remove ($key, $storage)

	getParsedUrl ($key=null)

	getProtocol ()

	getSelfAbsoluteHost ()

	getSelfUrl ()

	getStreamInput ()

	get ($key, $type, $default=null, $strip="")

	post ($key, $type, $default=null, $strip="")

	request ($key, $type, $default=null, $strip="")

	cookie ($key, $type, $default=null, $strip="")

	files ($key, $type=TYPE_ARRAY, $default=null, $strip=null)

	server ($key, $type=TYPE_STRING, $default=null, $strip=null)

	parameters ($key, $default=null)

	getMethod ()

	isPost ()

	isKey ($key, $from=REQUEST)

	isAjax ()

	getSource ($storage)

	setSource (array $array, $storage)

	replaceKey ($new_keys, $search_keys=[], $prefix= '')

	setFromRouter (array $parameters, array $defaults)

	convert ($var, array $values, $is_assoc=false)

	saveUrl ($key, $url=null)

	getSavedUrl ($key, $default= '?')

	setCsrfProtection ($form_name= '')

	checkCsrf ($form_name= '')

	selfUri ()

	getDomainStr ()

	getDomain ($with_protocol=false)

Открытые статические члены
static	commonInstance ()

Поля данных
const	CSRF_INPUT_NAME = 'csrf_protection'

	$to_entity = true

Защищенные члены
	_returner (array $src, $keys, $type, $default, $strip)

Конструктор(ы)

__construct ( )

Методы

_returner	(	array	$src,
			$keys,
			$type,
			$default,
			$strip
	)

protected

Возвращает экранированное значение из одного источника

Аргументы

mixed	$src	- массив с данных источника
mixed	$keys	- ключ или ключи
mixed	$type	- ожидаемый тип данных.
mixed	$default	- значение по-умолчанию
mixed	$strip	- теги, которые не нужно вырезать. Если false, то теги strip_tags не будет вызываться Если null, то данные вообще не будут экранироваться

Возвращает: mixed

addFromArray	(	array	$array,
			$storage
	)

Добавляет список ключ => значение в один из массивов GET, POST, COOKIE, SERVER (не изменяет суперглобальные массивы)

Аргументы

array	$array	- массив со значениями
mixed	$storage	- константа GET, POST, COOKIE, SERVER

Возвращает: void

checkCsrf ( $form_name = '' )

Возвращает true, если проверка CSRF прошла успешно Бросает исключение, если CSRF токен некорректный

Аргументы

string $form_name имя формы. Зарезервировано

Возвращает: bool

static commonInstance ( )

static

Возвращает инстанс текущего класса с параметрами текущего запроса

Возвращает: static

convert	(		$var,
		array	$values,
			$is_assoc = `false`
	)

выбирает из списка values значение, которое соответствует ключу var. если таковое не найдено, то возвращается первое значение values

Аргументы

mixed	$var
array	$values
bool	$is_assoc	- true означает, что values - это ассоциативный массив, значение $var будет проверяться в ключах

Возвращает: boolean

cookie	(	$key,
		$type,
		$default = `null`,
		$strip = `""`
	)

Возвращает значение из суперглобального массива $_COOKIE.

Аргументы

string	$key	- имя ключа
string	$type	- тип ожидаемых данных. Используйте константы: TYPE_STRING, TYPE_INTEGER, TYPE_ARRAY, TYPE_BOOLEAN, TYPE_FLOAT
mixed	$default	- значение по-умолчанию, которое возвращается в случае, если параметра с заданным ключем не существует
mixed	$strip	- Какие теги не вырезать? Если false, то теги не будут вырезаться, иначе можно указать теги, которые нужно оставить. Например: '

'

Возвращает: mixed

files	(	$key,
		$type = `TYPE_ARRAY`,
		$default = `null`,
		$strip = `null`
	)

Возвращает значение из суперглобального массива $_FILES.

Аргументы

string	$key	- имя ключа
string	$type	- тип ожидаемых данных. Используйте константы: TYPE_STRING, TYPE_INTEGER, TYPE_ARRAY, TYPE_BOOLEAN, TYPE_FLOAT
mixed	$default	- значение по-умолчанию, которое возвращается в случае, если параметра с заданным ключем не существует
mixed	$strip	- Какие теги не вырезать? Если false, то теги не будут вырезаться, иначе можно указать теги, которые нужно оставить. Например: '

'

Возвращает: mixed

get	(	$key,
		$type,
		$default = `null`,
		$strip = `""`
	)

Возвращает значение из суперглобального массива $_GET.

Аргументы

string	$key	- имя ключа
string	$type	- тип ожидаемых данных. Используйте константы: TYPE_STRING, TYPE_INTEGER, TYPE_ARRAY, TYPE_BOOLEAN, TYPE_FLOAT
mixed	$default	- значение по-умолчанию, которое возвращается в случае, если параметра с заданным ключем не существует
mixed	$strip	- Какие теги не вырезать? Если false, то теги не будут вырезаться, иначе можно указать теги, которые нужно оставить. Например: '

'

Возвращает: mixed

getDomain ( $with_protocol = false )

Возвращает исходное доменное имя

Аргументы

bool $with_protocol - приписывать

Возвращает: string

getDomainStr ( )

Возвращает доменное имя, в кодировке utf8. В том числе и интернациональные домены

Возвращает: string

getMethod ( )

Возвращает метод, с которым была загружена страница

Возвращает: string POST, GET,...

getParsedUrl ( $key = null )

Парсит текущий URL и возвращает его частицу или весь массив частиц

Аргументы

string | null $key ключ scheme, host, port, user, pass, path, query, fragment

Возвращает: array | string

getProtocol ( )

Возвращает текущий протокол HTTP или HTTPS

Возвращает: string

getSavedUrl	(	$key,
		$default = `'?'`
	)

Возвращает сохраненный раннее Url

Аргументы

mixed	$key	- ключ
mixed	$default	- значение по-умолчанию

Возвращает: mixed

getSelfAbsoluteHost ( )

Возвращает строку вида http://текущий домен

Возвращает: string

getSelfUrl ( )

Возвращает абсолютный URL текущей страницы

Возвращает: string

getSource ( $storage )

Возвращает локальную копию суперглобального массива

Аргументы

mixed $storage - источник POST, GET, FILES,....

Возвращает: array

Исключения

RSException

getStreamInput ( )

Возвращает содержимое потока php://input (необработанные данные из тела запроса)

Возвращает: string|false

isAjax ( )

Возвращает true, если страница загружена с помощью ajax

Возвращает: bool

isKey	(	$key,
		$from = `REQUEST`
	)

Возвращает true, если в суперглобальном массиве присутствует параметр

Аргументы

string	$key	- параметр
mixed	$from	- источник GET, POST, SERVER, ....

Возвращает: bool Исключение оставлено на ручной контроль

isPost ( )

Возвращает true, если страница была загружена методом POST

Возвращает: bool

parameters	(	$key,
		$default = `null`
	)

Возвращает значение из локального хранилища

Аргументы

string	$key	- имя ключа
mixed	$default	- значение по-умолчанию, которое возвращается в случае, если параметра с заданным ключем не существует

Возвращает: mixed

post	(	$key,
		$type,
		$default = `null`,
		$strip = `""`
	)

Возвращает значение из суперглобального массива $_POST.

Аргументы

string	$key	- имя ключа
string	$type	- тип ожидаемых данных. Используйте константы: TYPE_STRING, TYPE_INTEGER, TYPE_ARRAY, TYPE_BOOLEAN, TYPE_FLOAT
mixed	$default	- значение по-умолчанию, которое возвращается в случае, если параметра с заданным ключем не существует
mixed	$strip	- Какие теги не вырезать? Если false, то теги не будут вырезаться, иначе можно указать теги, которые нужно оставить. Например: '

'

Возвращает: mixed

remove	(	$key,
		$storage
	)

Удаляет запись из копии суперглобального массива

Аргументы

mixed	$key	- ключ
mixed	$storage	- тип хранилища

Возвращает: void

replaceKey	(	$new_keys,
		$search_keys = `[]`,
		$prefix = `''`
	)

Возвращает URL с замещенными или добавленными параметрами

Аргументы

array	$new_keys	- добавить/заменить параметры
array	$search_keys	- полный список параметров, которые нужно оставить
mixed	$prefix	- добавлять префикс перед $new_keys параметрами

Возвращает: string

Исключения

RSException

request	(	$key,
		$type,
		$default = `null`,
		$strip = `""`
	)

Возвращает значение из суперглобального массива $_REQUEST.

Аргументы

string	$key	- имя ключа
string	$type	- тип ожидаемых данных. Используйте константы: TYPE_STRING, TYPE_INTEGER, TYPE_ARRAY, TYPE_BOOLEAN, TYPE_FLOAT
mixed	$default	- значение по-умолчанию, которое возвращается в случае, если параметра с заданным ключем не существует
mixed	$strip	- Какие теги не вырезать? Если false, то теги не будут вырезаться, иначе можно указать теги, которые нужно оставить. Например: '

'

Возвращает: mixed

saveUrl	(	$key,
		$url = `null`
	)

Сохраняет в сессии Url

Аргументы

mixed	$key	- ключ
string	$url	- сохраняемый url, если не указан то текущий url

Возвращает: void

selfUri ( )

Возвращает uri текущей страницы

Возвращает: string

server	(	$key,
		$type = `TYPE_STRING`,
		$default = `null`,
		$strip = `null`
	)

Возвращает значение из суперглобального массива $_SERVER.

Аргументы

string	$key	- имя ключа
string	$type	- тип ожидаемых данных. Используйте константы: TYPE_STRING, TYPE_INTEGER, TYPE_ARRAY, TYPE_BOOLEAN, TYPE_FLOAT
mixed	$default	- значение по-умолчанию, которое возвращается в случае, если параметра с заданным ключем не существует
mixed	$strip	- Какие теги не вырезать? Если false, то теги не будут вырезаться, иначе можно указать теги, которые нужно оставить. Например: '

'

Возвращает: mixed

set	(	$key,
		$value,
		$storage
	)

Устанавливает в локальные копии суперглобальных массивов значения

Аргументы

mixed	$key	- ключ
mixed	$value	- значение
mixed	$storage	- тип хранилища GET, POST, COOKIE, SERVER

Возвращает: void

setCsrfProtection ( $form_name = '' )

Возвращает код, который необходимо добавить в форму для CSRF защиты

Аргументы

string $form_name имя формы. Зарезервировано

Возвращает: string

setFromRouter	(	array	$parameters,
		array	$defaults
	)

Добавляет параметры, полученные маршрутизатором

Аргументы

array	$parameters	параметры, которые были найдены в URL
array	$defaults	параметры по умолчанию, которые заданы в маршруте

setSource	(	array	$array,
			$storage
	)

Устанавливает значение локальной копии суперглобального массива

Аргументы

array	$array	- Массив с данными
mixed	$storage	- тип хранилища POST, GET, ...

Возвращает: void

Исключения

RSException

Поля

$to_entity = true

const CSRF_INPUT_NAME = 'csrf_protection'

Подробное описание

Открытые члены

Открытые статические члены

Поля данных

Защищенные члены

Конструктор(ы)

Методы

Поля