HTMLPurifier_ConfigSchema_Validator Class Reference

Performs validations on HTMLPurifier_ConfigSchema_Interchange. More...

Collaboration diagram for HTMLPurifier_ConfigSchema_Validator:

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

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

Protected Attributes
	$interchange
	HTMLPurifier_ConfigSchema_Interchange More...
	$aliases
	array More...
	$context = array()
	Context-stack to provide easy to read error messages. More...
	$parser
	to test default's type. More...

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

__construct()

HTMLPurifier_ConfigSchema_Validator::__construct

(

)

Definition at line 36 of file Validator.php.

    {
        $this->parser = new HTMLPurifier_VarParser();
    }

Member Function Documentation

error()

HTMLPurifier_ConfigSchema_Validator::error (   $target,   $msg  )

protected

Emits an error, providing helpful context.

Exceptions

HTMLPurifier_ConfigSchema_Exception

Definition at line 228 of file Validator.php.

References getFormattedContext().

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

    {
        if ($target !== false) {
            $prefix = ucfirst($target) . ' in ' . $this->getFormattedContext();
        } else {
            $prefix = ucfirst($this->getFormattedContext());
        }
        throw new HTMLPurifier_ConfigSchema_Exception(trim($prefix . ' ' . $msg));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFormattedContext()

HTMLPurifier_ConfigSchema_Validator::getFormattedContext ( )

protected

Returns a formatted context string.

Returns

string

Definition at line 242 of file Validator.php.

Referenced by error(), and with().

    {
        return implode(' in ', array_reverse($this->context));
    }

Here is the caller graph for this function:

validate()

HTMLPurifier_ConfigSchema_Validator::validate

(

$interchange

)

Validates a fully-formed interchange object.

Parameters

HTMLPurifier_ConfigSchema_Interchange

$interchange

Returns

bool

Definition at line 46 of file Validator.php.

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

    {
        $this->interchange = $interchange;
        $this->aliases = array();
        // PHP is a bit lax with integer <=> string conversions in
        // arrays, so we don't use the identical !== comparison
        foreach ($interchange->directives as $i => $directive) {
            $id = $directive->id->toString();
            if ($i != $id) {
                $this->error(false, "Integrity violation: key '$i' does not match internal id '$id'");
            }
            $this->validateDirective($directive);
        }
        return true;
    }

Here is the call graph for this function:

validateDirective()

HTMLPurifier_ConfigSchema_Validator::validateDirective

(

$d

)

Validates a HTMLPurifier_ConfigSchema_Interchange_Directive object.

Parameters

HTMLPurifier_ConfigSchema_Interchange_Directive

$d

Definition at line 86 of file Validator.php.

References $d, HTMLPurifier_VarParser\$stringTypes, HTMLPurifier_VarParser\$types, error(), validateDirectiveAliases(), validateDirectiveAllowed(), validateDirectiveValueAliases(), validateId(), and with().

Referenced by validate().

    {
        $id = $d->id->toString();
        $this->context[] = "directive '$id'";
        $this->validateId($d->id);

        $this->with($d, 'description')
            ->assertNotEmpty();

        // BEGIN - handled by InterchangeBuilder
        $this->with($d, 'type')
            ->assertNotEmpty();
        $this->with($d, 'typeAllowsNull')
            ->assertIsBool();
        try {
            // This also tests validity of $d->type
            $this->parser->parse($d->default, $d->type, $d->typeAllowsNull);
        } catch (HTMLPurifier_VarParserException $e) {
            $this->error('default', 'had error: ' . $e->getMessage());
        }
        // END - handled by InterchangeBuilder

        if (!is_null($d->allowed) || !empty($d->valueAliases)) {
            // allowed and valueAliases require that we be dealing with
            // strings, so check for that early.
            $d_int = HTMLPurifier_VarParser::$types[$d->type];
            if (!isset(HTMLPurifier_VarParser::$stringTypes[$d_int])) {
                $this->error('type', 'must be a string type when used with allowed or value aliases');
            }
        }

        $this->validateDirectiveAllowed($d);
        $this->validateDirectiveValueAliases($d);
        $this->validateDirectiveAliases($d);

        array_pop($this->context);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateDirectiveAliases()

HTMLPurifier_ConfigSchema_Validator::validateDirectiveAliases

(

$d

)

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

Parameters

HTMLPurifier_ConfigSchema_Interchange_Directive

$d

Definition at line 190 of file Validator.php.

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

Referenced by validateDirective().

    {
        $this->with($d, 'aliases')
            ->assertIsArray(); // handled by InterchangeBuilder
        $this->context[] = 'aliases';
        foreach ($d->aliases as $alias) {
            $this->validateId($alias);
            $s = $alias->toString();
            if (isset($this->interchange->directives[$s])) {
                $this->error("alias '$s'", 'collides with another directive');
            }
            if (isset($this->aliases[$s])) {
                $other_directive = $this->aliases[$s];
                $this->error("alias '$s'", "collides with alias for directive '$other_directive'");
            }
            $this->aliases[$s] = $d->id->toString();
        }
        array_pop($this->context);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateDirectiveAllowed()

HTMLPurifier_ConfigSchema_Validator::validateDirectiveAllowed

(

$d

)

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

Parameters

HTMLPurifier_ConfigSchema_Interchange_Directive

$d

Definition at line 129 of file Validator.php.

References $d, $x, error(), and with().

Referenced by validateDirective().

    {
        if (is_null($d->allowed)) {
            return;
        }
        $this->with($d, 'allowed')
            ->assertNotEmpty()
            ->assertIsLookup(); // handled by InterchangeBuilder
        if (is_string($d->default) && !isset($d->allowed[$d->default])) {
            $this->error('default', 'must be an allowed value');
        }
        $this->context[] = 'allowed';
        foreach ($d->allowed as $val => $x) {
            if (!is_string($val)) {
                $this->error("value $val", 'must be a string');
            }
        }
        array_pop($this->context);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateDirectiveValueAliases()

HTMLPurifier_ConfigSchema_Validator::validateDirectiveValueAliases

(

$d

)

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

Parameters

HTMLPurifier_ConfigSchema_Interchange_Directive

$d

Definition at line 154 of file Validator.php.

References $d, error(), and with().

Referenced by validateDirective().

    {
        if (is_null($d->valueAliases)) {
            return;
        }
        $this->with($d, 'valueAliases')
            ->assertIsArray(); // handled by InterchangeBuilder
        $this->context[] = 'valueAliases';
        foreach ($d->valueAliases as $alias => $real) {
            if (!is_string($alias)) {
                $this->error("alias $alias", 'must be a string');
            }
            if (!is_string($real)) {
                $this->error("alias target $real from alias '$alias'", 'must be a string');
            }
            if ($alias === $real) {
                $this->error("alias '$alias'", "must not be an alias to itself");
            }
        }
        if (!is_null($d->allowed)) {
            foreach ($d->valueAliases as $alias => $real) {
                if (isset($d->allowed[$alias])) {
                    $this->error("alias '$alias'", 'must not be an allowed value');
                } elseif (!isset($d->allowed[$real])) {
                    $this->error("alias '$alias'", 'must be an alias to an allowed value');
                }
            }
        }
        array_pop($this->context);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateId()

HTMLPurifier_ConfigSchema_Validator::validateId

(

$id

)

Validates a HTMLPurifier_ConfigSchema_Interchange_Id object.

Parameters

HTMLPurifier_ConfigSchema_Interchange_Id

$id

Definition at line 66 of file Validator.php.

References error(), and with().

Referenced by validateDirective(), and validateDirectiveAliases().

    {
        $id_string = $id->toString();
        $this->context[] = "id '$id_string'";
        if (!$id instanceof HTMLPurifier_ConfigSchema_Interchange_Id) {
            // handled by InterchangeBuilder
            $this->error(false, 'is not an instance of HTMLPurifier_ConfigSchema_Interchange_Id');
        }
        // keys are now unconstrained (we might want to narrow down to A-Za-z0-9.)
        // we probably should check that it has at least one namespace
        $this->with($id, 'key')
            ->assertNotEmpty()
            ->assertIsString(); // implicit assertIsString handled by InterchangeBuilder
        array_pop($this->context);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

with()

HTMLPurifier_ConfigSchema_Validator::with (   $obj,   $member  )

protected

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

Parameters

$obj
$member

Returns

HTMLPurifier_ConfigSchema_ValidatorAtom

Definition at line 219 of file Validator.php.

References getFormattedContext().

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

    {
        return new HTMLPurifier_ConfigSchema_ValidatorAtom($this->getFormattedContext(), $obj, $member);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$aliases

HTMLPurifier_ConfigSchema_Validator::$aliases

protected

array

Definition at line 22 of file Validator.php.

$context

HTMLPurifier_ConfigSchema_Validator::$context = array()

protected

Context-stack to provide easy to read error messages.

array

Definition at line 28 of file Validator.php.

$interchange

HTMLPurifier_ConfigSchema_Validator::$interchange

protected

HTMLPurifier_ConfigSchema_Interchange

Definition at line 17 of file Validator.php.

Referenced by validate().

$parser

HTMLPurifier_ConfigSchema_Validator::$parser

protected

to test default's type.

HTMLPurifier_VarParser

Definition at line 34 of file Validator.php.

---

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

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