dirname.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 67ca0d930c95a85ea49aff456409409f6ae06c1b Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.dirname">
 <refnamediv>
  <refname>dirname</refname>
  <refpurpose>親ディレクトリのパスを返す</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>dirname</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>levels</parameter><initializer>1</initializer></methodparam>
  </methodsynopsis>
  <para>
   ファイルあるいはディレクトリへのパスを含む文字列を受け取って、
   カレントディレクトリから <parameter>levels</parameter> レベルさかのぼった親ディレクトリのパスを返します。
  </para>
  <note>
   <para>
    <function>dirname</function> は、入力文字列を単純にそのまま処理します。
    実際のファイルシステムを確認したり
    "<literal>..</literal>" のようなパスを気にしたりすることはありません。
   </para>
  </note>
  <caution>
   <para>
    Windows では、<function>dirname</function>
    は現在設定されているコードページに依存します。
    よって、マルチバイト文字が含まれたパスを正しく表示するには、
    それと一致するコードページが設定されていなければいけません。
    現在のコードページから見て不正な文字が <parameter>path</parameter>  に含まれていた場合、
    <function>basename</function> の動作は未定義です。
   </para>
   <para>
    Windows 以外のシステムでは、
    <parameter>path</parameter> はASCII と互換性があるエンコーディングでエンコードされていると想定されています。
    そうでない場合、この関数の動作は未定義です。
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       パス。
      </para>
      <para>
       Windows では、スラッシュ(<literal>/</literal>)とバックスラッシュ
       (<literal>\</literal>)の両方がディレクトリ区切り文字として使われます。
       その他の環境ではスラッシュ(<literal>/</literal>)になります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>levels</parameter></term>
     <listitem>
      <para>
       親ディレクトリをどこまでさかのぼるか。
      </para>
      <para>
       正の整数でなければいけません。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   親ディレクトリのパスを返します。
   <parameter>path</parameter> にスラッシュが無い場合は、
   カレントディレクトリを示すドット ('<literal>.</literal>')
   を返します。それ以外の場合は、スラッシュ以降の
   <literal>/component</literal> 部分を取り除いた
   <parameter>path</parameter> を返します。
  </para>

  <caution>
   <para>
    この関数をトップレベルディレクトリまで走査するループで使う場合は、
    注意が必要です。なぜなら、無限ループに陥る可能性があるからです。
    <informalexample>
     <programlisting role="php">
<![CDATA[
<?php
dirname('.');    // '.' を返します。
dirname('/');    // Windows では `\` を、*nix システムでは '/' を返します。
dirname('\\');   // Windows では `\` を、*nix システムでは '.' を返します。
dirname('C:\\'); // Windows では 'C:\' を、*nix システムでは '.' を返します。
?>
]]>
     </programlisting>
    </informalexample>
   </para>
  </caution>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.0.0</entry>
       <entry>
        オプションのパラメータ <parameter>levels</parameter> が追加されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>dirname</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
echo dirname("/etc/passwd") . PHP_EOL;
echo dirname("/etc/") . PHP_EOL;
echo dirname(".") . PHP_EOL;
echo dirname("C:\\") . PHP_EOL;
echo dirname("/usr/local/lib", 2);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
/etc
/ (Windows の場合は \)
.
C:\
/usr
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>basename</function></member>
    <member><function>pathinfo</function></member>
    <member><function>realpath</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
-->