mkdir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b48028aef8211f89ae6c9fefe64177de2f86e12 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mkdir">
 <refnamediv>
  <refname>mkdir</refname>
  <refpurpose>Crée un dossier</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>
   Tente de créer le dossier spécifier par <parameter>directory</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       Le chemin du dossier.
       &tip.fopen-wrapper;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>permissions</parameter></term>
     <listitem>
      <para>
       Les permissions par défaut est 0777, ce qui correspond au maximum de
       droits possible. Pour plus d'informations sur les permissions, lisez en
       détail la documentation de la fonction <function>chmod</function>.
      </para>
      <note>
       <para>
        <parameter>permissions</parameter> est ignoré sous Windows.
       </para>
      </note>
      <para>
       Notez que vous aurez à préciser les<parameter>permissions</parameter> en base octale,
       ce qui signifie que vous aurez probablement un 0 comme premier chiffre.
       Les <parameter>permissions</parameter> sera aussi modifié par le umask courant, que vous pouvez
       modifier avec la fonction <function>umask</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recursive</parameter></term>
     <listitem>
      <para>
       Si &true;, alors tous les répertoires parents au <parameter>directory</parameter> spécifié seront également créés,
       avec les mêmes 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>
    Si le répertoire à créer existe déjà, cela est considéré
    comme une erreur et &false; sera toujours retourné.
    Les fonctions <function>is_dir</function> ou <function>file_exists</function> peuvent être utilisée
    pour vérifier si le répertoire existe déjà avant d'essayer de le créer.
   </para>
  </note>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Émet une alerte de niveau <constant>E_WARNING</constant> si le dossier
   existe déjà.
  </para>
  <para>
   Émet une alerte de niveau <constant>E_WARNING</constant> si les permissions
   empêchent la création du dossier.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>mkdir</function></title>
    <programlisting role="php">
<![CDATA[
<?php
mkdir("/path/to/my/dir", 0700);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>mkdir</function> utilisant le paramètre <parameter>recursive</parameter> </title>
    <programlisting role="php">
<![CDATA[
<?php
// Structure de dossier désirée
$structure = './depth1/depth2/depth3/';

// Pour créer une structure imbriquée, le paramètre $recursive
// doit être spécifié.

if (!mkdir($structure, 0777, true)) {
    die('Échec lors de la création des dossiers...');
}

// ...
?>
]]>
    </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
-->