API15:JString/rtrim

From Joomla! Documentation

Jump to: navigation, search

Contents

Description

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

[Edit Descripton]

Description:JString/rtrim

Syntax

rtrim($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

function rtrim( $str, $charlist = FALSE )
{
        jimport('phputf8.trim');
        if ( $charlist === FALSE ) {
                return utf8_rtrim($str);
        } else {
                return utf8_rtrim( $str, $charlist );
        }
}

[Edit See Also] SeeAlso:JString/rtrim

Examples


Retrieved from "http://docs.joomla.org/API15:JString/rtrim"
Personal tools