API16

JString/rtrim: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JString/rtrim}}
 


===Syntax===
===Syntax===
Line 46: Line 46:




{{subst:SeeAlso:JString/rtrim}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=rtrim
  category=rtrim
  category=JString
  category=JString
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 02:08, 25 March 2017

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



Syntax

static 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

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



Examples

Code Examples