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. More...

	validate ()
	Convenience function to perform standard validation. More...

Data Fields
	$name
	Name of the application this schema is describing. More...

	$directives = array()
	Array of Directive ID => array(directive info) More...

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

◆ addDirective()

HTMLPurifier_ConfigSchema_Interchange::addDirective ( $directive )

Adds a directive array to $directives.

Definition at line 24 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;
     }

◆ validate()

HTMLPurifier_ConfigSchema_Interchange::validate ( )

Convenience function to perform standard validation.

Throws exception on failed validation.

Definition at line 35 of file Interchange.php.

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

Field Documentation

◆ $directives

HTMLPurifier_ConfigSchema_Interchange::$directives = array()

Array of Directive ID => array(directive info)

Definition at line 19 of file Interchange.php.

◆ $name

HTMLPurifier_ConfigSchema_Interchange::$name

Name of the application this schema is describing.

Definition at line 14 of file Interchange.php.

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

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

Public Member Functions