Lit un fichier dans un dossier

# streamWrapper::dir_readdir

(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)

streamWrapper::dir_readdir — Lit un fichier dans un dossier

### Description

public function streamWrapper::dir_readdir(): string|bool

Cette méthode est appelée en réponse à readdir().

### Liste de paramètres

Cette fonction ne contient aucun paramètre.

### Valeurs de retour

Doit retourner une chaîne de caractères représentant le prochain nom de fichier, ou `false` s'il n'y a pas d'autre fichier.

Avertissement

Renvoyer true ou false aura le même effet que de signaler qu'il n'y a pas de fichier suivant. Cependant, renvoyer true est déconseillé et false devrait être utilisé pour signaler cette condition à la place.

> Note:

> Une valeur non booléenne sera transtypée en string;.

### Erreurs / Exceptions

Émet une alerte `E_WARNING` si l'appel à cette méthode échoue (i.e. pas implémenté).

### Exemples

Exemple #1 Liste des fichiers d'une archive tar

    <?php
    class streamWrapper {
        protected $fp;

        public function dir_opendir($path, $options) {
            $url = parse_url($path);

            $path = $url["host"] . $url["path"];

            if (!is_readable($path)) {
                trigger_error("$path n'est pas lisible pour moi", E_USER_NOTICE);
                return false;
            }
            if (!is_file($path)) {
                trigger_error("$path n'est pas un fichier", E_USER_NOTICE);
                return false;
            }

            $this->fp = fopen($path, "rb");
            return true;
        }

        public function dir_readdir() {
            // Extrait l'en-tête de cette entrée
            $header      = fread($this->fp, 512);
            $data = unpack("a100filename/a8mode/a8uid/a8gid/a12size/a12mtime/a8checksum/a1filetype/a100link/a100linkedfile", $header);

            // Nettoie le nom de fichier et la taille
            $filename    = trim($data["filename"]);

            // Pas de fichier, nous sommes à la fin de l'archive
            if (!$filename) {
                return false;
            }

            $octal_bytes = trim($data["size"]);
            // La taille du fichier est définie en octets
            $bytes       = octdec($octal_bytes);

            // tar arrondit les tailles de fichiers au multiple de 512 suivant
            $rest        = $bytes % 512;
            if ($rest > 0) {
                $bytes      += 512 - $rest;
            }

            // Lecture du fichier
            fseek($this->fp, $bytes, SEEK_CUR);

            return $filename;
        }

        public function dir_closedir() {
            return fclose($this->fp);
        }

        public function dir_rewinddir() {
            return fseek($this->fp, 0, SEEK_SET);
        }
    }

    stream_wrapper_register("tar", "streamWrapper");
    $handle = opendir("tar://example.tar");
    while (false !== ($file = readdir($handle))) {
        var_dump($file);
    }

    echo "Remise au début..\n";
    rewind($handle);
    var_dump(readdir($handle));

    closedir($handle);
    ?>

Résultat de l'exemple ci-dessus est similaire à :

    string(13) "construct.xml"
    string(16) "dir-closedir.xml"
    string(15) "dir-opendir.xml"
    string(15) "dir-readdir.xml"
    string(17) "dir-rewinddir.xml"
    string(9) "mkdir.xml"
    string(10) "rename.xml"
    string(9) "rmdir.xml"
    string(15) "stream-cast.xml"
    string(16) "stream-close.xml"
    string(14) "stream-eof.xml"
    string(16) "stream-flush.xml"
    string(15) "stream-lock.xml"
    string(15) "stream-open.xml"
    string(15) "stream-read.xml"
    string(15) "stream-seek.xml"
    string(21) "stream-set-option.xml"
    string(15) "stream-stat.xml"
    string(15) "stream-tell.xml"
    string(16) "stream-write.xml"
    string(10) "unlink.xml"
    string(12) "url-stat.xml"
    Remise au début..
    string(13) "construct.xml"

### Voir aussi

- readdir() - Lit une entrée du dossier

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open