PHP | Función dir()

La función dir() en PHP es una función incorporada que se usa para devolver una instancia de la clase Directory. La función dir() se usa para leer un directorio, que incluye lo siguiente:

1. Se abre el directorio dado.
2. Las dos propiedades handle y path de dir() están disponibles.
3. Tanto las propiedades handle como path tienen tres métodos: read(), rewind() y close().

La ruta del directorio se envía como parámetro a la función opendir() y devuelve una instancia de la clase Directory en caso de éxito o FALSE en caso de falla.

Sintaxis:

dir($directory, $context)

Parámetros utilizados: la función dir() en PHP acepta dos parámetros como se describe a continuación.

• $directorio : es un parámetro obligatorio que especifica la ruta del directorio.
• $context : es un parámetro opcional que especifica el comportamiento de la transmisión.

Valor de retorno: Devuelve una instancia de la clase Directorio en caso de éxito o FALSO en caso de error.

Errores y excepciones :

1. Se devuelve un valor NULL si dir() se pasa con parámetros incorrectos.
2. El orden en que el método de lectura devuelve las entradas del directorio depende del sistema.

Los siguientes programas ilustran la función dir():

Programa 1:

<?php
  
$dir_handle = dir("user/gfg");
  
while(($file_name = $dirhandle->read()) !== false) 
{ 
    echo("File Name : " . $file_name);
    echo "<br>" ; 
}
  
?>

Producción:

File Name: gfg.jpg
File Name: ..
File Name: gfg.pdf
File Name: .
File Name: gfg.txt

Programa 2:

<?php
  
$dir_handle = dir("user/gfg");
  
echo("Directory Path: " . $dir_handle->path . "<br>");
  
echo("Directory Handler ID: " . $dir_handle->handle . "<br>");
  
while(($file_name = $dir_handle->read()) !== false) 
{ 
   echo("File Name: " . $file_name);
   echo "<br>" ; 
} 
  
$dir_handle->close();
  
?>

Producción:

Directory Path: user/gfg
Directory Handler ID: Resource id #2

File Name: gfg.jpg
File Name: ..
File Name: gfg.pdf
File Name: .
File Name: gfg.txt

Referencia: http://php.net/manual/en/function.dir.php