Start · Sprachen · PHP · Referenz · tidy_get_config

tidy_get_config

Funktion

Gibt die aktuell aktive Konfiguration eines <code>tidy</code>-Objekts als assoziatives Array zurück.

seit PHP 5.0.0 Kategorie: string

Signatur

tidy_get_config(tidy $tidy): array

Beschreibung

tidy_get_config() liest alle Konfigurationsoptionen aus, die für eine gegebene tidy-Ressource oder -Instanz gesetzt sind, und gibt sie als assoziatives Array zurück. Dabei entsprechen die Schlüssel den Tidy-Optionsnamen (z. B. indent, wrap, output-xhtml) und die Werte den aktuell gültigen Einstellungen.

Die Funktion ist besonders hilfreich zur Fehlersuche und Inspektion: Man kann nach dem Parsen eines Dokuments oder nach dem Setzen von Optionen prüfen, welche Konfiguration tatsächlich aktiv ist – einschließlich aller Standardwerte, die nicht explizit gesetzt wurden.

tidy_get_config() ist die prozedurale Entsprechung zur Methode tidy::getConfig(). Beide geben dasselbe Array zurück. Die prozedurale Variante erwartet als ersten Parameter das tidy-Objekt.

Das zurückgegebene Array enthält sämtliche Tidy-Optionen, also auch jene, die nicht explizit konfiguriert wurden und deren Standardwert gelten. Dies ermöglicht einen vollständigen Überblick über das Verhalten der Bereinigung.

Parameter

Name Typ Default Beschreibung
$tidy Pflicht tidy Ein tidy-Objekt, dessen aktive Konfiguration abgefragt werden soll.

Rückgabewert

Typ
array
Beschreibung
Gibt ein assoziatives Array zurück, in dem die Schlüssel den Tidy-Optionsnamen entsprechen und die Werte die aktuell gültigen Einstellungen darstellen.

Beispiele

Konfiguration nach manuellem Setzen von Optionen ausgeben

<?php
$html = '<!DOCTYPE html><html><head><title>Test</title></head><body><p>Hallo Welt</p></body></html>';

$tidy = new tidy();
$tidy->parseString($html, [
    'indent'       => true,
    'output-xhtml' => true,
    'wrap'         => 200,
], 'utf8');

$config = tidy_get_config($tidy);

echo 'indent: '       . var_export($config['indent'], true)       . PHP_EOL;
echo 'output-xhtml: ' . var_export($config['output-xhtml'], true) . PHP_EOL;
echo 'wrap: '         . var_export($config['wrap'], true)         . PHP_EOL;
indent: true output-xhtml: true wrap: 200

Alle gesetzten Konfigurationswerte inspizieren

<?php
$tidy = tidy_parse_string(
    '<p>Beispiel</p>',
    ['indent' => true, 'wrap' => 80],
    'utf8'
);

$config = tidy_get_config($tidy);

foreach ($config as $option => $value) {
    echo $option . ' => ' . var_export($value, true) . PHP_EOL;
}

// Wichtig · Fallstricke

OOP-Äquivalent: Statt der prozeduralen Funktion kann auch die Methode tidy::getConfig() verwendet werden, was in modernem PHP-Code bevorzugt wird.

Tidy-Erweiterung: Die tidy-Erweiterung muss in der PHP-Installation aktiviert sein (üblicherweise extension=tidy in der php.ini). Auf vielen Shared-Hosting-Umgebungen ist sie standardmäßig nicht aktiv.

Das zurückgegebene Array enthält alle bekannten Tidy-Optionen inklusive ihrer Standardwerte – nicht nur jene, die explizit gesetzt wurden. Das Array kann daher sehr umfangreich sein.