archived-doc-es/reference/dir/functions/readdir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 -->
<!-- EN-Revision: 99a5cc447fc5ab7c3deeeb6f7462f9891bc86852 Maintainer: tkzexe Status: ready -->
<!-- Reviewed: no -->
<!-- splitted from ./en/functions/dir.xml, last change in rev 1.2 -->
<refentry xml:id="function.readdir" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>readdir</refname>
  <refpurpose>Lee una entrada desde un gestor de directorio</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>readdir</methodname>
   <methodparam choice="opt"><type>resource</type><parameter>dir_handle</parameter></methodparam>
  </methodsynopsis>
  <para>
   Devuelve el nombre de la siguiente entrada del directorio. Las
   entradas son devueltas en el orden en que fueron almacenadas por
   el sistema de ficheros.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>gestor_dir</parameter></term>
     <listitem>
      <para>
       El gestor de directorio <type>resource</type> previamente abierto por <function>opendir</function>.
       Si el gestor de directorio no se especifica, la ultima conexión abierta por <function>opendir</function> 
       es asumida.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna el nombre de la entrada en caso de éxito &return.falseforfailure;.
  </para> 
  &return.falseproblem;
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Listar todas las entradas de un directorio</title>
    <para>
     Por favor observe que la forma en que el valor de retorno de <function>readdir</function>
     es chequeado en los siguientes ejemplos. Se está probando explícitamente si el valor de retorno es idéntico 
     (igual y del mismo tipo, vea los  <link
     linkend="language.operators.comparison">Operadores de Comparación</link> 
     para más información) a &false; ya que de otra forma, 
     cualquier entrada de directorio cuyo nombre evalúe a  &false; detendrá
     el ciclo (p.ej. un directorio llamado "0").
    </para>
    <programlisting role="php">
<![CDATA[
<?php
 
if ($gestor = opendir('/path/to/files')) {
    echo "Gestor de directorio: $gestor\n";
    echo "Entradas:\n";
 
    /* Esta es la forma correcta de iterar sobre el directorio. */
    while (false !== ($entrada = readdir($gestor))) {
        echo "$entrada\n";
    }
 
    /* Esta es la forma errónea de iterar sobre el directorio. */
    while ($entrada = readdir($gestor)) {
        echo "$entrada\n";
    }
 
    closedir($gestor);
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>
    Listar todas las entradas del directorio actual y descartar <literal>.</literal>
     y <literal>..</literal>
    </title>
    <programlisting role="php">
<![CDATA[
<?php
if ($gestor = opendir('.')) {
    while (false !== ($entrada = readdir($gestor))) {
        if ($entrada != "." && $entrada != "..") {
            echo "$entrada\n";
        }
    }
    closedir($gestor);
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_dir</function></member>
    <member><function>glob</function></member>
    <member><function>opendir</function></member>
    <member><function>scandir</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
-->