waRequest

Обработка запросов пользователей к серверу

Содержание...

Методы

  • cookie

    Возвращает информацию о содержимом файлов cookie пользователя.

  • file

    Возвращает список файлов, загруженных пользователем.

  • get

    Возвращает содержимое GET-запроса.

  • getIp

    Возвращает IP-адрес пользователя.

  • getLocale

    Определяет локаль пользователя.

  • getMethod

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

  • getPostMaxSize

    Возвращает размер серверного ограничения на размер POST-запроса.

  • getTheme

    Возвращает идентификатор темы дизайна, использующейся на странице фронтенда.

  • getUploadMaxFilesize

    Возвращает размер серверного ограничения на размер загружаемых файлов.

  • getUserAgent

    Возвращает содержимое заголовка запроса HTTP_USER_AGENT.

  • isHttps

    Определяет факт обращения к серверу через HTTPS.

  • isMobile

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

  • issetPost

    Проверяет наличие значения элемента POST-запроса.

  • isXMLHttpRequest

    Определяет факт выполнения AJAX-запроса.

  • method

    Возвращает обозначение типа запроса к серверу, выполненного пользователем. Псеводним для метода getMethod.

  • param

    Возвращает дополнительные параметры запроса к серверу.

  • post

    Возвращает содержимое POST-запроса.

  • request

    Возвращает общее содержимое GET- и POST-запросов или значение указанного элемента запроса.

  • server

    Возвращает содержимое массива $_SERVER.

  • setParam

    Устанавливает значения для дополнительных параметров запроса.

public static function cookie ($name = null, $default = null, $type = null)

Возвращает информацию о содержимом файлов cookie пользователя.

Параметры

  • $name

    Идентификатор записи cookie. Если не указан, метод вернет содержимое всех полученных от пользователя записей.

  • $default

    Значение по умолчанию — возвращается при указанном значении параметра $name в случае отсутствия значения для указанной записи.

  • $type

    Тип данных, к которому необходимо привести значение указанной записи. Допустимые типы данных:

    • int: целое число
    • string: строка
    • string_trim: строка с удаленными пробельными символами в начале и в конце
    • array_int: массив целых чисел
    • array: массив произвольных значений

Пример

waRequest::cookie()

Результат

Array
(
    [PHPSESSID] => 50ukl8c8qns02kl02pjmenqkf7
    [_csrf] => 52c10405125ea9.47558260
)

public static function file ($name)

Возвращает список загруженных пользователем файлов в виде экземпляра класса waRequestFileIterator. При использовании результата вызова метода waRequest::file() в качестве массива в цикле foreach каждый элемент массива представляет собой экземпляр класса waRequestFile.

Параметры

  • $name

    Идентификатор поля формы, с помощью которого выполняется загрузка файлов на сервер (значение атрибута name тега <input type="file">).

Пример

waRequest::file('photo')->count()

Результат

1 //пользователем загружен 1 файл через элемент выбора файла с именем photo

public static function get ($name = null, $default = null, $type = null)

Возвращает содержимое GET-запроса.

Параметры

  • $name

    Идентификатор элемента GET-запроса. Если не указан, метод вернет содержимое всех полученных от пользователя элементов запроса.

  • $default

    Значение по умолчанию — возвращается при указанном значении параметра $name в случае отсутствия значения для указанного элемента.

  • $type

    Тип данных, к которому необходимо привести значение указанного элемента. Допустимые типы данных перечислены в описании метода cookie.

Пример

waRequest::get('id', 0, 'int')

public static function getIp ($get_as_int = false)

Возвращает IP-адрес пользователя.

Параметры

  • $get_as_int

    Флаг, обозначающий, нужно ли вернуть значение IP-адреса в виде целого числа.

Пример

waRequest::getIp()

Результат

127.0.0.1

Пример

waRequest::getIp(true)

Результат

2130706433

public static function getLocale ($default = null, $browser_only = false)

Определяет локаль пользователя.

Параметры

  • $default

    Значение по умолчанию, которое возвращается методом, если локаль пользователя определить не удалось. Если указано значение true, то это же значение присваивается и параметру $browser_only.

  • $browser_only

    Флаг, обозначающий необходимость определения локали пользователя только по заголовкам браузера, игнорируя дополнительные параметры запроса, установленные с помощью метода setParam.

Пример

waRequest::getLocale()

public static function getMethod()

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

Пример

waRequest::getMethod()

Результат

post //пользователь выполнил POST-запрос

public static function getPostMaxSize()

Возвращает размер серверного ограничения на размер POST-запроса в байтах.

Пример

waRequest::getPostMaxSize()

Результат

20971520

public static function getTheme()

Возвращает идентификатор темы дизайна, использующейся на странице фронтенда.

Пример

waRequest::getTheme()

Результат

custom //текущая страница фронтенда использует тему дизайна «CUSTOM»

public static function getUploadMaxFilesize()

Возвращает размер серверного ограничения на размер загружаемых файлов в байтах.

Пример

waRequest::getUploadMaxFilesize()

Результат

20971520

public static function getUserAgent()

