array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'uk', ), 'this' => array ( 0 => 'tidy.getoptdoc.php', 1 => 'tidy::getOptDoc', 2 => 'Returns the documentation for the given option name', ), 'up' => array ( 0 => 'class.tidy.php', 1 => 'tidy', ), 'prev' => array ( 0 => 'tidy.getopt.php', 1 => 'tidy::getOpt', ), 'next' => array ( 0 => 'tidy.getrelease.php', 1 => 'tidy::getRelease', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/tidy/tidy/getoptdoc.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

tidy::getOptDoc

tidy_get_opt_doc

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

tidy::getOptDoc -- tidy_get_opt_doc — Returns the documentation for the given option name

Опис

Об'єктно-орієнтований стиль

public tidy::getOptDoc(string $option): string|false

Процедурний стиль

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

tidy_get_opt_doc() returns the documentation for the given option name.

Зауваження:

You need at least libtidy from 25 April, 2005 for this function be available.

Параметри

tidy

Об'єкт Tidy.

option

The option name

Значення, що повертаються

Returns a string if the option exists and has documentation available, or false otherwise.

Приклади

Приклад #1 Print all options along with their documentation and default value

<?php

$tidy = new tidy;
$config = $tidy->getConfig();

ksort($config);

foreach ($config as $opt => $val) {

if (!$doc = $tidy->getOptDoc($opt))
$doc = 'no documentation available!';

$val = ($tidy->getOpt($opt) === true) ? 'true' : $val;
$val = ($tidy->getOpt($opt) === false) ? 'false' : $val;

echo "<p><b>$opt</b> (default: '$val')<br />".
"$doc</p><hr />\n";
}

?>

Прогляньте також