Verzeichnisbaum-Generator 🚀: Mit einem PHP-Skript die Verzeichnisse auflisten und analysieren

Zurück zur Übersicht…

Die Erstellung einer detaillierten Übersicht der Ordnerstruktur ist für Entwickler oft ein praktisches Werkzeug, besonders wenn man die Größe und den Inhalt von Verzeichnissen analysieren möchte. In diesem Artikel zeigen wir dir, wie du ein PHP-Skript nutzt, um eine Ordnerstruktur (Verzeichnisbaum-Generator) zu erstellen, die Verzeichnisse und Dateien zu analysieren und die Ergebnisse in einer Datei zu speichern. Dieses Skript bietet eine einfache Lösung, um Verzeichnisse mit oder ohne Dateiinformationen zu dokumentieren und die gesamte Größe der Dateien zu berechnen.

Wie funktioniert das PHP-Skript zur Erstellung der Ordnerstruktur?

Das PHP-Skript erstellt eine Baumstruktur aller Verzeichnisse und Dateien in einem Basisverzeichnis. Es ermöglicht es, gezielt nur Verzeichnisse aufzulisten oder zusätzlich detaillierte Dateiinformationen wie Größe und Anzahl der Dateien hinzuzufügen. Darüber hinaus wird die Gesamtgröße aller Dateien im Verzeichnisbaum berechnet und gespeichert.

Das Skript ermöglicht dir folgende Optionen:

Nur Verzeichnisse auflisten: Über die URL-Parameter kannst du angeben, dass nur die Verzeichnisse ohne Dateiinformationen aufgelistet werden sollen.
Include/Exclude Vendor-Verzeichnisse: Das Skript unterstützt die Option, das vendor-Verzeichnis (häufig in PHP-Projekten vorhanden) zu ignorieren, was besonders bei der Arbeit mit Composer hilfreich ist.

Installation und Einrichtung

PHP-Skript herunterladen und einrichten
Wenn du das PHP-Skript nutzen möchtest, lade es auf deinen Webserver oder lokal herunter.
Achte darauf, dass du den Basisordner ($baseDir = __DIR__.'/../';) nach deinen Bedürfnissen anpasst – es kann entweder das aktuelle Verzeichnis oder ein übergeordnetes Verzeichnis sein.
Parameter über URL übergeben
Das Skript unterstützt folgende URL-Parameter:
-onlyDirs=1: Listet nur Verzeichnisse auf, ohne Informationen zu den Dateien.
-includeVendor=1: Bezieht das vendor-Verzeichnis in die Liste ein, standardmäßig wird es ausgeschlossen.

Beispiel für die URL:
yourdomain.com/script.php?onlyDirs=1&includeVendor=1
Ausgabe in eine Datei speichern
Das Skript speichert die resultierende Ordnerstruktur in einer Textdatei. Du kannst das Ausgabeverzeichnis nach Wunsch anpassen, zum Beispiel folders.txt im Basisverzeichnis.
Ergebnisse anzeigen
Nachdem das Skript ausgeführt wurde, wird die Ordnerstruktur in einer Textdatei gespeichert und eine Übersicht auf dem Bildschirm angezeigt. Die Anzeige umfasst:
– Gesamtzahl der Verzeichnisse und Dateien
– Gesamtgröße der Dateien im Verzeichnisbaum

Beispiel für den Ordnerbaum 📁

Die Ausgabe der Ordnerstruktur zeigt Verzeichnisse mit einem 📁-Symbol und Dateien mit einem 🗎-Symbol. Wenn onlyDirs=1 gesetzt ist, werden nur die Verzeichnisse ohne Dateiinformationen angezeigt.

Mit Dateiinformationen (Standard):

Copy to Clipboard

Nur Verzeichnisse (mit onlyDirs=1):

Copy to Clipboard

Quellcode

Copy to Clipboard

<?php

