Signatur
Beschreibung
tidy_getopt() liest den aktuellen Wert einer bestimmten Konfigurationsoption aus einem Tidy-Dokument-Objekt aus. Die Tidy-Bibliothek bietet eine Vielzahl von Optionen, die das Verhalten beim Parsen und Ausgeben von HTML/XML steuern – etwa indent, wrap, output-xhtml oder char-encoding.
Der Rückgabewert hängt vom Typ der angefragten Option ab: Boolesche Optionen liefern true oder false, numerische Optionen liefern eine Ganzzahl und Zeichenketten-Optionen liefern einen String. Ist die Option unbekannt, wird false zurückgegeben.
Die Funktion ist besonders nützlich, um nach dem Laden einer Konfigurationsdatei oder dem Setzen von Optionen deren tatsächliche Werte zu überprüfen. Sie arbeitet als prozedurale Entsprechung zur Methode tidy::getOpt().
Parameter
| Name | Typ | Default | Beschreibung |
|---|---|---|---|
| $tidy Pflicht | tidy | Das Tidy-Dokument-Objekt, aus dem die Option gelesen werden soll. | |
| $option Pflicht | string | Der Name der Tidy-Konfigurationsoption, z. B. 'indent', 'wrap' oder 'output-xhtml'. |
Rückgabewert
bool, ein int oder ein string sein. Ist die Option unbekannt, wird false zurückgegeben.Beispiele
Tidy-Optionswert auslesen
<?php
$html = '<!DOCTYPE html><html><body><p>Hallo Welt</p></body></html>';
$config = [
'indent' => true,
'wrap' => 80,
'output-xhtml' => true,
];
$tidy = tidy_parse_string($html, $config, 'UTF8');
$indent = tidy_getopt($tidy, 'indent');
$wrap = tidy_getopt($tidy, 'wrap');
$xhtml = tidy_getopt($tidy, 'output-xhtml');
var_dump($indent); // bool(true)
var_dump($wrap); // int(80)
var_dump($xhtml); // bool(true)
Unbekannte Option abfragen
<?php
$html = '<html><body><p>Test</p></body></html>';
$tidy = tidy_parse_string($html, [], 'UTF8');
$wert = tidy_getopt($tidy, 'nicht-existierende-option');
var_dump($wert);
OOP-Stil mit tidy::getOpt()
<?php
$html = '<html><body><h1>Titel</h1></body></html>';
$tidy = new tidy();
$tidy->parseString($html, ['char-encoding' => 'utf8', 'indent' => false], 'UTF8');
// Prozeduraler Aufruf
$encoding = tidy_getopt($tidy, 'char-encoding');
echo 'Zeichenkodierung: ' . $encoding . PHP_EOL;
// Äquivalenter OOP-Aufruf
echo 'Zeichenkodierung (OOP): ' . $tidy->getOpt('char-encoding') . PHP_EOL;
// Wichtig · Fallstricke
Die Tidy-Erweiterung muss beim Kompilieren von PHP aktiviert worden sein (--with-tidy) oder als Extension geladen sein. Steht Tidy nicht zur Verfügung, wird ein fataler Fehler ausgelöst.
Die gültige Liste der Optionsnamen entspricht der offiziellen Tidy-Konfigurationsreferenz. Groß-/Kleinschreibung wird bei Optionsnamen in der Regel ignoriert, zur Klarheit empfiehlt sich jedoch die Verwendung der offiziellen Schreibweise mit Bindestrichen.