Tidy tidy::getOptDoc
tidy_get_opt_doc
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
tidy::getOptDoc -- tidy_get_opt_doc — 주어진 옵션 이름에 대한 문서를 반환합니다.
설명
객체 지향 스타일
public tidy::getOptDoc(string $option
): string|false
절차적 스타일
tidy_get_opt_doc(tidy $tidy
, string $option
): string|false
Tidy_get_opt_doc()은 주어진 옵션 이름에 대한 문서를 반환합니다.
메모: 이 함수를 사용하려면 최소한 2005년 4월 25일 이후의 libtidy가 필요합니다.
매개변수
tidy
- Tidy 개체.
option
- 옵션 이름
반환 값
옵션이 존재하고 사용 가능한 문서가 있으면 문자열을 반환하고 그렇지 않으면 false
를 반환합니다.
Examples
예제 #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";
}
?>
기타
- tidy::getconfig() - 현재 깔끔한 구성 가져오기
- tidy::getopt() - tidy 문서에 대해 지정된 구성 옵션의 값을 반환합니다.