class PurifierHTMLCleaner extends HTMLCleaner (View source)

Cleans HTML using the HTMLPurifier package http://htmlpurifier.org/

Traits

Provides extensions to this object to integrate it with standard config API methods.

A class that can be instantiated or replaced via DI

Properties

array $config

Configuration variables for HTMLCleaners that support configuration (like Tidy)

from  HTMLCleaner

Methods

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

__construct(array $config = null)

No description

setConfig($config)

No description

array
getConfig()

No description

string
cleanHTML(string $content)

Passed a string, return HTML that has been tidied.

static HTMLCleaner
inst()

Experimental inst class to create a default html cleaner class

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

static Injectable create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct(array $config = null)

Parameters

array $config

The configuration for the cleaner, if necessary

setConfig($config)

Parameters

$config

array getConfig()

Return Value

array

string cleanHTML(string $content)

Passed a string, return HTML that has been tidied.

Parameters

string $content

Return Value

string

HTML, tidied

static HTMLCleaner inst()

Experimental inst class to create a default html cleaner class

Return Value

HTMLCleaner