-
Notifications
You must be signed in to change notification settings - Fork 70
/
each.xml
204 lines (195 loc) · 6.29 KB
/
each.xml
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: a6655e3f9508eee6860b02f55e33560a790f42d1 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.each" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>each</refname>
<refpurpose>Возвращает текущую пару ключа и значения массива и сдвигает указатель на одну позицию вперёд</refpurpose>
</refnamediv>
<refsynopsisdiv>
&warn.deprecated.function-7-2-0.removed-8-0-0;
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>each</methodname>
<methodparam><type class="union"><type>array</type><type>object</type></type><parameter role="reference">array</parameter></methodparam>
</methodsynopsis>
<para>
Возвращает текущую пару ключа и значения массива и продвигает внутренний указатель массива на одну позицию.
</para>
<para>
После выполнения функции <function>each</function> указатель массива
останется на следующем элементе или за последним элементом,
если указатель достигнет конца массива. Для повторного обхода
каждого элемента массива, нужно вызвать функцию <function>reset</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
Входной массив.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает текущую пару ключа и значения массива
<parameter>array</parameter>. Пара возвращается
в массиве из четырёх элементов с ключами <literal>0</literal>,
<literal>1</literal>, <literal>key</literal> и <literal>value</literal>.
Элементы с ключами <literal>0</literal> и <literal>key</literal> содержат
имя ключа элемента массива, а ключи <literal>1</literal> и <literal>value</literal>
содержат данные.
</para>
<para>
Если внутренний указатель массива указывает за пределы массива,
функция <function>each</function> вернёт &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Примеры использования функции <function>each</function></title>
<programlisting role="php">
<![CDATA[
<?php
$foo = array("bob", "fred", "jussi", "jouni", "egon", "marliese");
$bar = each($foo);
print_r($bar);
?>
]]>
</programlisting>
<para>
Переменная <varname>$bar</varname> теперь содержит следующие пары ключей и значений:
</para>
<screen>
<![CDATA[
Array
(
[1] => bob
[value] => bob
[0] => 0
[key] => 0
)
]]>
</screen>
</example>
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$foo = array("Robert" => "Bob", "Seppo" => "Sepi");
$bar = each($foo);
print_r($bar);
?>
]]>
</programlisting>
<para>
Переменная <varname>$bar</varname> теперь содержит следующие пары ключей и значений:
</para>
<screen>
<![CDATA[
Array
(
[1] => Bob
[value] => Bob
[0] => Robert
[key] => Robert
)
]]>
</screen>
</informalexample>
</para>
<para>
Функцию <function>each</function> часто вызывают совместно
с функцией <function>list</function> для обхода массива, как
в этом примере:
<example>
<title>Обход массива функцией <function>each</function></title>
<programlisting role="php">
<![CDATA[
<?php
$fruit = array('a' => 'apple', 'b' => 'banana', 'c' => 'cranberry');
reset($fruit);
while (list($key, $val) = each($fruit)) {
echo "$key => $val\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
a => apple
b => banana
c => cranberry
]]>
</screen>
</example>
</para>
<caution>
<para>
Поскольку присвоение массива другой переменной
сбрасывает указатель исходного массива, пример выше
вызвал бы бесконечный цикл, если бы внутри цикла
переменную <varname>$fruit</varname>
присвоили другой переменной.
</para>
</caution>
<warning>
<para>
Функция <function>each</function> также принимает объекты,
но иногда возвращает неожиданные результаты. Поэтому перебирать
свойства объекта функцией <function>each</function> не рекомендуют.
</para>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>key</function></member>
<member><function>list</function></member>
<member><function>current</function></member>
<member><function>reset</function></member>
<member><function>next</function></member>
<member><function>prev</function></member>
<member>&foreach;</member>
<member><link linkend="language.oop5.iterations">Итерация объектов</link></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
-->