/*
 * MIT License
 *
 * Copyright (c) 2025 Johannes Teitge, johannes@teitge.de, teitge.de
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

// Hier Benutzername und Passwort festlegen
define('USERNAME', 'admin');
define('PASSWORD', 'password123');

// Authentifizierung prüfen
if (!isset($_SERVER['PHP_AUTH_USER']) || $_SERVER['PHP_AUTH_USER'] !== USERNAME || $_SERVER['PHP_AUTH_PW'] !== PASSWORD) {
    // Wenn Authentifizierung fehlschlägt, Aufforderung zur Eingabe von Benutzerdaten
    header('HTTP/1.1 401 Unauthorized');
    header('WWW-Authenticate: Basic realm="Restricted Area"');
    echo 'Zugriff verweigert. Bitte geben Sie Ihren Benutzernamen und Passwort ein.';
    exit;
}

// Abfrage der URL-Parameter, mit Standardwerten falls nicht gesetzt
$onlyDirs = isset($_GET['onlyDirs']) ? (bool) $_GET['onlyDirs'] : false;  // Bestimmt, ob nur Verzeichnisse angezeigt werden sollen
$includeVendor = isset($_GET['includeVendor']) ? (bool) $_GET['includeVendor'] : false;  // Bestimmt, ob das "vendor"-Verzeichnis eingeschlossen wird

// Basisverzeichnis der Anwendung (Verzeichnis über dem aktuellen Skript)
$baseDir = __DIR__.'/../'; // Hier kann das Basisverzeichnis angepasst werden
$outputFile = $baseDir . 'folders_' . date('Y-m-d_H-i-s') . '.txt'; // Pfad zur Ausgabedatei

/* Alternativ im aktuellen Verzeichnis speichern:
$baseDir = __DIR__; // Basisverzeichnis im aktuellen Verzeichnis
$outputFile = $baseDir . '/folders.txt'; // Ausgabe im aktuellen Verzeichnis
*/

