-
Notifications
You must be signed in to change notification settings - Fork 57
/
reset.xml
140 lines (131 loc) · 3.9 KB
/
reset.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0a192fcd9cc43c0007de795063b4494974058992 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.reset" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>reset</refname>
<refpurpose>配列の内部ポインタを先頭の要素にセットする</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>reset</methodname>
<methodparam><type class="union"><type>array</type><type>object</type></type><parameter role="reference">array</parameter></methodparam>
</methodsynopsis>
<para>
<function>reset</function> は、<parameter>array</parameter>
の内部ポインタの先頭の要素に戻し、配列の最初の要素の値を返します。
</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>
配列の最初の要素の値を返します。
配列が空の場合 &false; を返します。
</para>
&return.falseproblem;
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&standard.changelog.calling-on-objects;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>reset</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array('step one', 'step two', 'step three', 'step four');
// デフォルトでは、ポインタは先頭要素を指しています
echo current($array) . "<br />\n"; // "step one"
// 次の2ステップをとばします
next($array);
next($array);
echo current($array) . "<br />\n"; // "step three"
// ポインタをリセットし、再度ステップ1開始します
reset($array);
echo current($array) . "<br />\n"; // "step one"
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
空の配列に対してこの関数を実行した場合の戻り値は、
配列の先頭要素に <type>bool</type> &false; がある配列に対して
実行した場合の戻り値と区別できません。
配列の先頭に &false; が含まれている可能性がある値を適切にチェックするには、
まず最初に 配列の <function>count</function> をチェックするか、
<function>reset</function> を呼び出した後に、
要素の <function>key</function> が &null; でないことを確かめるようにしてください。
</simpara>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>current</function></member>
<member><function>each</function></member>
<member><function>end</function></member>
<member><function>next</function></member>
<member><function>prev</function></member>
<member><function>array_key_first</function></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
-->