Joostina CMS / CMF v2.* API
  • Docs
  • Package
  • Class
  • Tree
  • Todo
Overview

Packages

  • Components
    • Acls
      • Models
        • Admin
        • Site
    • BlogCategory
      • Models
        • Admin
        • Site
    • Blogs
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • Coder
      • Controllers
        • Admin
      • Models
        • Admin
    • Comments
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • CommentsCounter
      • Models
        • Admin
        • Site
    • Mainpage
      • Controllers
        • Site
    • News
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • Pages
      • Controllers
        • Admin
        • Site
      • Models
        • Site
    • Search
      • Controllers
        • Site
    • Site
      • Controllers
        • Admin
        • Site
    • Sitemap
      • Controllers
        • Admin
        • Site
      • Models
        • Admin
        • Site
    • Test
      • Controllers
        • Site
    • Torrents
      • Controllers
        • Site
    • Users
      • Controllers
        • Admin
        • Site
      • Models
        • Admin
        • Site
  • Compression
  • Core
    • Libraries
      • Arhive
      • Array
      • Attached
      • Autoadmin
      • Autoloader
      • Benchmark
      • Breadcrumbs
      • Cache
      • Config
      • Cookie
      • Csrf
      • Database
        • Drivers
          • Interfaces
      • Datetime
      • Debug
      • Editor
      • Events
      • File
      • Filter
      • Flashmessage
      • Folder
      • Hit
      • Html
      • Image
      • Inflector
      • Inputfilter
      • Libraries
      • Mail
      • Module
      • Nestedset
      • Pager
      • Pages
      • Params
      • Randomizer
      • Request
      • RobotLoader
      • Route
      • Security
      • Session
      • Static
      • String
      • Text
      • Trash
      • Validate
  • Email
  • Extra
    • Libraries
      • Basket
  • Joostina
    • Controller
    • Core
    • Document
  • JSMin
  • Libraries
    • Extra
      • Basket
        • Models
          • Site
  • None
  • Plugins
    • Autoadmin
    • Editor
    • Sitemap
  • SimpleMail
  • Vendors
    • Libraries
      • Email

Classes

  • joosRequest

Class joosRequest

Библиотека работы со входящими пользовательскими данными и информацией

Category: Libraries
Copyright: (C) 2007-2012 Joostina Team
License: License http://www.opensource.org/licenses/mit-license.php Информация об авторах и лицензиях стороннего кода в составе Joostina CMS: docs/copyrights
Author: Joostina Team <info@joostina.ru>
Version: 1.0
Todo: в mosGetParams была очистка данных. Может, стоит и сюда прикрутить? joosInputFilter::instance()->process($return)
Located at: core/libraries/request.php

Methods summary

public static mixed
# param( string $name, string $default = null, array $vars = false )

Получение параметра

Получение параметра

Parameters

$name
string
название параметра
$default
string
значение для параметра по умолчани
$vars
array
массив переменных из которого необходимо получить параметр $name, по умолчанию используется суперглобальный $_REQUEST

Returns

mixed
результат, массив или строка

Todo

проанализировать необходимоть проверки наличия с empty (isset($vars[$name]) && !empty( $vars[$name] ) )
public static mixed
# get( string $name, string $default = null )

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

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

Parameters

$name
string
название параметра $name
$default
string
значение для параметра, используемое по умолчанию

Returns

mixed
результат, массив или строка
public static mixed
# post( string $name, string $default = null )

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

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

Parameters

$name
string
название параметра $name
$default
string
значение для параметра, используемое по умолчанию

Returns

mixed
результат, массив или строка
public static mixed
# request( string $name, string $default = null )

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

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

Parameters

$name
string
название параметра $name
$default
string
значение для параметра, используемое по умолчанию

Returns

mixed
результат, массив или строка
public static mixed
# file( string $name )

Получение параметров загруженного файла из суперглобального массива $_FILES

Получение параметров загруженного файла из суперглобального массива $_FILES

Parameters

$name
string
название параметра $name

Returns

mixed
массив с информацией о файле, либо FALSE в случае отсутствия данных
public static mixed
# server( string $name, string $default = null )

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

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

