Docs For Class atkString

static array	$s_acceptedCharsets	Accepted charsets for htmlentities and html_entity_decode
static boolean	$s_hasMultiByteSupport	Do we have multibyte support

[ Top ]

Method Summary

static string	charAt()	Return char on given position
static boolean	hasMultiByteSupport()	Check if the system has multibyte support
static String	htmlentities()	ATK version of the PHP htmlentities function. Works just like PHP's htmlentities function, but falls back to atkGetCharset() instead of PHP's default charset, if no charset is given.
static String	html_entity_decode()	ATK version of the PHP html_entity_decode function. Works just like PHP's html_entity_decode function, but falls back to the in the language file configured charset instead of PHP's default charset, if no charset is given.
static String	iconv()	ATK version of the PHP html_entity_decode function. Works just like PHP's html_entity_decode function, but falls back to atkGetCharset() instead of PHP's default charset, if no charset is given.
static int	strlen()	Get string length
static int\|boolean	strpos()	Find position of first occurrence of string in a string
static string	strtolower()	Make a string lowercase
static string	strtoupper()	Make a string uppercase
static string	substr()	Get part of string
static string	truncate()	ATK version of the Smarty truncate function, multibyte safe.

[ Top ]

Properties

static array $s_acceptedCharsets = array('iso-8859-1', 'iso-8859-15', 'utf-8', 'cp866', 'ibm866', '866',
'cp1251', 'windows-1251', 'win-1251', '1251', 'cp1252', 'windows-1252', '1252',
'koi8-r', 'koi8-ru', 'koi8r', 'big5', '950', 'gb2312', '936', 'big5-hkscs',
'shift_jis', 'sjis', '932', 'euc-jp', 'eucjp') [line 32]

Accepted charsets for htmlentities and html_entity_decode

[ Top ]

static boolean $s_hasMultiByteSupport = null [line 26]

Do we have multibyte support

[ Top ]

Methods

static method charAt [line 107]

static string charAt(
string
$str, int
$pos 
)

Return char on given position

Parameters:

string	$str:	The string being checked
int	$pos:	The position of the char

API Tags:

Access:

public

[ Top ]

static method hasMultiByteSupport [line 42]

static boolean hasMultiByteSupport(
)

Check if the system has multibyte support

API Tags:

Access:

protected

[ Top ]

static method htmlentities [line 201]

static String htmlentities(
String
$str, [int
$quote_style = ENT_COMPAT], [String
$charset = null] 
)

ATK version of the PHP htmlentities function. Works just like PHP's htmlentities function, but falls back to atkGetCharset() instead of PHP's default charset, if no charset is given.

Parameters:

String	$str:	string to convert
int	$quote_style:	quote style (defaults to ENT_COMPAT)
String	$charset:	character set to use (default to atkGetCharset())

API Tags:

Return:	encoded string
Access:	public

[ Top ]

static method html_entity_decode [line 180]

static String html_entity_decode(
String
$str, [int
$quote_style = ENT_COMPAT], [String
$charset = null] 
)

ATK version of the PHP html_entity_decode function. Works just like PHP's html_entity_decode function, but falls back to the in the language file configured charset instead of PHP's default charset, if no charset is given.

Parameters:

String	$str:	string to convert
int	$quote_style:	quote style (defaults to ENT_COMPAT)
String	$charset:	character set to use (default to atktext('charset', 'atk'))

API Tags:

Return:	encoded string
Access:	public

[ Top ]

static method iconv [line 221]

static String iconv(
string
$in_charset, string
$out_charset, string
$str 
)

ATK version of the PHP html_entity_decode function. Works just like PHP's html_entity_decode function, but falls back to atkGetCharset() instead of PHP's default charset, if no charset is given.

Parameters:

string	$in_charset:	The input charset
string	$out_charset:	The output charset
string	$str:	The string to convert

API Tags:

Return:	encoded string
Access:	public

[ Top ]

static method strlen [line 64]

static int strlen(
string
$str 
)

Get string length

Parameters:

string

$str:

The string being checked for length

API Tags:

Access:

public

[ Top ]

static method strpos [line 119]

static int|boolean strpos(
object
$haystack, object
$needle, [
$offset = 0], object
$offset[optional] 
)

Find position of first occurrence of string in a string

Parameters:

object	$haystack:	The string being checked.
object	$needle:	The position counted from the beginning of haystack .
object	$offset[optional]:	The search offset. If it is not specified, 0 is used.
	$offset:

API Tags:

Access:

public

[ Top ]

static method strtolower [line 136]

static string strtolower(
string
$str 
)

Make a string lowercase

Parameters:

string

$str:

The string being lowercased.

API Tags:

Access:

public

[ Top ]

static method strtoupper [line 154]

static string strtoupper(
string
$str 
)

Make a string uppercase

Parameters:

string

$str:

The string being uppercased.

API Tags:

Access:

public

[ Top ]

static method substr [line 89]

static string substr(
string
$str, int
$start, [
$length = ''], int
$length[optional] 
)

Get part of string

Parameters:

string	$str:	The string being checked.
int	$start:	The first position used in $str
int	$length[optional]:	The maximum length of the returned string
	$length:

API Tags:

Access:

public

[ Top ]

static method truncate [line 243]

static string truncate(
string
$string, integer
$max, string
$replace 
)

ATK version of the Smarty truncate function, multibyte safe.

Parameters:

string	$string:	text to truncate
integer	$max:	Maximum length of the total result string
string	$replace:	text to append to the end of the truncated string

API Tags:

Return:	truncated sting
Access:	public

[ Top ]