mkdir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6b48028aef8211f89ae6c9fefe64177de2f86e12 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mkdir">
 <refnamediv>
  <refname>mkdir</refname>
  <refpurpose>Crea un directorio</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>
   Intenta crear el directorio especificado por <parameter>directory</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       La ruta del directorio.
       &tip.fopen-wrapper;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>permissions</parameter></term>
     <listitem>
      <para>
       El modo predeterminado es 0777, lo que significa el acceso más amplio
       posible. Para más información sobre los modos, lea los detalles
       en la página de <function>chmod</function>.
      </para>
      <note>
       <para>
        <parameter>permissions</parameter> es ignorado en Windows.
       </para>
      </note>
      <para>
       Observe que probablemente se quiera especificar el modo como un número octal,
       lo que significa que debería de haber un cero inicial. El modo es modificado también
       por la actual máscara de usuario, la cual se puede cambiar usando
       <function>umask</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recursive</parameter></term>
     <listitem>
      <para>
       Si el valor es &true;, entonces cualquier directorio padre del directorio especificado
       en el parámetro <parameter>directory</parameter> también será creado, con los mismos permisos.
      </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 el directorio a crear ya existe, se considerará un error
    y se devolverá &false;. Utilice <function>is_dir</function> o
    <function>file_exists</function> para comprobar si el directorio ya existe
    antes de intentar crearlo.
   </para>
  </note>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Emite un error de nivel <constant>E_WARNING</constant> si el directorio
   ya existe.
  </para>
  <para>
   Emite un error de nivel <constant>E_WARNING</constant> si los permisos
   relevantes impiden crear el directorio.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>mkdir</function></title>
    <programlisting role="php">
<![CDATA[
<?php
mkdir("/ruta/a/mi/directorio", 0700);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>mkdir</function> usando el parámetro <parameter>recursive</parameter></title>
    <programlisting role="php">
<![CDATA[
<?php
// Estructura de la carpeta deseada
$estructura = './nivel1/nivel2/nivel3/';

// Para crear una estructura anidada se debe especificar
// el parámetro $recursive en mkdir().

if(!mkdir($estructura, 0777, true)) {
    die('Fallo al crear las carpetas...');
}

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