CodeIgniter v3.0.0 API
\

\CI_URI

URI Class

Parses URIs and determines routing

Summary

Methods
Properties
Constants
__construct()
filter_uri()
segment()
rsegment()
uri_to_assoc()
ruri_to_assoc()
assoc_to_uri()
slash_segment()
slash_rsegment()
segment_array()
rsegment_array()
total_segments()
total_rsegments()
uri_string()
ruri_string()
$keyval
$uri_string
$segments
$rsegments
No constants found
_set_uri_string()
_parse_request_uri()
_parse_query_string()
_parse_argv()
_remove_relative_directory()
_uri_to_assoc()
_slash_segment()
$_permitted_uri_chars
N/A
No private methods found
No private properties found
N/A

Properties

$keyval

$keyval : array

List of cached URI segments

Type

array

$uri_string

$uri_string : string

Current URI string

Type

string

$segments

$segments : array

List of URI segments

Starts at 1 instead of 0.

Type

array

$rsegments

$rsegments : array

List of routed URI segments

Starts at 1 instead of 0.

Type

array

$_permitted_uri_chars

$_permitted_uri_chars : string

Permitted URI chars

PCRE character group allowed in URI segments

Type

string

Methods

__construct()

__construct(\CI_Config  $config) : void

Class constructor

Parameters

\CI_Config $config

filter_uri()

filter_uri(string  $str) : void

Filter URI

Filters segments for malicious characters.

Parameters

string $str

segment()

segment(integer  $n, mixed  $no_result = NULL) : mixed

Fetch URI Segment

Parameters

integer $n

Index
mixed $no_result

What to return if the segment index is not found

Returns

mixed

rsegment()

rsegment(integer  $n, mixed  $no_result = NULL) : mixed

Fetch URI "routed" Segment

Returns the re-routed URI segment (assuming routing rules are used) based on the index provided. If there is no routing, will return the same result as CI_URI::segment().

Parameters

integer $n

Index
mixed $no_result

What to return if the segment index is not found

Returns

mixed

uri_to_assoc()

uri_to_assoc(integer  $n = 3, array  $default = array()) : array

URI to assoc

Generates an associative array of URI data starting at the supplied segment index. For example, if this is your URI:

example.com/user/search/name/joe/location/UK/gender/male

You can use this method to generate an array with this prototype:

array ( name => joe location => UK gender => male )

Parameters

integer $n

Index (default: 3)
array $default

Default values

Returns

array

ruri_to_assoc()

ruri_to_assoc(integer  $n = 3, array  $default = array()) : array

Routed URI to assoc

Identical to CI_URI::uri_to_assoc(), only it uses the re-routed segment array.

Parameters

integer $n

Index (default: 3)
array $default

Default values

Returns

array

assoc_to_uri()

assoc_to_uri(array  $array) : string

Assoc to URI

Generates a URI string from an associative array.

Parameters

array $array

Input array of key/value pairs

Returns

string —

URI string

slash_segment()

slash_segment(integer  $n, string  $where = 'trailing') : string

Slash segment

Fetches an URI segment with a slash.

Parameters

integer $n

Index
string $where

Where to add the slash ('trailing' or 'leading')

Returns

string

slash_rsegment()

slash_rsegment(integer  $n, string  $where = 'trailing') : string

Slash routed segment

Fetches an URI routed segment with a slash.

Parameters

integer $n

Index
string $where

Where to add the slash ('trailing' or 'leading')

Returns

string

segment_array()

segment_array() : array

Segment Array

Returns

array —

CI_URI::$segments

rsegment_array()

rsegment_array() : array

Routed Segment Array

Returns

array —

CI_URI::$rsegments

total_segments()

total_segments() : integer

Total number of segments

Returns

integer

total_rsegments()

total_rsegments() : integer

Total number of routed segments

Returns

integer

uri_string()

uri_string() : string

Fetch URI string

Returns

string —

CI_URI::$uri_string

ruri_string()

ruri_string() : string

Fetch Re-routed URI string

Returns

string

_set_uri_string()

_set_uri_string(string  $str, boolean  $is_cli = FALSE) : void

Set URI String

Parameters

string $str

Input URI string
boolean $is_cli

Whether the input comes from CLI

_parse_request_uri()

_parse_request_uri() : string

Parse REQUEST_URI

Will parse REQUEST_URI and automatically detect the URI from it, while fixing the query string if necessary.

Returns

string

_parse_query_string()

_parse_query_string() : string

Parse QUERY_STRING

Will parse QUERY_STRING and automatically detect the URI from it.

Returns

string

_parse_argv()

_parse_argv() : string

Parse CLI arguments

Take each command line argument and assume it is a URI segment.

Returns

string

_remove_relative_directory()

_remove_relative_directory(string  $uri) : string

Remove relative directory (.

./) and multi slashes (///)

Do some final cleaning of the URI and return it, currently only used in self::_parse_request_uri()

Parameters

string $uri

Returns

string

_uri_to_assoc()

_uri_to_assoc(integer  $n = 3, array  $default = array(), string  $which = 'segment') : array

Internal URI-to-assoc

Generates a key/value pair from the URI string or re-routed URI string.

Parameters

integer $n

Index (default: 3)
array $default

Default values
string $which

Array name ('segment' or 'rsegment')

Returns

array

_slash_segment()

_slash_segment(integer  $n, string  $where = 'trailing', string  $which = 'segment') : string

Internal Slash segment

Fetches an URI Segment and adds a slash to it.

Parameters

integer $n

Index
string $where

Where to add the slash ('trailing' or 'leading')
string $which

Array name ('segment' or 'rsegment')

Returns

string