mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
2fd3f0c96d
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297078 c90b9560-bf6c-de11-be94-00142212c4b1
118 lines
2.8 KiB
XML
118 lines
2.8 KiB
XML
<?xml version='1.0' encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.tidy-access-count" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>tidy_access_count</refname>
|
|
<refpurpose>Returns the Number of Tidy accessibility warnings encountered for specified document</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>tidy_access_count</methodname>
|
|
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>tidy_access_count</function> returns the number of
|
|
accessibility warnings found for the specified document.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>object</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
&tidy.object;
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the number of warnings.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>tidy_access_count</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$html ='<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
|
|
<html><head><title>Title</title></head>
|
|
<body>
|
|
|
|
<p><img src="img.png"></p>
|
|
|
|
</body></html>';
|
|
|
|
|
|
// select the accessibility check level: 1, 2 or 3
|
|
$config = array('accessibility-check' => 3);
|
|
|
|
$tidy = new tidy();
|
|
$tidy->parseString($html, $config);
|
|
$tidy->cleanRepair();
|
|
|
|
/* Never forget to call this! */
|
|
$tidy->diagnose();
|
|
|
|
echo tidy_access_count($tidy); //5
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
Due to the design of the TidyLib, you must call
|
|
<function>tidy_diagnose</function> before
|
|
<function>tidy_access_count</function> or it will return always
|
|
<literal>0</literal>. You must also need to enable the
|
|
<literal>accessibility-check</literal> option.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>tidy_error_count</function></member>
|
|
<member><function>tidy_warning_count</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|