Docs for class JString

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

JString

Description

String handling class for utf-8 data Wraps the phputf8 library All functions assume the validity of utf-8 strings.

since: 1.5
author: David Gal <[email protected]>

Located in /joomla/utilities/string.php (line 32)

 JString   (Subpackage Utilities)

Method Summary

static string ltrim (string $str, [string $charlist = FALSE])

static string rtrim (string $str, [string $charlist = FALSE])

static int strcasecmp (string $str1, string $str2)

static int strcspn (string $str, string $mask, [int $start = NULL], [int $length = NULL])

static string stristr (string $str, string $search)

static mixed strpos ($str $str, $search $search, [$offset $offset = FALSE])

static string strrev (string $str)

static mixed strrpos ($str $str, $search $search)

static void strspn (string $str, string $mask, [int $start = NULL], [int $length = NULL])

static void str_ireplace (string $search, string $replace, string $str, [int $count = NULL])

static array str_split (string $str, [int $split_len = 1])

static mixed substr (string $str, integer $offset, [integer $length = FALSE])

static void substr_replace (string $str, string $repl, int $start, [int $length = NULL])

static string transcode (string $source, string $from_encoding, string $to_encoding)

static string trim (string $str, [string $charlist = FALSE])

static string ucfirst (string $str)

static string ucwords (string $str)

int strlen (string $str)

mixed strtolower (string $str)

mixed strtoupper (string $str)

Methods

ltrim (line 314)

UTF-8 aware replacement for ltrim()

Strip whitespace (or other characters) from the beginning of a string Note: you only need to use this if you are supplying the charlist optional arg and it contains UTF-8 characters. Otherwise ltrim will work normally on a UTF-8 string

return: the trimmed string
see: http://www.php.net/ltrim
access: public

string ltrim (string $str, [string $charlist = FALSE])

string $str: the string to be trimmed
string $charlist: the optional charlist of additional characters to trim

rtrim (line 338)

UTF-8 aware replacement for rtrim()

Strip whitespace (or other characters) from the end of a string Note: you only need to use this if you are supplying the charlist optional arg and it contains UTF-8 characters. Otherwise rtrim will work normally on a UTF-8 string

return: the trimmed string
see: http://www.php.net/rtrim
access: public

string rtrim (string $str, [string $charlist = FALSE])

string $str: the string to be trimmed
string $charlist: the optional charlist of additional characters to trim

strcasecmp (line 188)

UTF-8 aware alternative to strcasecmp A case insensivite string comparison

return: < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.
see: http://www.php.net/strcasecmp
access: public

int strcasecmp (string $str1, string $str2)

string $str1: string 1 to compare
string $str2: string 2 to compare

strcspn (line 207)

UTF-8 aware alternative to strcspn Find length of initial segment not matching mask

return: the length of the initial segment of str1 which does not contain any of the characters in str2
see: http://www.php.net/strcspn
access: public

int strcspn (string $str, string $mask, [int $start = NULL], [int $length = NULL])

string $str
string $mask: the mask
int $start: Optional starting character position (in characters)
int $length: Optional length

stristr (line 232)

UTF-8 aware alternative to stristr Returns all of haystack from the first occurrence of needle to the end.

needle and haystack are examined in a case-insensitive manner Find first occurrence of a string using case insensitive comparison

return: the sub string
see: http://www.php.net/stristr
access: public

string stristr (string $str, string $search)

string $str: the haystack
string $search: the needle

strlen (line 134)

UTF-8 aware alternative to strlen Returns the number of characters in the string (NOT THE NUMBER OF BYTES),

return: number of UTF-8 characters in string
see: http://www.php.net/strlen
access: public

int strlen (string $str)

string $str: UTF-8 string

strpos (line 46)

UTF-8 aware alternative to strpos Find position of first occurrence of a string

return: Number of characters before the first match or FALSE on failure
see: http://www.php.net/strpos
access: public

mixed strpos ($str $str, $search $search, [$offset $offset = FALSE])

$str $str: - string String being examined
$search $search: - string String being searced for
$offset $offset: - int Optional, specifies the position from which the search should be performed

strrev (line 248)

UTF-8 aware alternative to strrev Reverse a string

return: The string in reverse character order
see: http://www.php.net/strrev
access: public

