[PHP-WEBMASTER] [web-php] fix-local-manual: Add a new documentation page for rtrim()

noreply · December 5, 2024, 11:53am

Author: Gina Peter Banyard (Girgias)
Date: 2024-12-05T11:47:37Z

Commit: Add a new documentation page for rtrim() · php/web-php@5841924 · GitHub
Raw diff: https://github.com/php/web-php/commit/58419246e0e77da35b89f8f9c4194c41ba1c788a.diff

Add a new documentation page for rtrim()

This page has examples with output to test the interactive code runner

Changed paths:
A manual/en/function.rtrim.php
M manual/en/function.strpos.php

Diff:

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 @@
+<?php
+include_once __DIR__ . '/../../include/shared-manual.inc';
+$TOC = array();
+$PARENTS = array();
+include_once __DIR__ ."/toc/ref.strings.inc";
+$setup = array (
+ 'home' =>
+ 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);
+
+?>
+<div id="function.rtrim" class="refentry">
+ <div class="refnamediv">
+ <h1 class="refname">rtrim</h1>
+ (PHP 4, PHP 5, PHP 7, PHP 8)rtrim — Strip whitespace (or other characters) from the end of a string
+
+ </div>
+
+ <div class="refsect1 description" id="refsect1-function.rtrim-description">
+ <h3 class="title">Description</h3>
+ <div class="methodsynopsis dc-description">
+ rtrim(<a href="language.types.string.php" class="type string">string</a> <code class="parameter">$string</code>, <a href="language.types.string.php" class="type string">string</a> <code class="parameter">$characters</code> = " \n\r\t\v\x00"): <a href="language.types.string.php" class="type string">string</a></div>
+
+ 
+ This function returns a string with whitespace (or other characters) stripped from the
+ end of <code class="parameter">string</code>.
+ 
+ 
+ Without the second parameter,
+ rtrim() will strip these characters:
+ 
+
+ <ul class="itemizedlist">
+ <li class="listitem">
+ 
+ <code class="literal">" "</code>: <abbr title="American Standard Code for Information Interchange">ASCII</abbr> <abbr>SP</abbr> character
+ <code class="literal">0x20</code>, an ordinary space.
+ 
+ </li>
+ <li class="listitem">
+ 
+ <code class="literal">"\t"</code>: <abbr title="American Standard Code for Information Interchange">ASCII</abbr> <abbr>HT</abbr> character
+ <code class="literal">0x09</code>, a tab.
+ 
+ </li>
+ <li class="listitem">
+ 
+ <code class="literal">"\n"</code>: <abbr title="American Standard Code for Information Interchange">ASCII</abbr> <abbr>LF</abbr> character
+ <code class="literal">0x0A</code>, a new line (line feed).
+ 
+ </li>
+ <li class="listitem">
+ 
+ <code class="literal">"\r"</code>: <abbr title="American Standard Code for Information Interchange">ASCII</abbr> <abbr>CR</abbr> character
+ <code class="literal">0x0D</code>, a carriage return.
+ 
+ </li>
+ <li class="listitem">
+ 
+ <code class="literal">"\0"</code>: <abbr title="American Standard Code for Information Interchange">ASCII</abbr> <abbr>NUL</abbr> character
+ <code class="literal">0x00</code>, the NUL-byte.
+ 
+ </li>
+ <li class="listitem">
+ 
+ <code class="literal">"\v"</code>: <abbr title="American Standard Code for Information Interchange">ASCII</abbr> <abbr>VT</abbr>
+ character <code class="literal">0x0B</code>, a vertical tab.
+ 
+ </li>
+ </ul>
+
+ </div>
+
+
+ <div class="refsect1 parameters" id="refsect1-function.rtrim-parameters">
+ <h3 class="title">Parameters</h3>
+ <dl>
+
+ <dt><code class="parameter">string</code></dt>
+ <dd>
+ 
+ The input string.
+ 
+ </dd>
+
+
+ <dt><code class="parameter">characters</code></dt>
+ <dd>
+
+ 
+ Optionally, the stripped characters can also be specified using
+ the <code class="parameter">characters</code> parameter.
+ Simply list all characters that need to be stripped.
+ With <code class="literal">..</code> it is possible to specify an incrementing range of characters.
+ 
+
+ </dd>
+
+ </dl>
+ </div>
+
+
+ <div class="refsect1 returnvalues" id="refsect1-function.rtrim-returnvalues">
+ <h3 class="title">Return Values</h3>
+ 
+ Returns the modified string.
+ 
+ </div>
+
+
+ <div class="refsect1 examples" id="refsect1-function.rtrim-examples">
+ <h3 class="title">Examples</h3>
+ <div class="example" id="example-4971">
+ Example #1 Usage example of rtrim()
+ <div class="example-contents">
+ <div class="phpcode"><code><?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); ?></code></div>
+ </div>
+
+ <div class="example-contents">The above example will output:</div>
+ <div class="example-contents screen">
+ <div class="examplescode"><pre class="examplescode">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"</pre>
+ </div>
+ </div>
+ </div>
+ <div class="example" id="similar_text.example.swapping">
+ Example #1 similar_text() argument swapping example
+ <div class="example-contents">
+ This example shows that swapping the <code class="parameter">string1</code> and
+ <code class="parameter">string2</code> argument may yield different results.
+ </div>
+ <div class="example-contents">
+ <div class="phpcode"><code><?php $sim = similar_text('bafoobar', 'barfoo', $perc); echo "similarity: $sim ($perc %)\n"; $sim = similar_text('barfoo', 'bafoobar', $perc); echo "similarity: $sim ($perc %)\n";</code></div>
+ </div>
+
+ <div class="example-contents">The above example will output
+ something similar to:</div>
+ <div class="example-contents screen">
+ <div class="examplescode"><pre class="examplescode">similarity: 5 (71.428571428571 %)
+similarity: 3 (42.857142857143 %)</pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+
+ <div class="refsect1 seealso" id="refsect1-function.rtrim-seealso">
+ <h3 class="title">See Also</h3>
+ <ul class="simplelist">
+ <li><a href="function.trim.php" class="function" rel="rdfs-seeAlso">trim()</a> - Strip whitespace (or other characters) from the beginning and end of a string</li>
+ <li><a href="function.ltrim.php" class="function" rel="rdfs-seeAlso">ltrim()</a> - Strip whitespace (or other characters) from the beginning of a string</li>
+ </ul>
+ </div>
+</div><?php manual_footer(); ?>
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 (