HTMLPurifier_ConfigSchema_ValidatorAtom Class Reference

Fluent interface for validating the contents of member variables. More...

Collaboration diagram for HTMLPurifier_ConfigSchema_ValidatorAtom:

Public Member Functions
	__construct ($context, $obj, $member)
	assertIsString ()
	assertIsBool ()
	assertIsArray ()
	assertNotNull ()
	assertAlnum ()
	assertNotEmpty ()
	assertIsLookup ()

Protected Member Functions
	error ($msg)

Protected Attributes
	$context
	string
	$obj
	object
	$member
	string
	$contents
	mixed

Detailed Description

Fluent interface for validating the contents of member variables.

This should be immutable. See HTMLPurifier_ConfigSchema_Validator for use-cases. We name this an 'atom' because it's ONLY for validations that are independent and usually scalar.

Definition at line 9 of file ValidatorAtom.php.

Constructor & Destructor Documentation

HTMLPurifier_ConfigSchema_ValidatorAtom::__construct	(		$context,
			$obj,
			$member
	)

Definition at line 31 of file ValidatorAtom.php.

References $context, $member, and $obj.

    {
        $this->context = $context;
        $this->obj = $obj;
        $this->member = $member;
        $this->contents =& $obj->$member;
    }

Member Function Documentation

HTMLPurifier_ConfigSchema_ValidatorAtom::assertAlnum

(

)

Returns

HTMLPurifier_ConfigSchema_ValidatorAtom

Definition at line 86 of file ValidatorAtom.php.

References assertIsString(), and error().

    {
        $this->assertIsString();
        if (!ctype_alnum($this->contents)) {
            $this->error('must be alphanumeric');
        }
        return $this;
    }

Here is the call graph for this function:

HTMLPurifier_ConfigSchema_ValidatorAtom::assertIsArray

(

)

Returns

HTMLPurifier_ConfigSchema_ValidatorAtom

Definition at line 64 of file ValidatorAtom.php.

References error().

Referenced by assertIsLookup().

    {
        if (!is_array($this->contents)) {
            $this->error('must be an array');
        }
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

HTMLPurifier_ConfigSchema_ValidatorAtom::assertIsBool

(

)

Returns

HTMLPurifier_ConfigSchema_ValidatorAtom

Definition at line 53 of file ValidatorAtom.php.

References error().

    {
        if (!is_bool($this->contents)) {
            $this->error('must be a boolean');
        }
        return $this;
    }

Here is the call graph for this function:

HTMLPurifier_ConfigSchema_ValidatorAtom::assertIsLookup

(

)

Returns

HTMLPurifier_ConfigSchema_ValidatorAtom

Definition at line 109 of file ValidatorAtom.php.

References assertIsArray(), and error().

    {
        $this->assertIsArray();
        foreach ($this->contents as $v) {
            if ($v !== true) {
                $this->error('must be a lookup array');
            }
        }
        return $this;
    }

Here is the call graph for this function:

HTMLPurifier_ConfigSchema_ValidatorAtom::assertIsString

(

)

Returns

HTMLPurifier_ConfigSchema_ValidatorAtom

Definition at line 42 of file ValidatorAtom.php.

References error().

Referenced by assertAlnum().

    {
        if (!is_string($this->contents)) {
            $this->error('must be a string');
        }
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

HTMLPurifier_ConfigSchema_ValidatorAtom::assertNotEmpty

(

)

Returns

HTMLPurifier_ConfigSchema_ValidatorAtom

Definition at line 98 of file ValidatorAtom.php.

References error().

    {
        if (empty($this->contents)) {
            $this->error('must not be empty');
        }
        return $this;
    }

Here is the call graph for this function:

HTMLPurifier_ConfigSchema_ValidatorAtom::assertNotNull

(

)

Returns

HTMLPurifier_ConfigSchema_ValidatorAtom

Definition at line 75 of file ValidatorAtom.php.

References error().

    {
        if ($this->contents === null) {
            $this->error('must not be null');
        }
        return $this;
    }

Here is the call graph for this function:

HTMLPurifier_ConfigSchema_ValidatorAtom::error (   $msg )

protected

Parameters

string

$msg

Exceptions

HTMLPurifier_ConfigSchema_Exception

Definition at line 124 of file ValidatorAtom.php.

Referenced by assertAlnum(), assertIsArray(), assertIsBool(), assertIsLookup(), assertIsString(), assertNotEmpty(), and assertNotNull().

    {
        throw new HTMLPurifier_ConfigSchema_Exception(ucfirst($this->member) . ' in ' . $this->context . ' ' . $msg);
    }

Here is the caller graph for this function:

Field Documentation

HTMLPurifier_ConfigSchema_ValidatorAtom::$contents

protected

mixed

Definition at line 29 of file ValidatorAtom.php.

HTMLPurifier_ConfigSchema_ValidatorAtom::$context

protected

string

Definition at line 14 of file ValidatorAtom.php.

Referenced by __construct().

HTMLPurifier_ConfigSchema_ValidatorAtom::$member

protected

string

Definition at line 24 of file ValidatorAtom.php.

Referenced by __construct().

HTMLPurifier_ConfigSchema_ValidatorAtom::$obj

protected

object

Definition at line 19 of file ValidatorAtom.php.

Referenced by __construct().

---

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

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