tidy_get_opt_doc — Funktion · PHP-Referenz

Signatur

tidy_get_opt_doc(tidy $tidy, string $optname): string|false

Beschreibung

tidy_get_opt_doc() liefert die interne Dokumentation der Tidy-Bibliothek für eine bestimmte Konfigurationsoption. Dies ermöglicht es, zur Laufzeit zu erfahren, was eine bestimmte Option bewirkt, ohne externe Dokumentation nachschlagen zu müssen.

Die Funktion ist besonders nützlich, wenn man ein Benutzerinterface oder ein Diagnose-Werkzeug baut, das dynamisch alle verfügbaren Tidy-Optionen und ihre Bedeutungen anzeigen soll. In Kombination mit tidy_get_config() lässt sich so eine vollständige, selbst dokumentierende Konfigurationsübersicht erstellen.

Die Dokumentation stammt direkt aus der zugrundeliegenden libtidy und ist auf Englisch. Die Funktion gibt false zurück, wenn der angegebene Optionsname nicht existiert oder keine Dokumentation vorhanden ist.

Parameter

Name	Typ	Default	Beschreibung
$tidy Pflicht	tidy		Eine gültige `tidy`-Instanz, die zuvor z. B. mit `new tidy()` erstellt wurde.
$optname Pflicht	string		Der Name der Tidy-Option, deren Dokumentation abgerufen werden soll, z. B. `'indent'`, `'wrap'` oder `'output-xhtml'`.

Rückgabewert

Typ

string|false

Beschreibung

Gibt die Dokumentation der Option als Zeichenkette zurück. Falls die Option nicht existiert oder keine Dokumentation verfügbar ist, wird false zurückgegeben.

Beispiele

Dokumentation einer einzelnen Tidy-Option abrufen

<?php
$tidy = new tidy();

$optName = 'indent';
$doc = tidy_get_opt_doc($tidy, $optName);

if ($doc !== false) {
    echo "Dokumentation für Option '$optName':\n";
    echo $doc . "\n";
} else {
    echo "Keine Dokumentation für Option '$optName' gefunden.\n";
}

Dokumentation für Option 'indent': This option specifies if Tidy should indent block-level tags. If set to auto, this option causes Tidy to decide whether or not to indent the content of tags such as TITLE, H1-H6, LI, TD, TD, or P depending on whether or not the content includes a block-level element. You are advised to avoid setting indent to yes as this can expose bugs in older browsers. See also indent-spaces, indent-attributes and wrap.

Alle bekannten Optionen mit Dokumentation auflisten

<?php
$tidy = new tidy();

// Aktuelle Konfiguration abrufen, um alle Optionsnamen zu erhalten
$config = tidy_get_config($tidy);

foreach (array_keys($config) as $optName) {
    $doc = tidy_get_opt_doc($tidy, $optName);
    if ($doc !== false) {
        echo "<strong>$optName</strong>: $doc\n\n";
    }
}

// Wichtig · Fallstricke

Verfügbarkeit: tidy_get_opt_doc() steht nur zur Verfügung, wenn PHP mit einer ausreichend aktuellen Version der libtidy kompiliert wurde. Ältere Versionen der libtidy unterstützen diese Funktion möglicherweise nicht, weshalb sie in manchen Umgebungen nicht vorhanden ist.

Die prozedurale Form tidy_get_opt_doc($tidy, $optname) und die objektorientierte Methode existieren beide; in der OOP-Variante lautet der Aufruf $tidy->getOptDoc($optname).

Die zurückgegebene Dokumentation ist stets auf Englisch, da sie direkt aus der libtidy-Bibliothek stammt.

Siehe auch

tidy_get_config tidy_get_opt tidy_get_option_by_id tidy_get_options