quailGuideline Class Reference

Inherited by AllGuideline, Section508Guideline, Wcag1aaaGuideline, Wcag1aaGuideline, Wcag1aGuideline, Wcag2aaaGuideline, Wcag2aaGuideline, and Wcag2aGuideline.

List of all members.

Public Member Functions

 __construct (&$dom, &$css, &$path, $arg=null, $domain= 'en', $cms_mode=false)
 getTests ()
 loadTranslations ($domain)
 getTranslation ($testname)
 run ($arg=null, $language= 'en')
 getReport ()
 getSeverity ($testname)


Detailed Description

The base class for a guideline

Definition at line 599 of file quail.php.


Constructor & Destructor Documentation

quailGuideline::__construct ( &$  dom,
&$  css,
&$  path,
arg = null,
domain = 'en',
cms_mode = false 
)

The class constructor

Parameters:
object $dom The current DOMDocument object
object $css The current QuailCSS object
string $path The current path

Definition at line 644 of file quail.php.

References loadTranslations(), and run().


Member Function Documentation

quailGuideline::getReport (  ) 

Returns all the Report variable mixed Look to your report to see what it returns

Definition at line 715 of file quail.php.

quailGuideline::getSeverity ( testname  ) 

Returns the severity level of a given test

Parameters:
string $testname The name of the test
Returns:
int The severity level

Definition at line 724 of file quail.php.

quailGuideline::getTests (  ) 

Returns an array of all the tests associated with the current guideline

Returns:
array

Definition at line 657 of file quail.php.

quailGuideline::getTranslation ( testname  ) 

Returns the translation for a test name.

Parameters:
string $test The function name of the test

Definition at line 683 of file quail.php.

quailGuideline::loadTranslations ( domain  ) 

Loads translations from a file. This can be overriden, just as long as the local variable 'translations' is an associative array with test function names as the key

Definition at line 666 of file quail.php.

Referenced by __construct().

quailGuideline::run ( arg = null,
language = 'en' 
)

Iterates through each test string, makes a new test object, and runs it against the current DOM

Reimplemented in AllGuideline.

Definition at line 692 of file quail.php.

Referenced by __construct().


The documentation for this class was generated from the following file:

Generated on Sat Aug 21 08:55:12 2010 for QUAIL Accessibility Information library by  doxygen 1.5.7.1