mkdir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b48028aef8211f89ae6c9fefe64177de2f86e12 Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.mkdir" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mkdir</refname>
  <refpurpose>新建目录</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>mkdir</methodname>
   <methodparam><type>string</type><parameter>directory</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>permissions</parameter><initializer>0777</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>recursive</parameter><initializer>&false;</initializer></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;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       目录的路径。&tip.fopen-wrapper;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>permissions</parameter></term>
     <listitem>
      <para>
       默认权限是 0777，意味着最大可能的访问权。有关权限的更多信息请阅读 <function>chmod</function> 页面。
      </para>
      <note>
       <para>
        <parameter>permissions</parameter> 在 Windows 下被忽略。
       </para>
      </note>
      <para>
       注意也许想用八进制数指定
       <parameter>permissions</parameter>，也就是说该数应以零打头。<parameter>permissions</parameter>
       也会被当前的 umask 修改，可以用 <function>umask</function> 来改变。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recursive</parameter></term>
     <listitem>
      <para>
       如果为 &true;，还将会创建指定 <parameter>directory</parameter> 的任何父级目录，并具有相同的权限。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      &note.context-support;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <note>
   <para>
    如果创建的目录已存在，则视为错误，仍然返回 &false;。在尝试创建之前，使用
    <function>is_dir</function> 或者 <function>file_exists</function>
    检查目录是否已经存在。
   </para>
  </note>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   目录已存在时，产生 <constant>E_WARNING</constant> 错误。
  </para>
  <para>
   如果因为权限问题无法创建目录，导致 <constant>E_WARNING</constant> 错误。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mkdir</function> 例子</title>
    <programlisting role="php">
<![CDATA[
<?php
mkdir("/path/to/my/dir", 0700);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>通过 <parameter>recursive</parameter> 参数使用 <function>mkdir</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// 期望的目录结构
$structure = './depth1/depth2/depth3/';

// 要创建嵌套结构，必须指定 mkdir()
// 的 $recursive 参数。

if (!mkdir($structure, 0777, true)) {
    die('Failed to create directories...');
}

// ...
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_dir</function></member>    
    <member><function>rmdir</function></member>
    <member><function>umask</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
-->