mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
3.6 KiB
XML
120 lines
3.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.31 -->
|
|
<refentry id="function.rtrim">
|
|
<refnamediv>
|
|
<refname>rtrim</refname>
|
|
<refpurpose>
|
|
Strip whitespace from the end of a string
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>rtrim</methodname>
|
|
<methodparam><type>string</type><parameter>str</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>charlist</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<note>
|
|
<simpara>
|
|
The second parameter was added in PHP 4.1.0
|
|
</simpara>
|
|
</note>
|
|
<para>
|
|
This function returns a string with whitespace stripped from the
|
|
end of <parameter>str</parameter>.
|
|
Without the second parameter,
|
|
<function>rtrim</function> will strip these characters:
|
|
<!-- sorted by importance. Printed 3 times: trim, ltrim, rtrim -->
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
" " (<acronym>ASCII</acronym> <literal>32</literal>
|
|
(<literal>0x20</literal>)), an ordinary space.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
"\t" (<acronym>ASCII</acronym> <literal>9</literal>
|
|
(<literal>0x09</literal>)), a tab.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
"\n" (<acronym>ASCII</acronym> <literal>10</literal>
|
|
(<literal>0x0A</literal>)), a new line (line feed).
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
"\r" (<acronym>ASCII</acronym> <literal>13</literal>
|
|
(<literal>0x0D</literal>)), a carriage return.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
"\0" (<acronym>ASCII</acronym> <literal>0</literal>
|
|
(<literal>0x00</literal>)), the <literal>NUL</literal>-byte.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara> <!-- not \v, since not supported by PHP -->
|
|
"\x0B" (<acronym>ASCII</acronym> <literal>11</literal>
|
|
(<literal>0x0B</literal>)), a vertical tab.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
You can also specify the characters you want to strip, by means
|
|
of the <parameter>charlist</parameter> parameter.
|
|
Simply list all characters that you want to be stripped. With
|
|
<literal>..</literal> you can specify a range of characters.
|
|
</para>
|
|
<example>
|
|
<title>Usage example of <function>rtrim</function></title>
|
|
<para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$text = "\t\tThese are a few words :) ... ";
|
|
$trimmed = rtrim($text);
|
|
// $trimmed = "\t\tThese are a few words :) ..."
|
|
$trimmed = rtrim($text," \t.");
|
|
// $trimmed = "\t\tThese are a few words :)"
|
|
$clean = rtrim($binary,"\0x00..\0x1F");
|
|
// trim the ASCII control characters at the end of $binary
|
|
// (from 0 to 31 inclusive)
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</para>
|
|
</example>
|
|
<para>
|
|
See also <function>trim</function> and <function>ltrim</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|