HTMLPurifier 4.4.0
HTMLPurifier_ConfigSchema_Validator Class Reference

Performs validations on HTMLPurifier_ConfigSchema_Interchange. More...

List of all members.

Public Member Functions

 __construct ()
 validate ($interchange)
 Validates a fully-formed interchange object.
 validateId ($id)
 Validates a HTMLPurifier_ConfigSchema_Interchange_Id object.
 validateDirective ($d)
 Validates a HTMLPurifier_ConfigSchema_Interchange_Directive object.
 validateDirectiveAllowed ($d)
 Extra validation if $allowed member variable of HTMLPurifier_ConfigSchema_Interchange_Directive is defined.
 validateDirectiveValueAliases ($d)
 Extra validation if $valueAliases member variable of HTMLPurifier_ConfigSchema_Interchange_Directive is defined.
 validateDirectiveAliases ($d)
 Extra validation if $aliases member variable of HTMLPurifier_ConfigSchema_Interchange_Directive is defined.

Public Attributes

 $aliases

Protected Member Functions

 with ($obj, $member)
 Convenience function for generating HTMLPurifier_ConfigSchema_ValidatorAtom for validating simple member variables of objects.
 error ($target, $msg)
 Emits an error, providing helpful context.
 getFormattedContext ()
 Returns a formatted context string.

Protected Attributes

 $interchange
 Easy to access global objects.
 $context = array()
 Context-stack to provide easy to read error messages.
 $parser
 HTMLPurifier_VarParser to test default's type.

Detailed Description

Performs validations on HTMLPurifier_ConfigSchema_Interchange.

Note:
If you see '// handled by InterchangeBuilder', that means a design decision in that class would prevent this validation from ever being necessary. We have them anyway, however, for redundancy.

Definition at line 11 of file Validator.php.


Constructor & Destructor Documentation

HTMLPurifier_ConfigSchema_Validator::__construct ( )

Definition at line 29 of file Validator.php.


Member Function Documentation

HTMLPurifier_ConfigSchema_Validator::error ( target,
msg 
) [protected]

Emits an error, providing helpful context.

Definition at line 191 of file Validator.php.

References getFormattedContext().

Referenced by validate(), validateDirective(), validateDirectiveAliases(), validateDirectiveAllowed(), validateDirectiveValueAliases(), and validateId().

HTMLPurifier_ConfigSchema_Validator::getFormattedContext ( ) [protected]

Returns a formatted context string.

Definition at line 200 of file Validator.php.

Referenced by error(), and with().

HTMLPurifier_ConfigSchema_Validator::validate ( interchange)

Validates a fully-formed interchange object.

Throws an HTMLPurifier_ConfigSchema_Exception if there's a problem.

Definition at line 37 of file Validator.php.

References $interchange, error(), and validateDirective().

HTMLPurifier_ConfigSchema_Validator::validateDirectiveAliases ( d)

Extra validation if $aliases member variable of HTMLPurifier_ConfigSchema_Interchange_Directive is defined.

Definition at line 159 of file Validator.php.

References error(), validateId(), and with().

Referenced by validateDirective().

HTMLPurifier_ConfigSchema_Validator::validateDirectiveAllowed ( d)

Extra validation if $allowed member variable of HTMLPurifier_ConfigSchema_Interchange_Directive is defined.

Definition at line 112 of file Validator.php.

References error(), and with().

Referenced by validateDirective().

HTMLPurifier_ConfigSchema_Validator::validateDirectiveValueAliases ( d)

Extra validation if $valueAliases member variable of HTMLPurifier_ConfigSchema_Interchange_Directive is defined.

Definition at line 131 of file Validator.php.

References error(), and with().

Referenced by validateDirective().

HTMLPurifier_ConfigSchema_Validator::validateId ( id)

Validates a HTMLPurifier_ConfigSchema_Interchange_Id object.

Definition at line 53 of file Validator.php.

References error(), and with().

Referenced by validateDirective(), and validateDirectiveAliases().

HTMLPurifier_ConfigSchema_Validator::with ( obj,
member 
) [protected]

Convenience function for generating HTMLPurifier_ConfigSchema_ValidatorAtom for validating simple member variables of objects.

Definition at line 184 of file Validator.php.

References getFormattedContext().

Referenced by validateDirective(), validateDirectiveAliases(), validateDirectiveAllowed(), validateDirectiveValueAliases(), and validateId().


Member Data Documentation

HTMLPurifier_ConfigSchema_Validator::$aliases

Definition at line 17 of file Validator.php.

HTMLPurifier_ConfigSchema_Validator::$context = array() [protected]

Context-stack to provide easy to read error messages.

Definition at line 22 of file Validator.php.

HTMLPurifier_ConfigSchema_Validator::$interchange [protected]

Easy to access global objects.

Definition at line 17 of file Validator.php.

Referenced by validate().

HTMLPurifier_ConfigSchema_Validator::$parser [protected]

HTMLPurifier_VarParser to test default's type.

Definition at line 27 of file Validator.php.


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