string strrev (string $str)

string $str: String to be reversed

strrpos (line 66)

UTF-8 aware alternative to strrpos Finds position of last occurrence of a string

return: Number of characters before the last match or FALSE on failure
see: http://www.php.net/strrpos
access: public

mixed strrpos ($str $str, $search $search)

$str $str: - string String being examined
$search $search: - string String being searced for

strspn (line 266)

UTF-8 aware alternative to strspn Find length of initial segment matching mask

see: http://www.php.net/strspn
access: public

void strspn (string $str, string $mask, [int $start = NULL], [int $length = NULL])

string $str: the haystack
string $mask: the mask
int $start: start optional
int $length: length optional

strtolower (line 104)

UTF-8 aware alternative to strtlower

Make a string lowercase Note: The concept of a characters "case" only exists is some alphabets such as Latin, Greek, Cyrillic, Armenian and archaic Georgian - it does not exist in the Chinese alphabet, for example. See Unicode Standard Annex #21: Case Mappings

return: either string in lowercase or FALSE is UTF-8 invalid
see: http://www.php.net/strtolower
access: public

mixed strtolower (string $str)

string $str

strtoupper (line 121)

UTF-8 aware alternative to strtoupper

Make a string uppercase Note: The concept of a characters "case" only exists is some alphabets such as Latin, Greek, Cyrillic, Armenian and archaic Georgian - it does not exist in the Chinese alphabet, for example. See Unicode Standard Annex #21: Case Mappings

return: either string in uppercase or FALSE is UTF-8 invalid
see: http://www.php.net/strtoupper
access: public

mixed strtoupper (string $str)

string $str

str_ireplace (line 150)

UTF-8 aware alternative to str_ireplace Case-insensitive version of str_replace

see: http://www.php.net/str_ireplace
access: public

void str_ireplace (string $search, string $replace, string $str, [int $count = NULL])

string $search: string to search
string $replace: existing string to replace
string $str: new string to replace with
int $count: optional count value to be passed by referene

str_split (line 171)

UTF-8 aware alternative to str_split Convert a string to an array

see: http://www.php.net/str_split
access: public

array str_split (string $str, [int $split_len = 1])

string $str: UTF-8 encoded
int $split_len: number to characters to split string by

substr (line 82)

UTF-8 aware alternative to substr Return part of a string given character offset (and optionally length)

return: string or FALSE if failure
see: http://www.php.net/substr
access: public

mixed substr (string $str, integer $offset, [integer $length = FALSE])

string $str
integer $offset: number of UTF-8 characters offset (from left)
integer $length: (optional) length in UTF-8 characters from offset

substr_replace (line 290)

UTF-8 aware substr_replace Replace text within a portion of a string

see: http://www.php.net/substr_replace
access: public

void substr_replace (string $str, string $repl, int $start, [int $length = NULL])

string $str: the haystack
string $repl: the replacement string
int $start: start
int $length: length (optional)

transcode (line 414)

Transcode a string.

return: Transcoded string
since: 1.5

string transcode (string $source, string $from_encoding, string $to_encoding)

string $source: The string to transcode.
string $from_encoding: The source encoding.
string $to_encoding: The target encoding.

trim (line 362)

UTF-8 aware replacement for trim()

Strip whitespace (or other characters) from the beginning and end of a string Note: you only need to use this if you are supplying the charlist optional arg and it contains UTF-8 characters. Otherwise trim will work normally on a UTF-8 string

return: the trimmed string
see: http://www.php.net/trim
access: public

string trim (string $str, [string $charlist = FALSE])

string $str: the string to be trimmed
string $charlist: the optional charlist of additional characters to trim

ucfirst (line 382)

UTF-8 aware alternative to ucfirst Make a string's first character uppercase

return: with first character as upper case (if applicable)
see: http://www.php.net/ucfirst
access: public

string ucfirst (string $str)

string $str

ucwords (line 398)

UTF-8 aware alternative to ucwords Uppercase the first character of each word in a string

return: with first char of each word uppercase
see: http://www.php.net/ucwords
access: public

string ucwords (string $str)

string $str

Documentation generated on Mon, 05 Mar 2007 21:27:04 +0000 by phpDocumentor 1.3.1

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Other documents

Developer Network License

JString