class XssSanitiser (View source)

Sanitises HTML to prevent XSS attacks.

Traits

A class that can be instantiated or replaced via DI

Methods

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public
string
sanitiseString(string $html)

Remove XSS attack vectors from an HTML fragment string

public
void
sanitiseHtmlValue(HTMLValue $html)

Remove XSS attack vectors from HTMLValue content

public
void
sanitiseElement(DOMElement $element)

Remove XSS attack vectors from a DOMElement

public
array
getElementsToRemove()

Get the names of elements which will be removed.

public
setElementsToRemove(array $elements)

Set the names of elements which will be removed.

public
array
getAttributesToRemove()

Get the names of attributes which will be removed from any elements that have them.

public
setAttributesToRemove(array $attributes)

Set the names of attributes which will be removed from any elements that have them.

public
bool
getKeepInnerHtmlOnRemoveElement()

Get whether the inner contents of an element will be kept for elements that get removed.

public
setKeepInnerHtmlOnRemoveElement(bool $keep)

Set whether to keep the inner contents of an element if it gets removed.

Details

static Injectable create(mixed ...$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::class); $list = SiteTree::get();

Parameters

mixed ...$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

string sanitiseString(string $html)

Remove XSS attack vectors from an HTML fragment string

Parameters

string $html

Return Value

string

void sanitiseHtmlValue(HTMLValue $html)

Remove XSS attack vectors from HTMLValue content

Parameters

HTMLValue $html

Return Value

void

void sanitiseElement(DOMElement $element)

Remove XSS attack vectors from a DOMElement

Parameters

DOMElement $element

Return Value

void

array getElementsToRemove()

Get the names of elements which will be removed.

Return Value

array

XssSanitiser setElementsToRemove(array $elements)

Set the names of elements which will be removed.

Note that allowing the elements which are included in the default list could result in XSS vulnerabilities.

Parameters

array $elements

Return Value

XssSanitiser

array getAttributesToRemove()

Get the names of attributes which will be removed from any elements that have them.

Return Value

array

XssSanitiser setAttributesToRemove(array $attributes)

Set the names of attributes which will be removed from any elements that have them.

Note that allowing the attributes which are included in the default list could result in XSS vulnerabilities.

Parameters

array $attributes

Return Value

XssSanitiser

bool getKeepInnerHtmlOnRemoveElement()

Get whether the inner contents of an element will be kept for elements that get removed.

Return Value

bool

XssSanitiser setKeepInnerHtmlOnRemoveElement(bool $keep)

Set whether to keep the inner contents of an element if it gets removed.

Parameters

bool $keep

Return Value

XssSanitiser