construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a7d00d0b9169ac0ca5e35dbed32ee288f4614586 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="filesystemiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>FilesystemIterator::__construct</refname>
  <refpurpose>新しい filesystem イテレータを作成する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="FilesystemIterator">
   <modifier>public</modifier> <methodname>FilesystemIterator::__construct</methodname>
   <methodparam><type>string</type><parameter>directory</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS</initializer></methodparam>
  </constructorsynopsis>
  <para>
   新しい filesystem イテレータを <parameter>directory</parameter> から作成します。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       反復処理したいファイルシステム上のアイテムへのパス。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       フラグを指定すると、いくつかのメソッドの振る舞いを変更することができます。
       フラグの一覧は <link linkend="filesystemiterator.constants">FilesystemIterator の定義済み定数</link>
       を参照ください。これは、あとで <methodname>FilesystemIterator::setFlags</methodname> で設定することもできます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>directory</parameter>
   が存在しない場合に、
   <classname>UnexpectedValueException</classname>
   をスローします。
  </para>
  <para>
   <parameter>directory</parameter>
   が空文字列の場合に、
   <classname>ValueError</classname> をスローします。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.2.0</entry>
       <entry>
        PHP 8.2.0 より前のバージョンでは、
        <constant>FilesystemIterator::SKIP_DOTS</constant>
        は常に設定され、削除できませんでした。
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <parameter>directory</parameter> が空文字列の場合に、
        <classname>ValueError</classname> をスローするようになりました。
        これより前のバージョンでは、
        <classname>RuntimeException</classname> をスローしていました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>FilesystemIterator::__construct</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$it = new FilesystemIterator(dirname(__FILE__), FilesystemIterator::CURRENT_AS_FILEINFO);
foreach ($it as $fileinfo) {
    echo $fileinfo->getFilename() . "\n";
}
?>
]]>
    </programlisting>
    &example.outputs.82.similar;
    <screen>
<![CDATA[
.
..
apples.jpg
banana.jpg
example.php
]]>
    </screen>
    <para>PHP 8.2.0 より前のバージョンでは、上の例の出力は以下のようになります:</para>
    <screen>
<![CDATA[
apples.jpg
banana.jpg
example.php
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>FilesystemIterator::setFlags</methodname></member>
    <member><methodname>DirectoryIterator::__construct</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
-->