PHP Class HTMLPurifier_DefinitionCacheFactory, yii

Mostra file Open project: yiisoft/yii Class Usage Examples

Protected Properties

Property	Type	Description
$caches
$decorators
$implementations

Public Methods

Method	Description
addDecorator ( HTMLPurifier_DefinitionCache_Decorator \| string $decorator )	Registers a decorator to add to all new cache objects
create ( string $type, HTMLPurifier_Config $config ) : mixed	Factory method that creates a cache object based on configuration
instance ( HTMLPurifier_DefinitionCacheFactory $prototype = null ) : HTMLPurifier_DefinitionCacheFactory	Retrieves an instance of global definition cache factory.
register ( string $short, string $long )	Registers a new definition cache object
setup ( )	Initialize default decorators

Method Details

addDecorator() public method

Registers a decorator to add to all new cache objects

public addDecorator ( HTMLPurifier_DefinitionCache_Decorator \| string $decorator )
$decorator	HTMLPurifier_DefinitionCache_Decorator \| string	An instance or the name of a decorator

create() public method

Factory method that creates a cache object based on configuration

public create ( string $type, HTMLPurifier_Config $config ) : mixed
$type	string	Name of definitions handled by cache
$config	HTMLPurifier_Config	Config instance
return	mixed

instance() public static method

Retrieves an instance of global definition cache factory.

public static instance ( HTMLPurifier_DefinitionCacheFactory $prototype = null ) : HTMLPurifier_DefinitionCacheFactory
$prototype	HTMLPurifier_DefinitionCacheFactory
return	HTMLPurifier_DefinitionCacheFactory

register() public method

Registers a new definition cache object

public register ( string $short, string $long )
$short	string	Short name of cache object, for reference
$long	string	Full class name of cache object, for construction

setup() public method

Initialize default decorators

public setup ( )

Property Details

$caches protected_oe property

protected $caches

$decorators protected_oe property

protected $decorators

$implementations protected_oe property

protected $implementations