CodeIgniter v3.0.0 API
\

\CI_Input

Input Class

Pre-processes global input data for security

Summary

Methods
Properties
Constants
__construct()
get()
post()
post_get()
get_post()
cookie()
server()
input_stream()
set_cookie()
ip_address()
valid_ip()
user_agent()
request_headers()
get_request_header()
is_ajax_request()
method()
__get()
No public properties found
No constants found
_fetch_from_array()
$ip_address
$headers
$_raw_input_stream
$_input_stream
$security
N/A
No private methods found
No private properties found
N/A

Properties

$ip_address

$ip_address : string

IP address of the current user

Type

string

$headers

$headers : array

List of all HTTP request headers

Type

array

$_raw_input_stream

$_raw_input_stream : string

Raw input stream data

Holds a cache of php://input contents

Type

string

$_input_stream

$_input_stream : array

Parsed input stream data

Parsed from php://input at runtime

Type

array

$security

$security : \CI_Security

CI_Security instance

Used for the optional $xss_filter parameter that most getter methods have here.

Type

\CI_Security

Methods

__construct()

__construct(\CI_Security  $security) : void

Class constructor

Determines whether to globally enable the XSS processing and whether to allow the $_GET array.

Parameters

\CI_Security $security

get()

get(mixed  $index = NULL, boolean  $xss_clean = FALSE) : mixed

Fetch an item from the GET array

Parameters

mixed $index

Index for item to be fetched from $_GET
boolean $xss_clean

Whether to apply XSS filtering

Returns

mixed

post()

post(mixed  $index = NULL, boolean  $xss_clean = FALSE) : mixed

Fetch an item from the POST array

Parameters

mixed $index

Index for item to be fetched from $_POST
boolean $xss_clean

Whether to apply XSS filtering

Returns

mixed

post_get()

post_get(string  $index, boolean  $xss_clean = FALSE) : mixed

Fetch an item from POST data with fallback to GET

Parameters

string $index

Index for item to be fetched from $_POST or $_GET
boolean $xss_clean

Whether to apply XSS filtering

Returns

mixed

get_post()

get_post(string  $index, boolean  $xss_clean = FALSE) : mixed

Fetch an item from GET data with fallback to POST

Parameters

string $index

Index for item to be fetched from $_GET or $_POST
boolean $xss_clean

Whether to apply XSS filtering

Returns

mixed

cookie()

cookie(mixed  $index = NULL, boolean  $xss_clean = FALSE) : mixed

Fetch an item from the COOKIE array

Parameters

mixed $index

Index for item to be fetched from $_COOKIE
boolean $xss_clean

Whether to apply XSS filtering

Returns

mixed

server()

server(mixed  $index, boolean  $xss_clean = FALSE) : mixed

Fetch an item from the SERVER array

Parameters

mixed $index

Index for item to be fetched from $_SERVER
boolean $xss_clean

Whether to apply XSS filtering

Returns

mixed

input_stream()

input_stream(string  $index = NULL, boolean  $xss_clean = FALSE) : mixed

Fetch an item from the php://input stream

Useful when you need to access PUT, DELETE or PATCH request data.

Parameters

string $index

Index for item to be fetched
boolean $xss_clean

Whether to apply XSS filtering

Returns

mixed

set_cookie()

set_cookie(string|array<mixed,mixed>  $name, string  $value = '', integer  $expire, string  $domain = '', string  $path = '/', string  $prefix = '', boolean  $secure = NULL, boolean  $httponly = NULL) : void

Set cookie

Accepts an arbitrary number of parameters (up to 7) or an associative array in the first parameter containing all the values.

Parameters

string|array<mixed,mixed> $name

Cookie name or an array containing parameters
string $value

Cookie value
integer $expire

Cookie expiration time in seconds
string $domain

Cookie domain (e.g.: '.yourdomain.com')
string $path

Cookie path (default: '/')
string $prefix

Cookie name prefix
boolean $secure

Whether to only transfer cookies via SSL
boolean $httponly

Whether to only makes the cookie accessible via HTTP (no javascript)

ip_address()

ip_address() : string

Fetch the IP Address

Determines and validates the visitor's IP address.

Returns

string —

IP address

valid_ip()

valid_ip(string  $ip, string  $which = '') : boolean

Validate IP Address

Parameters

string $ip

IP address
string $which

IP protocol: 'ipv4' or 'ipv6'

Returns

boolean

user_agent()

user_agent(  $xss_clean = FALSE) : string|null

Fetch User Agent string

Parameters

$xss_clean

Returns

string|null —

User Agent string or NULL if it doesn't exist

request_headers()

request_headers(boolean  $xss_clean = FALSE) : array

Request Headers

Parameters

boolean $xss_clean

Whether to apply XSS filtering

Returns

array

get_request_header()

get_request_header(string  $index, boolean  $xss_clean = FALSE) : string|null

Get Request Header

Returns the value of a single member of the headers class member

Parameters

string $index

Header name
boolean $xss_clean

Whether to apply XSS filtering

Returns

string|null —

The requested header on success or NULL on failure

is_ajax_request()

is_ajax_request() : boolean

Is AJAX request?

Test to see if a request contains the HTTP_X_REQUESTED_WITH header.

Returns

boolean

method()

method(boolean  $upper = FALSE) : string

Get Request Method

Return the request method

Parameters

boolean $upper

Whether to return in upper or lower case (default: FALSE)

Returns

string

__get()

__get(string  $name) : mixed

Magic __get()

Allows read access to protected properties

Parameters

string $name

Returns

mixed

_fetch_from_array()

_fetch_from_array(  $array, mixed  $index = NULL, boolean  $xss_clean = FALSE) : mixed

Fetch from array

Internal method used to retrieve values from global arrays.

Parameters

$array
mixed $index

Index for item to be fetched from $array
boolean $xss_clean

Whether to apply XSS filtering

Returns

mixed