<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mkdir">
 <refnamediv>
  <refname>mkdir</refname>
  <refpurpose>Makes directory</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>
   Attempts to create the directory specified by <parameter>directory</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       The directory path.
       &tip.fopen-wrapper;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>permissions</parameter></term>
     <listitem>
      <para>
       The permissions are 0777 by default, which means the widest possible
       access. For more information on permissions, read the details
       on the <function>chmod</function> page.
      </para>
      <note>
       <para>
        <parameter>permissions</parameter> is ignored on Windows.
       </para>
      </note>
      <para>
       Note that you probably want to specify the <parameter>permissions</parameter> as an octal number,
       which means it should have a leading zero. The <parameter>permissions</parameter> is also modified
       by the current umask, which you can change using
       <function>umask</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recursive</parameter></term>
     <listitem>
      <para>
       If &true;, then any parent directories to the <parameter>directory</parameter> specified will
       also be created, with the same permissions.
      </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>
    If the directory to be created already exists, that is considered an error
    and &false; will still be returned.  Use <function>is_dir</function> or
    <function>file_exists</function> to check if the directory already exists
    before trying to create it.
   </para>
  </note>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Emits an <constant>E_WARNING</constant> level error if the directory
   already exists.
  </para>
  <para>
   Emits an <constant>E_WARNING</constant> level error if the relevant
   permissions prevent creating the directory.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mkdir</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
mkdir("/path/to/my/dir", 0700);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>mkdir</function> using the <parameter>recursive</parameter> parameter</title>
    <programlisting role="php">
<![CDATA[
<?php
// Desired directory structure
$structure = './depth1/depth2/depth3/';

// To create the nested structure, the $recursive parameter 
// to mkdir() must be specified.

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
-->
