mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 07:02:08 +01:00
141 lines
3.9 KiB
XML
141 lines
3.9 KiB
XML
<?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"
|
|
|
|
// 次の２ステップをとばします
|
|
next($array);
|
|
next($array);
|
|
echo current($array) . "<br />\n"; // "step three"
|
|
|
|
// ポインタをリセットし、再度ステップ１開始します
|
|
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
|
|
-->
|