Parameters

$name
string
название параметра $name
$default
string
значение для параметра, используемое по умолчанию

Returns

mixed
результат, массив или строка
public static mixed
# env( string $name, string $default = null )

Получение параметров из суперглобального массива $_ENV

Получение параметров из суперглобального массива $_ENV

Parameters

$name
string
название параметра $name
$default
string
значение для параметра, используемое по умолчанию

Returns

mixed
результат, массив или строка
public static mixed
# session( string $name, string $default = null )

Получение параметров из суперглобального массива $_SESSION

Получение параметров из суперглобального массива $_SESSION

Parameters

$name
string
название параметра $name
$default
string
значение для параметра, используемое по умолчанию

Returns

mixed
результат, массив или строка
public static mixed
# cookies( string $name, string $default = null )

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

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

Parameters

$name
string
название параметра $name
$default
string
значение для параметра, используемое по умолчанию

Returns

mixed
результат, массив или строка
public static mixed
# header( string $name, string $default = false )

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

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

Parameters

$name
string
название параметра
$default
string
значение для параметра, используемое по умолчанию

Returns

mixed
результат, массив или строка, либо false если параметр не обнаружен ( по умолчанию )
public static mixed
# int( string $name = null, string $default = null, array $vars = null )

Получение параметра с принудительным приведением к цельночисленному (йифровому) варианту

Получение параметра с принудительным приведением к цельночисленному (йифровому) варианту

Parameters

$name
string
название параметра
$default
string
значение для параметра по умолчани
$vars
array
массив переменных из которого необходимо получить параметр $name, по умолчанию используется суперглобальный $_REQUEST

Returns

mixed
результат, массив или строка
public static array
# array_param( string $name = null, array $default = null, array $vars = null )

Получение массива параметров

Получение массива параметров

Parameters

$name
string
название параметра
$default
string
значение для параметра по умолчани
$vars
array
массив переменных из которого необходимо получить параметр $name, по умолчанию используется суперглобальный $_REQUEST

Returns

array
результат, массив или строка
public static string
# protocol( )

Получение протокола активного соединения, http или https в случае защищенного соединения

Получение протокола активного соединения, http или https в случае защищенного соединения

Returns

string
http или https
public static boolean
# is_get( )

Проверка на работу методом GET

Проверка на работу методом GET

Returns

boolean
результат проверки
public static boolean
# is_post( )

Проверка на работу методом POST

Проверка на работу методом POST

Returns

boolean
результат проверки
public static boolean
# is_put( )

Проверка на работу методом PUT

Проверка на работу методом PUT

Returns

boolean
результат проверки
public static boolean
# is_delete( )

Проверка на работу методом DELETE

Проверка на работу методом DELETE

Returns

boolean
результат проверки
public static boolean
# is_ajax( )

Проверка работы через Ajax-соединение

Проверка работы через Ajax-соединение

Returns

boolean
результат проверки
public static boolean
# is_https( )

Проверка работы через через безопасное https соединение

Проверка работы через через безопасное https соединение

Returns

boolean
результат проверки
public static string
# user_ip( )

Получение IP адреса активного пользователя

Получение IP адреса активного пользователя

Returns

string
IP адрес пользователя, либо FALSE в случае если IP адрес не получен
public static
# send_headers( $code_string $code_string )

Отправка HTTP заголовков

Отправка HTTP заголовков

Parameters

$code_string
$code_string
public static
# send_headers_by_code( integer $code_num = 200 )

Установка кода HTTP ответа в заголовок страницы

Установка кода HTTP ответа в заголовок страницы

Parameters

$code_num
integer
номер кода

Tutorial

joosRequest::send_headers_by_code(200);
joosRequest::send_headers_by_code(301);
joosRequest::send_headers_by_code(404);
joosRequest::send_headers_by_code(504);
public static boolean
# is_console( )

Проверка на запуск скрипта через консаоль

Проверка на запуск скрипта через консаоль

Returns

boolean
Joostina CMS / CMF v2.* API API documentation generated by ApiGen 2.6.1 – Template adapted by @olvlv and Joostina Team