php-doc-en/reference/simplexml/simplexmliterator/current.xml
2012-01-13 10:34:09 +00:00

95 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="simplexmliterator.current" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLIterator::current</refname>
<refpurpose>Returns the current element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>SimpleXMLIterator::current</methodname>
<void/>
</methodsynopsis>
<para>
This method returns the current element as a <classname>SimpleXMLIterator</classname> object or &null;.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current element as a <classname>SimpleXMLIterator</classname> object or &null; on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Return the current element</title>
<programlisting role="php">
<![CDATA[
<?php
$xmlIterator = new SimpleXMLIterator('<books><book>PHP basics</book><book>XML basics</book></books>');
var_dump($xmlIterator->current());
$xmlIterator->rewind(); // rewind to first element
var_dump($xmlIterator->current());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
NULL
object(SimpleXMLIterator)#2 (1) {
[0]=>
string(10) "PHP basics"
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SimpleXMLIterator::key</methodname></member>
<member><methodname>SimpleXMLIterator::next</methodname></member>
<member><methodname>SimpleXMLIterator::rewind</methodname></member>
<member><methodname>SimpleXMLIterator::valid</methodname></member>
<member><classname>SimpleXMLElement</classname></member>
</simplelist>
</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
-->