Возвращает содержимое заголовка запроса HTTP_USER_AGENT.

Пример

waRequest::getUserAgent()

Результат

Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/31.0.1650.63 Chrome/31.0.1650.63 Safari/537.36

public static function isHttps()

Определяет факт обращения к серверу через HTTPS.

Пример

$is_https = waRequest::isHttps()

public static function isMobile ($check = true)

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

Параметры

  • $check

    Флаг, обозначающий необходимость обновления и проверки значения поля nomobile в PHP-сессии пользователя. При значении true выполняются следующие дейстия:

    • Если в GET-запросе присутствует переменная nomobile со значением, эквивалентным true, то в поле nomobile PHP-сессии записывается значение true. Если значение этой переменной экивалентно false, то поле nomobile удаляется из PHP-сессии пользователя.
    • Если в GET-запросе отсутствует переменная переменная nomobile и присутствует переменная mobile со значением, эквивалентным true, то поле nomobile удаляется из PHP-сессии пользователя.
    • Если после выполнения этих действий поле nomobile PHP-сессии содержит значение true, то метод возвращает false. В противном случае метод продолжает работу, как если бы значение флага было равно false.

    При значении флага false факт использования мобильного устройства определяется на основании содержимого заголовка HTTP_USER_AGENT. В случае обнаружения этого факта метод возвращает один из следующих идентификаторов:

    • android
    • blackberry
    • iphone
    • opera
    • palm
    • windows
    • generic

Пример

waRequest::isMobile()

Результат

android //пользователь использует мобильное устройство на базе Android

public static function issetPost ($name)

Проверяет наличие значения элемента POST-запроса.

Параметры

  • $name

    Идентификатор элемента POST-запроса.

Пример

waRequest::issetPost('id')

Результат

false //в POST-запросе отсутствует значение элемента с идентификатором 'id'

public static function isXMLHttpRequest()

Определяет факт выполнения AJAX-запроса.

Пример

waRequest::isXMLHttpRequest()

Результат

true //пользователь выполнил AJAX-запрос с веб-страницы

public static function method()

Возвращает обозначение типа запроса к серверу, выполненного пользователем. Псеводним для метода getMethod.

Пример

waRequest::method()

Результат

post //пользователь выполнил POST-запрос

public static function param ($name = null, $default = null, $type = null)

Возвращает дополнительные параметры запроса к серверу.

Параметры

  • $name

    Идентификатор параметра запроса. Если не указан, метод вернет содержимое всех дополнительных параметров.

  • $default

    Значение по умолчанию — возвращается при указанном значении параметра $name в случае отсутствия значения для параметра с указанным идентификатором.

  • $type

    Тип данных, к которому необходимо привести значение указанного параметра. Допустимые типы данных перечислены в описании метода cookie.

Пример

waRequest::param('locale', 'ru_RU')

Результат

ru_RU

При обработке запросов к фронтенду метод waRequest::param() возвращает значения параметров поселения приложения, к фронтенду которого выполняется запрос.

Пример

waRequest::param('private') //получаем значение параметра "Публичность (скрытое поселение)" в настройках поселения

public static function post ($name = null, $default = null, $type = null)

Возвращает содержимое POST-запроса.

Параметры

  • $name

    Идентификатор элемента запроса. Если не указан, метод вернет содержимое всех элементов запроса.

  • $default

    Значение по умолчанию — возвращается при указанном значении параметра $name в случае отсутствия значения для элемента с указанным идентификатором.

  • $type

    Тип данных, к которому необходимо привести значение указанного элемента. Допустимые типы данных перечислены в описании метода cookie.

Пример

waRequest::post('id')

public static function request ($name = null, $default = null, $type = null)

Возвращает общее содержимое GET- и POST-запросов или значение указанного элемента запроса.

Параметры

  • $name

    Идентификатор элемента запроса. Если не указан, метод вернет содержимое всех элементов запроса.

  • $default

    Значение по умолчанию — возвращается при указанном значении параметра $name в случае отсутствия значения для элемента с указанным идентификатором.

  • $type

    Тип данных, к которому необходимо привести значение указанного элемента. Допустимые типы данных перечислены в описании метода cookie.

Пример

waRequest::request('id')

public static function server ($name = null, $default = null, $type = null)

Возвращает содержимое массива $_SERVER.

Параметры

  • $name

    Идентификатор элемента запроса. Если не указан, метод вернет содержимое всех элементов массива.

  • $default

    Значение по умолчанию — возвращается при указанном значении параметра $name в случае отсутствия значения для элемента с указанным идентификатором.

  • $type

    Тип данных, к которому необходимо привести значение указанного элемента. Допустимые типы данных перечислены в описании метода cookie.

Пример

waRequest::server('HTTP_HOST')

Результат

yourdomain.ru

public static function setParam ($key, $value = null)

Устанавливает значения для дополнительных параметров запроса.

Параметры

  • $key

    Строковоый идентификатор параметра.

  • $value

    Значение параметра. Если не указано, устанавливается значение по умолчанию null.

Пример

waRequest::setParam('locale', 'en_US')