1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="simplexmlelement.valid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::valid</refname>
<refpurpose>Check whether the current element is valid</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SimpleXMLElement">
<modifier>public</modifier> <type>bool</type><methodname>SimpleXMLElement::valid</methodname>
<void/>
</methodsynopsis>
<warning>
<simpara>
Prior to PHP 8.0, <methodname>SimpleXMLElement::valid</methodname> was only
declared on the subclass <classname>SimpleXMLIterator</classname>.
</simpara>
</warning>
<para>
This method checks if the current element is valid after calls to
<methodname>SimpleXMLElement::rewind</methodname> or
<methodname>SimpleXMLElement::next</methodname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the current element is valid, otherwise &false;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Check whether the current element is valid</title>
<programlisting role="php">
<![CDATA[
<?php
$xmlElement = new SimpleXMLElement('<books><book>SQL Basics</book></books>');
$xmlElement->rewind(); // rewind to the first element
echo var_dump($xmlElement->valid()); // bool(true)
$xmlElement->next(); // advance to the next element
echo var_dump($xmlElement->valid()); // bool(false) because there is only one element
?>
]]>
</programlisting>
</example>
</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:"~/.phpdoc/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
-->
|