HTMLPurifier_TokenFactory Class Reference

Factory for token generation. More...

Collaboration diagram for HTMLPurifier_TokenFactory:

Public Member Functions
	__construct ()
	Generates blank prototypes for cloning.
	createStart ($name, $attr=array())
	Creates a HTMLPurifier_Token_Start.
	createEnd ($name)
	Creates a HTMLPurifier_Token_End.
	createEmpty ($name, $attr=array())
	Creates a HTMLPurifier_Token_Empty.
	createText ($data)
	Creates a HTMLPurifier_Token_Text.
	createComment ($data)
	Creates a HTMLPurifier_Token_Comment.

Data Fields
	$p_end
	$p_empty
	$p_text
	$p_comment

Private Attributes
	$p_start
	Prototypes that will be cloned.

Detailed Description

Factory for token generation.

Note

Doing some benchmarking indicates that the new operator is much slower than the clone operator (even discounting the cost of the constructor). This class is for that optimization. Other then that, there's not much point as we don't maintain parallel HTMLPurifier_Token hierarchies (the main reason why you'd want to use an abstract factory).

Todo:

Port DirectLex to use this

Definition at line 14 of file TokenFactory.php.

Constructor & Destructor Documentation

HTMLPurifier_TokenFactory::__construct

(

)

Generates blank prototypes for cloning.

Definition at line 27 of file TokenFactory.php.

                                  {
        $this->p_start  = new HTMLPurifier_Token_Start('', array());
        $this->p_end    = new HTMLPurifier_Token_End('');
        $this->p_empty  = new HTMLPurifier_Token_Empty('', array());
        $this->p_text   = new HTMLPurifier_Token_Text('');
        $this->p_comment= new HTMLPurifier_Token_Comment('');
    }

Member Function Documentation

HTMLPurifier_TokenFactory::createComment

(

$data

)

Creates a HTMLPurifier_Token_Comment.

Parameters

$data

Data of comment token

Returns

Generated HTMLPurifier_Token_Comment

Definition at line 86 of file TokenFactory.php.

References $data, and $p_comment.

                                         {
        $p = clone $this->p_comment;
        $p->__construct($data);
        return $p;
    }

HTMLPurifier_TokenFactory::createEmpty	(		$name,
			$attr = array()
	)

Creates a HTMLPurifier_Token_Empty.

Parameters

$name	Tag name
$attr	Associative array of attributes

Returns

Generated HTMLPurifier_Token_Empty

Definition at line 64 of file TokenFactory.php.

References $name, and $p_empty.

                                                        {
        $p = clone $this->p_empty;
        $p->__construct($name, $attr);
        return $p;
    }

HTMLPurifier_TokenFactory::createEnd

(

$name

)

Creates a HTMLPurifier_Token_End.

Parameters

$name

Tag name

Returns

Generated HTMLPurifier_Token_End

Definition at line 52 of file TokenFactory.php.

References $name, and $p_end.

                                     {
        $p = clone $this->p_end;
        $p->__construct($name);
        return $p;
    }

HTMLPurifier_TokenFactory::createStart	(		$name,
			$attr = array()
	)

Creates a HTMLPurifier_Token_Start.

Parameters

$name	Tag name
$attr	Associative array of attributes

Returns

Generated HTMLPurifier_Token_Start

Definition at line 41 of file TokenFactory.php.

References $name, and $p_start.

                                                        {
        $p = clone $this->p_start;
        $p->__construct($name, $attr);
        return $p;
    }

HTMLPurifier_TokenFactory::createText

(

$data

)

Creates a HTMLPurifier_Token_Text.

Parameters

$data

Data of text token

Returns

Generated HTMLPurifier_Token_Text

Definition at line 75 of file TokenFactory.php.

References $data, and $p_text.

                                      {
        $p = clone $this->p_text;
        $p->__construct($data);
        return $p;
    }

Field Documentation

HTMLPurifier_TokenFactory::$p_comment

Definition at line 22 of file TokenFactory.php.

Referenced by createComment().

HTMLPurifier_TokenFactory::$p_empty

Definition at line 22 of file TokenFactory.php.

Referenced by createEmpty().

HTMLPurifier_TokenFactory::$p_end

Definition at line 22 of file TokenFactory.php.

Referenced by createEnd().

HTMLPurifier_TokenFactory::$p_start

private

Prototypes that will be cloned.

Definition at line 22 of file TokenFactory.php.

Referenced by createStart().

HTMLPurifier_TokenFactory::$p_text

Definition at line 22 of file TokenFactory.php.

Referenced by createText().

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/TokenFactory.php