HTMLPurifier_TokenFactory Class Reference

Factory for token generation. More...

Collaboration diagram for HTMLPurifier_TokenFactory:

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

Private Attributes
	$p_start
	@type HTMLPurifier_Token_Start More...
	$p_end
	@type HTMLPurifier_Token_End More...
	$p_empty
	@type HTMLPurifier_Token_Empty More...
	$p_text
	@type HTMLPurifier_Token_Text More...
	$p_comment
	@type HTMLPurifier_Token_Comment More...

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

__construct()

HTMLPurifier_TokenFactory::__construct

(

)

Generates blank prototypes for cloning.

Definition at line 46 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

createComment()

HTMLPurifier_TokenFactory::createComment

(

$data

)

Creates a HTMLPurifier_Token_Comment.

Parameters

string

$data

Data of comment token

Returns

HTMLPurifier_Token_Comment Generated HTMLPurifier_Token_Comment

Definition at line 110 of file TokenFactory.php.

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

References $data, and $p_comment.

createEmpty()

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

Creates a HTMLPurifier_Token_Empty.

Parameters

string	$name	Tag name
array	$attr	Associative array of attributes

Returns

HTMLPurifier_Token_Empty Generated HTMLPurifier_Token_Empty

Definition at line 86 of file TokenFactory.php.

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

References $p_empty.

createEnd()

HTMLPurifier_TokenFactory::createEnd

(

$name

)

Creates a HTMLPurifier_Token_End.

Parameters

string

$name

Tag name

Returns

HTMLPurifier_Token_End Generated HTMLPurifier_Token_End

Definition at line 73 of file TokenFactory.php.

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

References $p_end.

createStart()

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

Creates a HTMLPurifier_Token_Start.

Parameters

string	$name	Tag name
array	$attr	Associative array of attributes

Returns

HTMLPurifier_Token_Start Generated HTMLPurifier_Token_Start

Definition at line 61 of file TokenFactory.php.

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

References $p_start.

createText()

HTMLPurifier_TokenFactory::createText

(

$data

)

Creates a HTMLPurifier_Token_Text.

Parameters

string

$data

Data of text token

Returns

HTMLPurifier_Token_Text Generated HTMLPurifier_Token_Text

Definition at line 98 of file TokenFactory.php.

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

References $data, and $p_text.

Field Documentation

$p_comment

HTMLPurifier_TokenFactory::$p_comment

private

@type HTMLPurifier_Token_Comment

Definition at line 41 of file TokenFactory.php.

Referenced by createComment().

$p_empty

HTMLPurifier_TokenFactory::$p_empty

private

@type HTMLPurifier_Token_Empty

Definition at line 31 of file TokenFactory.php.

Referenced by createEmpty().

$p_end

HTMLPurifier_TokenFactory::$p_end

private

@type HTMLPurifier_Token_End

Definition at line 26 of file TokenFactory.php.

Referenced by createEnd().

$p_start

HTMLPurifier_TokenFactory::$p_start

private

@type HTMLPurifier_Token_Start

Definition at line 21 of file TokenFactory.php.

Referenced by createStart().

$p_text

HTMLPurifier_TokenFactory::$p_text

private

@type HTMLPurifier_Token_Text

Definition at line 36 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