// Klasse zur Erzeugung der Ordnerstruktur und Berechnung der Verzeichnisgrößen
class TreeGenerator
{
    /**
     * Erzeugt die Ordnerstruktur als Text mit Datei- und Verzeichnisinfos.
     * 
     * @param string $baseDir Das Basisverzeichnis, das durchsucht werden soll.
     * @param bool $onlyDirs Wenn true, werden nur Verzeichnisse angezeigt.
     * @param bool $includeVendor Wenn true, wird das "vendor"-Verzeichnis eingeschlossen.
     * @return string Die generierte Ordnerstruktur als Text.
     */
    public static function createDokuFileTree(string $baseDir, bool $onlyDirs = false, bool $includeVendor = false): string
    {
        // Generiert die vollständige Ordnerstruktur mit den angegebenen Parametern
        $tree = self::generateTree($baseDir, $onlyDirs, '', '', true, $includeVendor);
        return $tree;
    }

/**
     * Berechnet die Gesamtgröße aller Dateien im angegebenen Verzeichnis.
     * 
     * @param string $baseDir Das Basisverzeichnis, dessen Größe berechnet werden soll.
     * @param bool $onlyDirs Wenn true, werden nur Verzeichnisse berücksichtigt.
     * @param bool $includeVendor Wenn true, wird das "vendor"-Verzeichnis eingeschlossen.
     * @return int Die Gesamtgröße aller Dateien in Byte.
     */
    public static function getTotalSizeAllFiles(string $baseDir, bool $onlyDirs = false, bool $includeVendor = false): int
    {
        return self::calculateDirSize($baseDir, $onlyDirs, $includeVendor)[0];  // Rückgabe der Gesamtgröße
    }

/**
     * Generiert die Ordnerstruktur rekursiv als Baumdarstellung.
     * 
     * @param string $directory Das Verzeichnis, das durchsucht wird.
     * @param bool $onlyDirs Wenn true, werden nur Verzeichnisse berücksichtigt.
     * @param string $prefix Präfix für die Ausgabezeile, um die Baumstruktur darzustellen.
     * @param string $childPrefix Präfix für die Kindverzeichnisse.
     * @param bool $isMainFolder Wenn true, handelt es sich um das Hauptverzeichnis.
     * @param bool $includeVendor Wenn true, wird das "vendor"-Verzeichnis eingeschlossen.
     * @return string Die generierte Baumstruktur als Text.
     */
    private static function generateTree(string $directory, bool $onlyDirs, string $prefix = '', string $childPrefix = '', bool $isMainFolder = true, bool $includeVendor = false): string
    {
        $tree = '';  // Variable zur Speicherung der Baumstruktur
        $items = array_diff(scandir($directory), ['.', '..']);  // Verzeichnisse und Dateien im aktuellen Verzeichnis
        $itemCount = count($items);  // Anzahl der Elemente im Verzeichnis
        $index = 0;  // Zähler für die Schleife
        $totalFileSizeAtThisLevel = 0;  // Gesamtgröße für das aktuelle Verzeichnis
        $totalFileCountAtThisLevel = 0;  // Anzahl der Dateien auf dieser Ebene
        $totalSizeAllFiles = 0;  // Gesamtgröße aller Dateien im gesamten Verzeichnisbaum

// Durchlaufe jedes Element im Verzeichnis
        foreach ($items as $item) {
            $index++;
            $path = $directory . DIRECTORY_SEPARATOR . $item;  // Voller Pfad zum Element
            $isLast = $index === $itemCount;  // Bestimmt, ob es sich um das letzte Element handelt

// Bestimmung der Baumstruktur-Zeichen für das aktuelle Element
            $line = $isLast ? '└── ' : '├── ';
            $newPrefix = $isLast ? $childPrefix . '    ' : $childPrefix . '│   ';

// Überprüfe, ob es sich um ein Verzeichnis handelt
            if (is_dir($path)) {
                if ($item === 'vendor' && !$includeVendor) {
                    // Wenn das Verzeichnis "vendor" ist und nicht eingeschlossen werden soll
                    $tree .= $prefix . $line . '📁 ' . $item . PHP_EOL;
                } else {
                    // Rekursive Generierung der Unterverzeichnisse
                    $dirTree = self::generateTree($path, $onlyDirs, $newPrefix, $newPrefix, false, $includeVendor);
                    list($dirSize, $dirFileCount) = self::calculateDirSize($path, $onlyDirs, $includeVendor);

// Wenn nur Verzeichnisse angezeigt werden, ohne Dateigrößen
                    if ($onlyDirs) {
                        $tree .= $prefix . $line . '📁 ' . $item . PHP_EOL;
                    } else {
                        // Zeige auch Dateigröße und Anzahl der Dateien
                        $dirSizeMb = round($dirSize / 1024 / 1024, 2);  // Umrechnung in MB
                        $dirSizeKb = round($dirSize / 1024, 2);  // Umrechnung in KB
                        $tree .= $prefix . $line . '📁 ' . $item . ' (' . $dirFileCount . ' Files, ' . $dirSizeKb . ' KB)' . PHP_EOL;
                    }

// Gesamtgröße und Dateianzahl für das aktuelle Verzeichnis
                    $totalFileSizeAtThisLevel += $dirSize;
                    $totalFileCountAtThisLevel += $dirFileCount;
                    $totalSizeAllFiles += $dirSize;
                }
            } elseif (!$onlyDirs) {
                // Für Dateien, wenn `onlyDirs` nicht gesetzt ist
                $fileSize = filesize($path);  // Berechne die Dateigröße
                $fileSizeKb = round($fileSize / 1024, 2);  // Umrechnung in KB

// Datei mit ihrer Größe zur Baumstruktur hinzufügen
                $tree .= $prefix . $line . '🗎 ' . $item . ' (' . $fileSizeKb . ' KB)' . PHP_EOL;
                $totalFileSizeAtThisLevel += $fileSize;
                $totalFileCountAtThisLevel++;
                $totalSizeAllFiles += $fileSize;
            }
        }

return $tree;
    }

/**
     * Berechnet die Größe eines Verzeichnisses und die Anzahl der darin enthaltenen Dateien.
     * 
     * @param string $directory Das Verzeichnis, dessen Größe berechnet wird.
     * @param bool $onlyDirs Wenn true, werden nur Verzeichnisse berücksichtigt.
     * @param bool $includeVendor Wenn true, wird das "vendor"-Verzeichnis eingeschlossen.
     * @return array Ein Array, das die Gesamtgröße des Verzeichnisses und die Anzahl der Dateien enthält.
     */
    private static function calculateDirSize(string $directory, bool $onlyDirs, bool $includeVendor): array
    {
        $dirSize = 0;  // Gesamtgröße des Verzeichnisses
        $fileCount = 0;  // Anzahl der Dateien im Verzeichnis
        $items = array_diff(scandir($directory), ['.', '..']);  // Alle Elemente im Verzeichnis

foreach ($items as $item) {
            $path = $directory . DIRECTORY_SEPARATOR . $item;
            if (is_dir($path)) {
                // Rekursiv die Größe von Unterverzeichnissen berechnen
                if ($item !== 'vendor' || $includeVendor) {
                    list($subDirSize, $subDirCount) = self::calculateDirSize($path, $onlyDirs, $includeVendor);
                    $dirSize += $subDirSize;
                    $fileCount += $subDirCount;
                }
            } elseif (!$onlyDirs) {
                // Berechne die Größe von Dateien
                $fileSize = filesize($path);
                $dirSize += $fileSize;
                $fileCount++;
            }
        }
        return [$dirSize, $fileCount];  // Rückgabe der Größe und der Anzahl der Dateien
    }
}

if (!is_dir($baseDir)) {
    die("Fehler: Das angegebene Verzeichnis '$baseDir' existiert nicht oder ist nicht zugänglich.");
}

// Header mit Basisverzeichnis
$header = "Folder/File Dokumentation für Verzeichnis: $baseDir\n";
$header .= "=====================================================\n\n";

// Generiere die Ordnerstruktur
$folderTree = TreeGenerator::createDokuFileTree($baseDir, $onlyDirs, $includeVendor);

