From 58419246e0e77da35b89f8f9c4194c41ba1c788a Mon Sep 17 00:00:00 2001 From: Gina Peter Banyard Date: Thu, 5 Dec 2024 11:47:37 +0000 Subject: [PATCH] Add a new documentation page for rtrim() This page has examples with output to test the interactive code runner --- manual/en/function.rtrim.php | 190 ++++++++++++++++++++++++++++++++++ manual/en/function.strpos.php | 4 +- 2 files changed, 192 insertions(+), 2 deletions(-) create mode 100644 manual/en/function.rtrim.php diff --git a/manual/en/function.rtrim.php b/manual/en/function.rtrim.php new file mode 100644 index 0000000000..a6fae9449d --- /dev/null +++ b/manual/en/function.rtrim.php @@ -0,0 +1,190 @@ + + array ( + 0 => 'index.php', + 1 => 'PHP Manual', + ), + 'head' => + array ( + 0 => 'UTF-8', + 1 => 'en', + ), + 'this' => + array ( + 0 => 'function.rtrim.php', + 1 => 'rtrim', + ), + 'up' => + array ( + 0 => 'ref.strings.php', + 1 => 'String Functions', + ), + 'prev' => + array ( + 0 => 'function.strpos.php', + 1 => 'strpos', + ), + 'alternatives' => + array ( + ), +); +$setup["toc"] = $TOC; +$setup["parents"] = $PARENTS; +manual_setup($setup); + +?> +
+
+

rtrim

+

(PHP 4, PHP 5, PHP 7, PHP 8)

rtrim — Strip whitespace (or other characters) from the end of a string

+ +
+ +
+

Description

+
+ rtrim(string $string, string $characters = " \n\r\t\v\x00"): string
+ +

+ This function returns a string with whitespace (or other characters) stripped from the + end of string. +

+

+ Without the second parameter, + rtrim() will strip these characters: +

+ +
    +
  • + + " ": ASCII SP character + 0x20, an ordinary space. + +
    • +
  • + + "\t": ASCII HT character + 0x09, a tab. + +
    • +
  • + + "\n": ASCII LF character + 0x0A, a new line (line feed). + +
    • +
  • + + "\r": ASCII CR character + 0x0D, a carriage return. + +
    • +
  • + + "\0": ASCII NUL character + 0x00, the NUL-byte. + +
    • +
  • + + "\v": ASCII VT + character 0x0B, a vertical tab. + +
    • +
+ +
+ + +
+

Parameters

+
+ +
string
+
+ + The input string. + +
+ + +
characters
+
+ + + Optionally, the stripped characters can also be specified using + the characters parameter. + Simply list all characters that need to be stripped. + With .. it is possible to specify an incrementing range of characters. + + +
+ +
+
+ + +
+

Return Values

+

+ Returns the modified string. +

+
+ + +
+

Examples

+
+

Example #1 Usage example of rtrim()

+
+
<?php

$text = "\t\tThese are a few words :) ... ";
$binary = "\x09Example string\x0A";
$hello = "Hello World";
var_dump($text, $binary, $hello);

print "\n";

$trimmed = rtrim($text);
var_dump($trimmed);

$trimmed = rtrim($text, " \t.");
var_dump($trimmed);

$trimmed = rtrim($hello, "Hdle");
var_dump($trimmed);

// trim the ASCII control characters at the end of $binary
// (from 0 to 31 inclusive)
$clean = rtrim($binary, "\x00..\x1F");
var_dump($clean);

?>
+
+ +

The above example will output:

+
+ 
string(32) "        These are a few words :) ...  "
+string(16) "    Example string
+"
+string(11) "Hello World"
+
+string(30) "        These are a few words :) ..."
+string(26) "        These are a few words :)"
+string(9) "Hello Wor"
+string(15) "    Example string"
+
+
+
+
+

Example #1 similar_text() argument swapping example

+

+ This example shows that swapping the string1 and + string2 argument may yield different results. +

+
+
<?php
$sim = similar_text('bafoobar', 'barfoo', $perc);
echo "similarity: $sim ($perc %)\n";
$sim = similar_text('barfoo', 'bafoobar', $perc);
echo "similarity: $sim ($perc %)\n";
+
+ +

The above example will output + something similar to:

+
+ 
similarity: 5 (71.428571428571 %)
+similarity: 3 (42.857142857143 %)
+
+
+
+
+ + +
+

See Also

+
    +
  • trim() - Strip whitespace (or other characters) from the beginning and end of a string
    • +
  • ltrim() - Strip whitespace (or other characters) from the beginning of a string
    • +
+
+
diff --git a/manual/en/function.strpos.php b/manual/en/function.strpos.php index 89faf76e07..00b1ebdbb8 100644 --- a/manual/en/function.strpos.php +++ b/manual/en/function.strpos.php @@ -31,8 +31,8 @@ ), 'next' => array ( - 0 => 'function.strrchr.php', - 1 => 'strrchr', + 0 => 'function.rtrim.php', + 1 => 'rtrim', ), 'alternatives' => array (