PHP | dir() (Obtener instancia del Directorio)

La función dir() en PHP utilizada para encontrar la instancia de una clase de Directorio. Esta función lee el directorio, que incluye lo siguiente:

• Se abre el directorio dado.
• Las dos propiedades handle y path de dir() están disponibles.
• La propiedad handle se puede usar con otras funciones de directorio como readdir(), rewinddir(), closedir(). La propiedad de ruta se establece en la ruta del directorio que se abrió
• Tanto las propiedades handle como path tienen tres métodos: read(), rewind() y close().

Sintaxis:

 dir(string $directory, resource $context)

Parámetros utilizados:
la función dir() acepta dos parámetros. Se ilustran de la siguiente manera:

1. $directorio: Es un parámetro requerido. Especifica el directorio a abrir.
2. $contexto: Es un parámetro opcional. Contiene referencias a todos los módulos del
   directorio que se pueden solicitar con una solicitud que coincida con la expresión regular.

Valor de retorno:
la función anterior devolverá una instancia de la clase Directorio en caso de éxito. De lo contrario, devolverá FALSO en caso de falla.

Nota:

1. El orden en que el método de lectura devuelve las entradas del directorio depende del sistema.
2. Esta función define el Directorio de clases internas, por lo que no podremos definir nuestras propias clases con ese nombre.

Ejemplo:
a continuación se muestra la implementación de la función explicada anteriormente:

<?php
   
// getcwd() function will return 
// the current working directory
$directory = dir(getcwd());
   
// Exploring directories and their contents
echo "Handle: " . $directory->handle . "\n";
echo "Path: " . $directory->path . "";
   
// If the evaluation is true then, the loop will
// continue otherwise any directory entry with name
// equals to FALSE will stop the loop .
while (($file = $directory->read()) !== false) {
       
    // printing Filesystem objects/functions with PHP
    echo "filename: " . $file . "\n";
}
$directory->close();
?>

Producción :

Handle: Resource id #3
Path: /storage/ssd2/630/2687630/public_html
filename: .
filename: ..
filename: bookkart
filename: index.php
filename: upload.html
filename: hello.html
filename: file-upload-manager.php
filename: tmp.php
filename: raj.php
filename: gfgchecking
filename: gfg.txt

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