HTMLPurifier_ConfigSchema_Interchange Class Reference

Generic schema interchange format that can be converted to a runtime representation (HTMLPurifier_ConfigSchema) or HTML documentation. More...

Collaboration diagram for HTMLPurifier_ConfigSchema_Interchange:

Public Member Functions
	addDirective ($directive)
	Adds a directive array to $directives.
	validate ()
	Convenience function to perform standard validation.

Data Fields
	$name
	Name of the application this schema is describing.
	$directives = array()
	Array of Directive ID => array(directive info) HTMLPurifier_ConfigSchema_Interchange_Directive[].

Detailed Description

Generic schema interchange format that can be converted to a runtime representation (HTMLPurifier_ConfigSchema) or HTML documentation.

Members are completely validated.

Definition at line 8 of file Interchange.php.

Member Function Documentation

HTMLPurifier_ConfigSchema_Interchange::addDirective

(

$directive

)

Adds a directive array to $directives.

Parameters

HTMLPurifier_ConfigSchema_Interchange_Directive

$directive

Exceptions

HTMLPurifier_ConfigSchema_Exception

Definition at line 28 of file Interchange.php.

    {
        if (isset($this->directives[$i = $directive->id->toString()])) {
            throw new HTMLPurifier_ConfigSchema_Exception("Cannot redefine directive '$i'");
        }
        $this->directives[$i] = $directive;
    }

HTMLPurifier_ConfigSchema_Interchange::validate

(

)

Convenience function to perform standard validation.

Throws exception on failed validation.

Definition at line 40 of file Interchange.php.

    {
        $validator = new HTMLPurifier_ConfigSchema_Validator();
        return $validator->validate($this);
    }

Field Documentation

HTMLPurifier_ConfigSchema_Interchange::$directives = array()

Array of Directive ID => array(directive info) HTMLPurifier_ConfigSchema_Interchange_Directive[].

Definition at line 21 of file Interchange.php.

HTMLPurifier_ConfigSchema_Interchange::$name

Name of the application this schema is describing.

string

Definition at line 15 of file Interchange.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/ConfigSchema/Interchange.php