<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
 <reference id="ref.dir">
  <title>Funes de diretrio</title>
  <titleabbrev>Diretrios</titleabbrev>

  <partintro>
  
   <simpara>
    Para funes relacionadas como <function>dirname</function>,
    <function>is_dir</function>, <function>mkdir</function>, and
    <function>rmdir</function>, veja a seo 
    <link linkend="ref.filesystem">Filesystem</link>.
   </simpara>
  
  </partintro>
  
  <refentry id="function.chroot">
   <refnamediv>
    <refname>chroot</refname>
    <refpurpose>mudar o diretrio raiz (root)</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descrio</title>
     <methodsynopsis>
      <type>bool</type><methodname>chroot</methodname>
      <methodparam><type>string</type><parameter>diretorio</parameter></methodparam>
     </methodsynopsis>
    <para>
     Muda o diretrio raiz (root) do processo atual para o
     <parameter>diretorio</parameter>. Retorna &false; se no for
     possvel mudar o diretrio raiz, retorna &true; caso contrrio.
    </para>
    <note>
     <para>
      No  sensato usar esta funo quando rodando em um ambiente
      de um webserver, porque no  possvel reiniciar o diretrio
      raiz (root) para / novamente no fim do pedido (request). Esta
      funo ir somente funcionar corretamente quando rodando como
      CGI desta forma.
     </para>
    </note>
   </refsect1>
  </refentry>

  <refentry id="function.chdir">
   <refnamediv>
    <refname>chdir</refname>
    <refpurpose>mudar de diretrio</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descrio</title>
     <methodsynopsis>
      <type>bool</type><methodname>chdir</methodname>
      <methodparam><type>string</type><parameter>diretorio</parameter></methodparam>
     </methodsynopsis>
    <para>
     Muda o diretrio atual do PHP para <parameter>diretorio</parameter>.
     Retorna &false; se no for possvel mudar de diretrio, retorna &true
     caso contrrio.
    </para>
   </refsect1>
  </refentry>

  <refentry id="class.dir">
   <refnamediv>
    <refname>dir</refname>
    <refpurpose>classe diretrio</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descrio</title>
     <methodsynopsis>
      <type>objeto</type><methodname>dir</methodname>
      <methodparam><type>string</type><parameter>diretorio</parameter></methodparam>
     </methodsynopsis>
    <para>
     Um mecanismo pseudo-orientado a objeto para ler um diretrio.
     O parametro dado <parameter>diretorio</parameter>  aberto.
     Duas propriedades so disponveis uma vez que o diretrio foi aberto.
     A propriedade sinnima pode ser usada com outras funes de diretrio
     como <function>readdir</function>, <function>rewinddir</function> e
     <function>closedir</function>. A propriedade path  configurada
     para o path que o diretrio foi aberto. Trs metodos so
     disponibilizados: read, rewind e close.
     <example>
      <title><function>dir</function> example</title>
      <programlisting role="php">
<![CDATA[
$d = dir("/etc");
echo "Handle: ".$d->handle."<br>\n";
echo "Path: ".$d->path."<br>\n";
while (false !== ($entry = $d->read())) {
    echo $entry."<br>\n";
}
$d->close();
]]>
      </programlisting>
     </example>
    </para>
    <note>
     <para>
      A ordem em que os diretrios so retornadas pelo metodo  dependente do
      sistema.
     </para>
    </note>
   </refsect1>
  </refentry>

  <refentry id="function.closedir">
   <refnamediv>
    <refname>closedir</refname>
    <refpurpose>fechar o handle do diretrio</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descrio</title>
     <methodsynopsis>
      <type>void</type><methodname>closedir</methodname>
      <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam>
     </methodsynopsis>
    <para>
     Fecha o stream do diretrio indicado por
     <parameter>dir_handle</parameter>. O stream deve ter sido previamente
     aberto por <function>opendir</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.getcwd">
   <refnamediv>
    <refname>getcwd</refname>
    <refpurpose>obter o diretrio atual</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descrio</title>
     <methodsynopsis>
      <type>string</type><methodname>getcwd</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Retorna o diretrio atual.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.opendir">
   <refnamediv>
    <refname>opendir</refname>
    <refpurpose>abrir o handle do diretrio</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descrio</title>
     <methodsynopsis>
      <type>resource</type><methodname>opendir</methodname>
      <methodparam><type>string</type><parameter>path</parameter></methodparam>
     </methodsynopsis>
    <para> 
     Retorna um handle de diretrio para ser usado em chamadas
     subsequentes a <function>closedir</function>,
     <function>readdir</function>, e <function>rewinddir</function>.
    </para>
    <para>
     Se o <parameter>path</parameter> no  um diretrio vlido ou
     o diretrio no pode ser aberto devido a restries das permisses
     ou erros no filesystem, <function>opendir</function> retorna
     &false; e gera um erro do PHP. Voc pode suprimir o erro na
     sada de <function>opendir</function> no seu script ao se
     inserir `@' na frente do nome da funo.
    </para>
    <para>
     <example>
      <title>exemplo de <function>opendir</function></title>
      <programlisting role="php">
<![CDATA[
<?php

if ($dir = @opendir("/tmp")) {
  while (($file = readdir($dir)) !== false) {
    echo "$file\n";
  }  
  closedir($dir);
}

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

  <refentry id="function.readdir">
   <refnamediv>
    <refname>readdir</refname>
    <refpurpose>ler os campos do handle do diretrio</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descrio</title>
     <methodsynopsis>
      <type>string</type><methodname>readdir</methodname>
      <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam>
     </methodsynopsis>
    <para>
     Retorna o nomedoarquivo do prcimo arquivo do diretrio. Os
     nomedoarquivos no sero retornados em alguma ordem particular.
     <example>
      <title>Lista todos os arquivos do diretrio atual</title>
      <programlisting role="php">
<![CDATA[
// Note que !== no existia at o PHP 4.0.0-RC2
<?php
$handle=opendir('.');
echo "Handle do diretrio: $handle\n";
echo "Arquivos:\n";
while (false !== ($file = readdir($handle))) { 
    echo "$file\n";
}
closedir($handle); 
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     Note que <function>readdir</function> ir retornar o <literal>.</literal>
     e <literal>..</literal> . Se voc no quer estes simplesmente os retire:
     <example>
      <title>
       Listar todos os arquivo no diretrio atual e retirar <literal>.</literal>
       e <literal>..</literal>
      </title>
      <programlisting role="php">
<![CDATA[
<?php 
$handle = opendir('.'); 
while (false !== ($file = readdir($handle))) { 
    if ($file != "." && $file != "..") { 
        echo "$file\n"; 
    } 
}
closedir($handle); 
?>
]]>
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.rewinddir">
   <refnamediv>
    <refname>rewinddir</refname>
    <refpurpose>voltar (rewind) o handle de diretrio</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descrio</title>
     <methodsynopsis>
      <type>void</type><methodname>rewinddir</methodname>
      <methodparam><type>resource</type><parameter>dir_handle</parameter></methodparam>
     </methodsynopsis>
    <para>
     Reinicia o stream do diretrio indicado por
     <parameter>dir_handle</parameter> para o incio do diretrio.
    </para>

   </refsect1>
  </refentry>

 </reference>

<!-- 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:"../../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
-->