tidy::getoptdoc
tidy_get_opt_doc
(PHP 5 >= 5.1.0)
tidy::getoptdoc -- tidy_get_opt_doc — بازگرداندن مستندات برای گزینه مشخص
Description
شیوه شی گرا
string tidy::getOptDoc
( string $optname
)
شیوه روالگرا
tidy_get_opt_doc() بازگرداندن مستندات برای نام گزینه داده شده.
Note:
شما حداقل نیاز به libtidy از 25 April، 2005 برای وجود این تابع دارید.
Return Values
بازگرداندن رشته اگر گزینه موجود باشد و مستندات در دسترس باشد یا در غیر این صورت FALSE.
Examples
Example #1 چاپ تمام گزینهها به همراه مستندات و مقادیر پیشفرض آنها
<?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";
}
?>
See Also
- tidy::getconfig() - دریافت تنظیمات فعلی Tidy
- tidy::getopt() - بازگرداندن مقدار گزینه تنظیمات برای سند tidy
There are no user contributed notes for this page.
