PHP Класс CI_URI, TastyIgniter

Parses URIs and determines routing
Автор: EllisLab Dev Team
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$keyval array List of cached URI segments
$rsegments array Starts at 1 instead of 0.
$segments array Starts at 1 instead of 0.
$uri_string string Current URI string

Защищенные свойства (Protected)

Свойство Тип Описание
$_permitted_uri_chars string PCRE character group allowed in URI segments

Открытые методы

Метод Описание
__construct ( ) : void Class constructor
assoc_to_uri ( array $array ) : string Assoc to URI
filter_uri ( string &$str ) : void Filter URI
rsegment ( integer $n, mixed $no_result = NULL ) : mixed Fetch URI "routed" Segment
rsegment_array ( ) : array Routed Segment Array
ruri_string ( ) : string Fetch Re-routed URI string
ruri_to_assoc ( integer $n = 3, array $default = [] ) : array Routed URI to assoc
segment ( integer $n, mixed $no_result = NULL ) : mixed Fetch URI Segment
segment_array ( ) : array Segment Array
slash_rsegment ( integer $n, string $where = 'trailing' ) : string Slash routed segment
slash_segment ( integer $n, string $where = 'trailing' ) : string Slash segment
total_rsegments ( ) : integer Total number of routed segments
total_segments ( ) : integer Total number of segments
uri_string ( ) : string Fetch URI string
uri_to_assoc ( integer $n = 3, array $default = [] ) : array URI to assoc

Защищенные методы

Метод Описание
_parse_argv ( ) : string Parse CLI arguments
_parse_query_string ( ) : string Parse QUERY_STRING
_parse_request_uri ( ) : string Parse REQUEST_URI
_remove_relative_directory ( string $uri ) : string Remove relative directory (.
_set_uri_string ( string $str ) : void Set URI String
_slash_segment ( integer $n, string $where = 'trailing', string $which = 'segment' ) : string Internal Slash segment
_uri_to_assoc ( integer $n = 3, array $default = [], string $which = 'segment' ) : array Internal URI-to-assoc

Описание методов

__construct() публичный Метод

Class constructor
public __construct ( ) : void
Результат void

_parse_argv() защищенный Метод

Take each command line argument and assume it is a URI segment.
protected _parse_argv ( ) : string
Результат string

_parse_query_string() защищенный Метод

Will parse QUERY_STRING and automatically detect the URI from it.
protected _parse_query_string ( ) : string
Результат string

_parse_request_uri() защищенный Метод

Will parse REQUEST_URI and automatically detect the URI from it, while fixing the query string if necessary.
protected _parse_request_uri ( ) : string
Результат 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()
protected _remove_relative_directory ( string $uri ) : string
$uri string
Результат string

_set_uri_string() защищенный Метод

Set URI String
protected _set_uri_string ( string $str ) : void
$str string
Результат void

_slash_segment() защищенный Метод

Fetches an URI Segment and adds a slash to it.
protected _slash_segment ( integer $n, string $where = 'trailing', string $which = 'segment' ) : string
$n integer Index
$where string Where to add the slash ('trailing' or 'leading')
$which string Array name ('segment' or 'rsegment')
Результат string

_uri_to_assoc() защищенный Метод

Generates a key/value pair from the URI string or re-routed URI string.
protected _uri_to_assoc ( integer $n = 3, array $default = [], string $which = 'segment' ) : array
$n integer Index (default: 3)
$default array Default values
$which string Array name ('segment' or 'rsegment')
Результат array

assoc_to_uri() публичный Метод

Generates a URI string from an associative array.
public assoc_to_uri ( array $array ) : string
$array array Input array of key/value pairs
Результат string URI string

filter_uri() публичный Метод

Filters segments for malicious characters.
public filter_uri ( string &$str ) : void
$str string
Результат void

rsegment() публичный Метод

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().
См. также: CI_URI::$rsegments
См. также: CI_URI::segment()
public rsegment ( integer $n, mixed $no_result = NULL ) : mixed
$n integer Index
$no_result mixed What to return if the segment index is not found
Результат mixed

rsegment_array() публичный Метод

Routed Segment Array
public rsegment_array ( ) : array
Результат array CI_URI::$rsegments

ruri_string() публичный Метод

Fetch Re-routed URI string
public ruri_string ( ) : string
Результат string

ruri_to_assoc() публичный Метод

Identical to CI_URI::uri_to_assoc(), only it uses the re-routed segment array.
См. также: CI_URI::uri_to_assoc()
public ruri_to_assoc ( integer $n = 3, array $default = [] ) : array
$n integer Index (default: 3)
$default array Default values
Результат array

segment() публичный Метод

Fetch URI Segment
См. также: CI_URI::$segments
public segment ( integer $n, mixed $no_result = NULL ) : mixed
$n integer Index
$no_result mixed What to return if the segment index is not found
Результат mixed

segment_array() публичный Метод

Segment Array
public segment_array ( ) : array
Результат array CI_URI::$segments

slash_rsegment() публичный Метод

Fetches an URI routed segment with a slash.
public slash_rsegment ( integer $n, string $where = 'trailing' ) : string
$n integer Index
$where string Where to add the slash ('trailing' or 'leading')
Результат string

slash_segment() публичный Метод

Fetches an URI segment with a slash.
public slash_segment ( integer $n, string $where = 'trailing' ) : string
$n integer Index
$where string Where to add the slash ('trailing' or 'leading')
Результат string

total_rsegments() публичный Метод

Total number of routed segments
public total_rsegments ( ) : integer
Результат integer

total_segments() публичный Метод

Total number of segments
public total_segments ( ) : integer
Результат integer

uri_string() публичный Метод

Fetch URI string
public uri_string ( ) : string
Результат string CI_URI::$uri_string

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 )
public uri_to_assoc ( integer $n = 3, array $default = [] ) : array
$n integer Index (default: 3)
$default array Default values
Результат array

Описание свойств

$_permitted_uri_chars защищенное свойство

PCRE character group allowed in URI segments
protected string $_permitted_uri_chars
Результат string

$keyval публичное свойство

List of cached URI segments
public array $keyval
Результат array

$rsegments публичное свойство

Starts at 1 instead of 0.
public array $rsegments
Результат array

$segments публичное свойство

Starts at 1 instead of 0.
public array $segments
Результат array

$uri_string публичное свойство

Current URI string
public string $uri_string
Результат string