// Zähle Verzeichnisse und Dateien
$dirsCount = substr_count($folderTree, '📁');  // Anzahl der Verzeichnisse
$filesCount = substr_count($folderTree, '🗎'); // Anzahl der Dateien

// Berechne die Gesamtgröße der Dateien, wenn `onlyDirs` nicht gesetzt ist
if (!$onlyDirs) {
    $totalSizeAllFiles = TreeGenerator::getTotalSizeAllFiles($baseDir, false, false);
    $totalSizeMb = round($totalSizeAllFiles / 1024 / 1024, 2);  // Gesamtgröße in MB
    $totalSizeGb = round($totalSizeAllFiles / 1024 / 1024 / 1024, 2);  // Gesamtgröße in GB

// Footer mit Dateiinfos
    $footer = PHP_EOL . "Erstellt am " . date('Y-m-d H:i:s') . PHP_EOL . 
        "Verzeichnisse: $dirsCount, Dateien: $filesCount, Gesamtgröße der Dateien: $totalSizeMb MB ($totalSizeGb GB)" . PHP_EOL;
} else {
    // Footer ohne Dateiinfos
    $footer = PHP_EOL . "Erstellt am " . date('Y-m-d H:i:s') . PHP_EOL . 
        "Verzeichnisse: $dirsCount" . PHP_EOL;
}

// Schreibe Header, Ordnerstruktur und Footer in die Ausgabedatei
file_put_contents($outputFile, $header . $folderTree . $footer);

// Anzeige auf der Seite, je nach `onlyDirs`
if ($onlyDirs) {
 echo "Die Ordnerstruktur wurde in '$outputFile' gespeichert. Es wurden $dirsCount Verzeichnisse gefunden.";
} else {
 echo "Die Ordnerstruktur wurde in '$outputFile' gespeichert. Es wurden $dirsCount Verzeichnisse und $filesCount Dateien gefunden. Gesamtgröße der Dateien: $totalSizeMb MB ($totalSizeGb GB).";
}

Fazit 🏁

Das PHP-Skript bietet eine schnelle und einfache Lösung, um die Ordnerstruktur eines Verzeichnisses zu erstellen und zu dokumentieren. Besonders nützlich ist es für Entwickler, die regelmäßig mit großen Projekten arbeiten und eine genaue Übersicht über ihre Verzeichnisstruktur und Dateigrößen benötigen. Die Möglichkeit, nur Verzeichnisse ohne Dateiinformationen zu listen oder das vendor-Verzeichnis auszuschließen, macht das Skript flexibel und anpassbar.

Ob du nun eine einfache Dokumentation für dein Projekt erstellen möchtest oder die Größe und Anzahl der Dateien in einem Verzeichnis analysieren musst – dieses PHP-Skript ist ein praktisches Tool, das dir dabei hilft, diese Aufgaben schnell und effizient zu erledigen. 😊

Ich hoffe, dieses Tutorial hat dir geholfen, die automatische Dokumentation deiner Ordnerstruktur ganz einfach zu erstellen! Jetzt kannst du die Übersichtlichkeit und die Dateiinformationen deines Projekts problemlos auf einen Blick einsehen. Viel Spaß beim Ausprobieren und Anpassen des Verzeichnisbaum-Generators! 🚀

Download “Verzeichnisbaum-Generator” doku_createtree.zip – 566-mal heruntergeladen – 3,68 kB

Last Updated: 2. Februar 2025By johannesTags: Espresso, Kaffee, Lelith Bianca, Magensiumcitrat, Magnesium, Magnesiumoxid

Verzeichnisbaum-Generator 🚀: Mit einem PHP-Skript die Verzeichnisse auflisten und analysieren

Verzeichnisbaum-Generator 🚀: Mit einem PHP-Skript die Verzeichnisse auflisten und analysieren

Zurück zur Übersicht…

Wie funktioniert das PHP-Skript zur Erstellung der Ordnerstruktur?

Installation und Einrichtung

Beispiel für den Ordnerbaum 📁

Quellcode

Fazit 🏁

Leave A Comment Antworten abbrechen

Was dir noch gefallen könnte

Fernwartung mit Zwei Monitoren: Gratis mit Chrome Remote Desktop und AnyViewer

Ratz Fatz Mailer – ein Kontaktformular auf die Schnelle 🚀

Doppelten Mailversand in Formidable Forms verhindern

Lebe kreativ, denke positiv und genieße die kleinen Dinge

Menü

Aktuelles

🔧 JsonSQL Update – April 2025

JsonSQL

Skype ist Geschichte – welche Alternativen jetzt wirklich überzeugen

Social Links