HTMLPurifier 4.4.0
HTMLPurifier_Injector_SafeObject Class Reference

Adds important param elements to inside of object in order to make things safe. More...

Inheritance diagram for HTMLPurifier_Injector_SafeObject:
HTMLPurifier_Injector HTMLPurifier_Injector

List of all members.

Public Member Functions

 prepare ($config, $context)
 Prepares the injector by giving it the config and context objects: this allows references to important variables to be made within the injector.
 handleElement (&$token)
 Handler that is called when a start or empty token is processed.
 handleEnd (&$token)
 Handler that is called when an end token is processed.
 prepare ($config, $context)
 Prepares the injector by giving it the config and context objects: this allows references to important variables to be made within the injector.
 handleElement (&$token)
 Handler that is called when a start or empty token is processed.
 handleEnd (&$token)
 Handler that is called when an end token is processed.

Public Attributes

 $name = 'SafeObject'
 Advisory name of injector, this is for friendly error messages.
 $needed = array('object', 'param')
 Array of elements and attributes this injector creates and therefore need to be allowed by the definition.

Protected Attributes

 $objectStack = array()
 $paramStack = array()
 $addParam
 $allowedParam

Detailed Description

Adds important param elements to inside of object in order to make things safe.

Definition at line 7 of file SafeObject.php.


Member Function Documentation

HTMLPurifier_Injector_SafeObject::handleElement ( &$  token)

Handler that is called when a start or empty token is processed.

Reimplemented from HTMLPurifier_Injector.

Definition at line 32 of file SafeObject.php.

References $name.

HTMLPurifier_Injector_SafeObject::handleElement ( &$  token)

Handler that is called when a start or empty token is processed.

Reimplemented from HTMLPurifier_Injector.

Definition at line 14620 of file HTMLPurifier.standalone.php.

References $name.

HTMLPurifier_Injector_SafeObject::handleEnd ( &$  token)

Handler that is called when an end token is processed.

Reimplemented from HTMLPurifier_Injector.

Definition at line 14667 of file HTMLPurifier.standalone.php.

HTMLPurifier_Injector_SafeObject::handleEnd ( &$  token)

Handler that is called when an end token is processed.

Reimplemented from HTMLPurifier_Injector.

Definition at line 79 of file SafeObject.php.

HTMLPurifier_Injector_SafeObject::prepare ( config,
context 
)

Prepares the injector by giving it the config and context objects: this allows references to important variables to be made within the injector.

This function also checks if the HTML environment will work with the Injector (see checkNeeded()).

Parameters:
$configInstance of HTMLPurifier_Config
$contextInstance of HTMLPurifier_Context
Returns:
Boolean false if success, string of missing needed element/attribute if failure

Reimplemented from HTMLPurifier_Injector.

Definition at line 14616 of file HTMLPurifier.standalone.php.

References $config, and prepare().

HTMLPurifier_Injector_SafeObject::prepare ( config,
context 
)

Prepares the injector by giving it the config and context objects: this allows references to important variables to be made within the injector.

This function also checks if the HTML environment will work with the Injector (see checkNeeded()).

Parameters:
$configInstance of HTMLPurifier_Config
$contextInstance of HTMLPurifier_Context
Returns:
Boolean false if success, string of missing needed element/attribute if failure

Reimplemented from HTMLPurifier_Injector.

Definition at line 28 of file SafeObject.php.

References $config.

Referenced by prepare().


Member Data Documentation

HTMLPurifier_Injector_SafeObject::$addParam [protected]
Initial value:
 array(
        'allowScriptAccess' => 'never',
        'allowNetworking' => 'internal',
    )

Definition at line 16 of file SafeObject.php.

HTMLPurifier_Injector_SafeObject::$allowedParam [protected]
Initial value:
 array(
        'wmode' => true,
        'movie' => true,
        'flashvars' => true,
        'src' => true,
        'allowFullScreen' => true, 
    )

Definition at line 20 of file SafeObject.php.

HTMLPurifier_Injector_SafeObject::$name = 'SafeObject'

Advisory name of injector, this is for friendly error messages.

Reimplemented from HTMLPurifier_Injector.

Definition at line 9 of file SafeObject.php.

Referenced by handleElement().

HTMLPurifier_Injector_SafeObject::$needed = array('object', 'param')

Array of elements and attributes this injector creates and therefore need to be allowed by the definition.

Takes form of array('element' => array('attr', 'attr2'), 'element2')

Reimplemented from HTMLPurifier_Injector.

Definition at line 10 of file SafeObject.php.

HTMLPurifier_Injector_SafeObject::$objectStack = array() [protected]

Definition at line 12 of file SafeObject.php.

HTMLPurifier_Injector_SafeObject::$paramStack = array() [protected]

Definition at line 13 of file SafeObject.php.


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