mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 15:12:22 +01:00
147 lines
3.9 KiB
XML
147 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./ja/functions/dir.xml, last change in rev 1.1 -->
|
|
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: hirokawa Status: ready -->
|
|
<!-- CREDITS: takagi -->
|
|
<refentry xml:id="function.dir" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>dir</refname>
|
|
<refpurpose>ディレクトリクラスのインスタンスを返す</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>Directory</type><type>false</type></type><methodname>dir</methodname>
|
|
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
ディレクトリを読むための疑似オブジェクト指向の機構です。
|
|
指定した <parameter>directory</parameter> がオープンされます。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>directory</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
オープンするディレクトリ。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>context</parameter></term>
|
|
<listitem>
|
|
¬e.context-support;
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<classname>Directory</classname> のインスタンスを返します。
|
|
エラーの場合は &false; を返します。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
<parameter>context</parameter> は、nullable になりました。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>dir</function> の例</title>
|
|
<para>
|
|
以下の例で、<function>Directory::read</function> の戻り値をどのように調べているかに
|
|
注目してください。戻り値が &false; と一致することを、明示的に
|
|
（値が等しく、かつ型も等しい - 詳細は <link linkend="language.operators.comparison">
|
|
比較演算子</link> を参照ください）調べています。なぜなら、そうしないと
|
|
&false; と評価されてしまうディレクトリエントリがあった場合にループが
|
|
とまってしまうからです。
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$d = dir("/etc/php5");
|
|
echo "Handle: " . $d->handle . "\n";
|
|
echo "Path: " . $d->path . "\n";
|
|
while (false !== ($entry = $d->read())) {
|
|
echo $entry."\n";
|
|
}
|
|
$d->close();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Handle: Resource id #2
|
|
Path: /etc/php5
|
|
.
|
|
..
|
|
apache
|
|
cgi
|
|
cli
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
読み込みにより返されるディレクトリエントリの順番は、システムに依存します。
|
|
</para>
|
|
</note>
|
|
</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
|
|
-->
|