Skip to content

Commit a5dca07

Browse files
committed
Added Str::is_xml() documentation
1 parent c8b8f28 commit a5dca07

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

classes/str.html

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -558,6 +558,49 @@ <h4 class="method" id="method_is_html">is_html($string)</h4>
558558
</table>
559559
</article>
560560

561+
<article>
562+
<h4 class="method" id="method_is_xml">is_xml($string)</h4>
563+
<p>The <strong>is_xml</strong> method check if a string is a valid xml.</p>
564+
<table class="method">
565+
<tbody>
566+
<tr>
567+
<th class="legend">Static</th>
568+
<td>Yes</td>
569+
</tr>
570+
<tr>
571+
<th>Parameters</th>
572+
<td>
573+
<table class="parameters">
574+
<tr>
575+
<th>Param</th>
576+
<th>Type</th>
577+
<th>Default</th>
578+
<th class="description">Description</th>
579+
</tr>
580+
<tr>
581+
<th><kbd>$string</kbd></th>
582+
<td><em>string</em></td>
583+
<td><em>Required</em></td>
584+
<td>The input string.</td>
585+
</tr>
586+
</table>
587+
</td>
588+
</tr>
589+
<tr>
590+
<th>Returns</th>
591+
<td>bool</td>
592+
</tr>
593+
<tr>
594+
<th>Example</th>
595+
<td>
596+
<pre class="php"><code>Str::is_xml('&lt;?xml version="1.0" encoding="utf-8"?>&lt;xml>&lt;foo>bar&lt;/foo>&lt;baz>qux&lt;/baz>&lt;/xml>');
597+
// returns true</code></pre>
598+
</td>
599+
</tr>
600+
</tbody>
601+
</table>
602+
</article>
603+
561604
<article>
562605
<h4 class="method" id="method_starts_with">starts_with($str, $start, $ignore_case = false)</h4>
563606
<p>The <strong>starts_with</strong> method checks wether a string has a precific beginning.</p>

0 commit comments

Comments
 (0)