XssSanitiser
class XssSanitiser (View source)
Sanitises HTML to prevent XSS attacks.
Traits
A class that can be instantiated or replaced via DI
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Set the names of elements which will be removed.
Get the names of attributes which will be removed from any elements that have them.
Set the names of attributes which will be removed from any elements that have them.
Get whether the inner contents of an element will be kept for elements that get removed.
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();
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).
string
sanitiseString(string $html)
Remove XSS attack vectors from an HTML fragment string
void
sanitiseHtmlValue(HTMLValue $html)
Remove XSS attack vectors from HTMLValue content
void
sanitiseElement(DOMElement $element)
Remove XSS attack vectors from a DOMElement
array
getElementsToRemove()
Get the names of elements which will be removed.
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.
array
getAttributesToRemove()
Get the names of attributes which will be removed from any elements that have them.
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.
bool
getKeepInnerHtmlOnRemoveElement()
Get whether the inner contents of an element will be kept for elements that get removed.
XssSanitiser
setKeepInnerHtmlOnRemoveElement(bool $keep)
Set whether to keep the inner contents of an element if it gets removed.