Joomla CMS
3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
|
Fonctions membres publiques | |
__construct ($options=false) | |
set_parameter ($option, $value=false) | |
decode ($input, $one_time_encoding=false) | |
encode ($decoded, $one_time_encoding=false) | |
encode_uri ($uri) | |
get_last_error () | |
getInstance ($params=array()) | |
singleton ($params=array()) | |
idna_convert ($options=false) | |
set_parameter ($option, $value=false) | |
decode ($input, $one_time_encoding=false) | |
encode ($decoded, $one_time_encoding=false) | |
get_last_error () | |
_decode ($encoded) | |
_encode ($decoded) | |
_adapt ($delta, $npoints, $is_first) | |
_encode_digit ($d) | |
_decode_digit ($cp) | |
_error ($error='') | |
_nameprep ($input) | |
_hangul_decompose ($char) | |
_hangul_compose ($input) | |
_get_combining_class ($char) | |
_apply_cannonical_ordering ($input) | |
_combine ($input) | |
_utf8_to_ucs4 ($input) | |
_ucs4_to_utf8 ($input) | |
_ucs4_to_ucs4_string ($input) | |
_ucs4_string_to_ucs4 ($input) | |
Champs de données | |
$NP = array() | |
Fonctions membres protégées | |
_decode ($encoded) | |
_encode ($decoded) | |
_adapt ($delta, $npoints, $is_first) | |
_encode_digit ($d) | |
_decode_digit ($cp) | |
_error ($error='') | |
_nameprep ($input) | |
_hangul_decompose ($char) | |
_hangul_compose ($input) | |
_get_combining_class ($char) | |
_apply_cannonical_ordering ($input) | |
_combine ($input) | |
_utf8_to_ucs4 ($input) | |
_ucs4_to_utf8 ($input) | |
_ucs4_to_ucs4_string ($input) | |
_ucs4_string_to_ucs4 ($input) | |
Fonctions membres protégées statiques | |
static | byteLength ($string) |
Attributs protégés | |
$_punycode_prefix = 'xn--' | |
$_invalid_ucs = 0x80000000 | |
$_max_ucs = 0x10FFFF | |
$_base = 36 | |
$_tmin = 1 | |
$_tmax = 26 | |
$_skew = 38 | |
$_damp = 700 | |
$_initial_bias = 72 | |
$_initial_n = 0x80 | |
$_sbase = 0xAC00 | |
$_lbase = 0x1100 | |
$_vbase = 0x1161 | |
$_tbase = 0x11A7 | |
$_lcount = 19 | |
$_vcount = 21 | |
$_tcount = 28 | |
$_ncount = 588 | |
$_scount = 11172 | |
$_error = false | |
$_api_encoding = 'utf8' | |
$_allow_overlong = false | |
$_strict_mode = false | |
$_idn_version = 2003 | |
Attributs protégés statiques | |
static | $_mb_string_overload = null |
static | $NP |
Encode/decode Internationalized Domain Names.
The class allows to convert internationalized domain names (see RFC 3490 for details) as they can be used with various registries worldwide to be translated between their original (localized) form and their encoded form as it will be used in the DNS (Domain Name System).
The class provides two public methods, encode() and decode(), which do exactly what you would expect them to do. You are allowed to use complete domain names, simple strings and complete email addresses as well. That means, that you might use any of the following notations:
Unicode input might be given as either UTF-8 string, UCS-4 string or UCS-4 array. Unicode output is available in the same formats. You can select your preferred format via set_paramter().
ACE input and output is always expected to be ASCII.
Encode/decode Internationalized Domain Names.
The class allows to convert internationalized domain names (see RFC 3490 for details) as they can be used with various registries worldwide to be translated between their original (localized) form and their encoded form as it will be used in the DNS (Domain Name System).
The class provides two public methods, encode() and decode(), which do exactly what you would expect them to do. You are allowed to use complete domain names, simple strings and complete email addresses as well. That means, that you might use any of the following notations:
Unicode input might be given as either UTF-8 string, UCS-4 string or UCS-4 array. Unicode output is available in the same formats. You can select your preferred format via set_paramter().
ACE input and output is always expected to be ASCII.
__construct | ( | $options = false | ) |
the constructor
array | $options |
Références $_tcount, $options, null, et set_parameter().
_adapt | ( | $delta, | |
$npoints, | |||
$is_first | |||
) |
|
protected |
_apply_cannonical_ordering | ( | $input | ) |
Apllies the cannonical ordering of a decomposed UCS4 sequence
array | Decomposed UCS4 sequence |
Références $i, $input, et _get_combining_class().
|
protected |
Applies the cannonical ordering of a decomposed UCS4 sequence
array | Decomposed UCS4 sequence |
Références $i, $input, et _get_combining_class().
Référencé par _nameprep().
_combine | ( | $input | ) |
Do composition of a sequence of starter and non-starter
array | UCS4 Decomposed sequence |
Références $input.
|
protected |
Do composition of a sequence of starter and non-starter
array | UCS4 Decomposed sequence |
Références $input.
Référencé par _nameprep().
_decode | ( | $encoded | ) |
The actual decoding algorithm private
Références $_base, $_initial_bias, $_initial_n, $i, _adapt(), _decode_digit(), _error(), et _ucs4_to_utf8().
|
protected |
The actual decoding algorithm
string |
Références $_base, $_initial_bias, $_initial_n, $i, _adapt(), _decode_digit(), _error(), et _ucs4_to_utf8().
Référencé par decode().
_decode_digit | ( | $cp | ) |
Decode a certain digit private
Références $_base.
|
protected |
_encode | ( | $decoded | ) |
The actual encoding algorithm private
Références $_base, $_initial_bias, $_initial_n, $i, _adapt(), _encode_digit(), _error(), _nameprep(), _utf8_to_ucs4(), et elseif.
|
protected |
The actual encoding algorithm
string |
Références $_base, $_initial_bias, $_initial_n, $i, _adapt(), _encode_digit(), _error(), _nameprep(), _utf8_to_ucs4(), et elseif.
Référencé par encode().
_encode_digit | ( | $d | ) |
Encoding a certain digit private
|
protected |
_error | ( | $error = '' | ) |
Internal error handling method private
Références _error().
|
protected |
Internal error handling method
string | $error |
Référencé par _decode(), _encode(), _error(), _nameprep(), _ucs4_string_to_ucs4(), _ucs4_to_utf8(), _utf8_to_ucs4(), decode(), encode(), encode_uri(), et set_parameter().
_get_combining_class | ( | $char | ) |
Returns the combining class of a certain wide char
integer | Wide char to check (32bit integer) |
|
protected |
Returns the combining class of a certain wide char
integer | Wide char to check (32bit integer) |
Référencé par _apply_cannonical_ordering(), et _nameprep().
_hangul_compose | ( | $input | ) |
|
protected |
Ccomposes a Hangul syllable (see http://www.unicode.org/unicode/reports/tr15/#Hangul
array | Decomposed UCS4 sequence |
Références $_lbase, $_sbase, $_tbase, $_tcount, $_vbase, $i, et $input.
Référencé par _nameprep().
_hangul_decompose | ( | $char | ) |
Decomposes a Hangul syllable (see http://www.unicode.org/unicode/reports/tr15/#Hangul
integer | 32bit UCS4 code point |
Références $_tcount.
|
protected |
Decomposes a Hangul syllable (see http://www.unicode.org/unicode/reports/tr15/#Hangul
integer | 32bit UCS4 code point |
Références $_tcount.
Référencé par _nameprep().
_nameprep | ( | $input | ) |
Do Nameprep according to RFC3491 and RFC3454
array | Unicode Characters |
Références $class, $i, $input, $output, $range, _apply_cannonical_ordering(), _combine(), _error(), _get_combining_class(), _hangul_compose(), _hangul_decompose(), et elseif.
|
protected |
Do Nameprep according to RFC3491 and RFC3454
array | Unicode Characters |
Références $class, $i, $input, $output, $range, _apply_cannonical_ordering(), _combine(), _error(), _get_combining_class(), _hangul_compose(), _hangul_decompose(), et elseif.
Référencé par _encode().
_ucs4_string_to_ucs4 | ( | $input | ) |
|
protected |
_ucs4_to_ucs4_string | ( | $input | ) |
|
protected |
_ucs4_to_utf8 | ( | $input | ) |
Convert UCS-4 string into UTF-8 string See _utf8_to_ucs4() for details private
|
protected |
_utf8_to_ucs4 | ( | $input | ) |
This converts an UTF-8 encoded string to its UCS-4 representation By talking about UCS-4 "strings" we mean arrays of 32bit integers representing each of the "chars". This is due to PHP not being able to handle strings with bit depth different from 8. This apllies to the reverse method _ucs4_to_utf8(), too. The following UTF-8 encodings are supported: bytes bits representation 1 7 0xxxxxxx 2 11 110xxxxx 10xxxxxx 3 16 1110xxxx 10xxxxxx 10xxxxxx 4 21 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx 5 26 111110xx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx 6 31 1111110x 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx Each x represents a bit that can be used to store character data. The five and six byte sequences are part of Annex D of ISO/IEC 10646-1:2000 private
|
protected |
This converts an UTF-8 encoded string to its UCS-4 representation By talking about UCS-4 "strings" we mean arrays of 32bit integers representing each of the "chars". This is due to PHP not being able to handle strings with bit depth different from 8. This apllies to the reverse method _ucs4_to_utf8(), too. The following UTF-8 encodings are supported: bytes bits representation 1 7 0xxxxxxx 2 11 110xxxxx 10xxxxxx 3 16 1110xxxx 10xxxxxx 10xxxxxx 4 21 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx 5 26 111110xx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx 6 31 1111110x 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx Each x represents a bit that can be used to store character data. The five and six byte sequences are part of Annex D of ISO/IEC 10646-1:2000
string | $input |
|
staticprotected |
Gets the length of a string in bytes even if mbstring function overloading is turned on
string | $string | the string for which to get the length. |
decode | ( | $input, | |
$one_time_encoding = false |
|||
) |
Decode a given ACE domain name
string | Domain name (ACE string) [ |
string | Desired output encoding, see set_parameter] |
Références $input, $return, _decode(), _error(), _ucs4_to_ucs4_string(), _utf8_to_ucs4(), et elseif.
decode | ( | $input, | |
$one_time_encoding = false |
|||
) |
Decode a given ACE domain name
string | Domain name (ACE string) [ |
string | Desired output encoding, see set_parameter] |
Références $input, $return, _decode(), _error(), _ucs4_to_ucs4_string(), _utf8_to_ucs4(), et elseif.
encode | ( | $decoded, | |
$one_time_encoding = false |
|||
) |
Encode a given UTF-8 domain name
string | Domain name (UTF-8 or UCS-4) [ |
string | Desired input encoding, see set_parameter] |
Références $output, _encode(), _error(), _ucs4_string_to_ucs4(), _ucs4_to_utf8(), et _utf8_to_ucs4().
encode | ( | $decoded, | |
$one_time_encoding = false |
|||
) |
Encode a given UTF-8 domain name
string | Domain name (UTF-8 or UCS-4) [ |
string | Desired input encoding, see set_parameter] |
Références $output, _encode(), _error(), _ucs4_string_to_ucs4(), _ucs4_to_utf8(), et _utf8_to_ucs4().
Référencé par encode_uri().
encode_uri | ( | $uri | ) |
Removes a weakness of encode(), which cannot properly handle URIs but instead encodes their path or query components, too.
string | $uri | Expects the URI as a UTF-8 (or ASCII) string |
get_last_error | ( | ) |
Use this method to get the last error ocurred
void |
Références $_error.
get_last_error | ( | ) |
Use this method to get the last error ocurred
void |
Références $_error.
getInstance | ( | $params = array() | ) |
Attempts to return a concrete IDNA instance.
array | $params | Set of paramaters |
Références $params, et idna_convert().
Référencé par singleton().
idna_convert | ( | $options = false | ) |
Références $_tcount, $options, et set_parameter().
Référencé par getInstance().
set_parameter | ( | $option, | |
$value = false |
|||
) |
Sets a new option value. Available options and values: [encoding - Use either UTF-8, UCS4 as array or UCS4 as string as input ('utf8' for UTF-8, 'ucs4_string' and 'ucs4_array' respectively for UCS4); The output is always UTF-8] [overlong - Unicode does not allow unnecessarily long encodings of chars, to allow this, set this parameter to true, else to false; default is false.] [strict - true: strict mode, good for registration purposes - Causes errors on failures; false: loose mode, ideal for "wildlife" applications by silently ignoring errors and returning the original input instead
mixed | Parameter to set (string: single parameter; array of Parameter => Value pairs) |
string | Value to use (if parameter 1 is a string) |
set_parameter | ( | $option, | |
$value = false |
|||
) |
Sets a new option value. Available options and values: [encoding - Use either UTF-8, UCS4 as array or UCS4 as string as input ('utf8' for UTF-8, 'ucs4_string' and 'ucs4_array' respectively for UCS4); The output is always UTF-8] [overlong - Unicode does not allow unnecessarily long encodings of chars, to allow this, set this parameter to true, else to false; default is false.] [strict - true: strict mode, good for registration purposes - Causes errors on failures; false: loose mode, ideal for "wildlife" applications by silently ignoring errors and returning the original input instead
mixed | Parameter to set (string: single parameter; array of Parameter => Value pairs) |
string | Value to use (if parameter 1 is a string) |
Références $option, $value, et _error().
Référencé par __construct(), et idna_convert().
singleton | ( | $params = array() | ) |
Attempts to return a concrete IDNA instance for either php4 or php5, only creating a new instance if no IDNA instance with the same parameters currently exists.
array | $params | Set of paramaters |
Références $params, et getInstance().
|
protected |
|
protected |
|
protected |
Référencé par _adapt(), _decode(), _decode_digit(), et _encode().
|
protected |
Référencé par get_last_error().
|
protected |
|
protected |
|
protected |
Référencé par _hangul_compose().
|
protected |
|
protected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
Référencé par _hangul_compose().
|
protected |
|
protected |
|
protected |
|
protected |
Référencé par _hangul_compose().
|
protected |
Référencé par __construct(), _hangul_compose(), _hangul_decompose(), et idna_convert().
|
protected |
|
protected |
Référencé par _adapt().
|
protected |
Référencé par _hangul_compose().
|
protected |
$NP = array() |
|
staticprotected |
Holds all relevant mapping tables See RFC3454 for details
array