mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
bbe604e700
Patch by Alex Dowad. Closes php/doc-en#118 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350025 c90b9560-bf6c-de11-be94-00142212c4b1
85 lines
2.2 KiB
XML
85 lines
2.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="arrayiterator.offsetunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ArrayIterator::offsetUnset</refname>
|
|
<refpurpose>Unset value for an offset</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::offsetUnset</methodname>
|
|
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Unsets a value for an offset.
|
|
</para>
|
|
<para>
|
|
If iteration is in progress, and <methodname>ArrayIterator::offsetUnset</methodname> is used to
|
|
unset the current index of iteration, the iteration position will be advanced to the next index.
|
|
Since the iteration position is also advanced at the end of a
|
|
&foreach; loop body, use of
|
|
<methodname>ArrayIterator::offsetUnset</methodname> inside a
|
|
<link linkend="control-structures.foreach"><literal>foreach</literal></link> loop may result in
|
|
indices being skipped.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>index</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The offset to unset.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>ArrayIterator::offsetGet</methodname></member>
|
|
<member><methodname>ArrayIterator::offsetSet</methodname></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
|
|
-->
|