API16:JString/ltrim
From Joomla! Documentation
Description
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
Syntax
static ltrim($str, $charlist=FALSE)
Parameter Name | Default Value | Description |
---|---|---|
$str | the string to be trimmed | |
$charlist | FALSE | the optional charlist of additional characters to trim |
Returns
string the trimmed string
Defined in
libraries/joomla/utilities/string.php
Importing
jimport( 'joomla.utilities.string' );
Source Body
public static function ltrim($str, $charlist = FALSE)
{
jimport('phputf8.trim');
if ( $charlist === FALSE ) {
return utf8_ltrim( $str );
} else {
return utf8_ltrim( $str, $charlist );
}
}
Examples
Code Examples