BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
HtmlFormatter\HtmlFormatter Class Reference
Inheritance diagram for HtmlFormatter\HtmlFormatter:

Public Member Functions

 __construct ($html)
 
 getDoc ()
 
 setRemoveMedia ($flag=true)
 
 remove ($selectors)
 
 flatten ($elements)
 
 flattenAllTags ()
 
 getText ($element=null)
 

Static Public Member Functions

static wrapHTML ($html)
 

Protected Member Functions

 onHtmlReady ($html)
 
 parseSelector ($selector, &$type, &$rawName)
 
 parseItemsToRemove ()
 

Protected Attributes

 $removeMedia = false
 

Constructor & Destructor Documentation

HtmlFormatter\HtmlFormatter::__construct (   $html)

Constructor

Parameters
string$htmlText to process

Member Function Documentation

HtmlFormatter\HtmlFormatter::flatten (   $elements)

Adds one or more element name to the list to flatten (remove tag, but not its content) Can accept undelimited regexes

Note this interface may fail in surprising unexpected ways due to usage of regexes, so should not be relied on for HTML markup security measures.

Parameters
array | string$elementsName(s) of tag(s) to flatten
HtmlFormatter\HtmlFormatter::flattenAllTags ( )

Instructs the formatter to flatten all tags

HtmlFormatter\HtmlFormatter::getDoc ( )
Returns
DOMDocument DOM to manipulate
HtmlFormatter\HtmlFormatter::getText (   $element = null)

Performs final transformations and returns resulting HTML. Note that if you want to call this both without an element and with an element you should call it without an element first. If you specify the $element in the method it'll change the underlying dom and you won't be able to get it back.

Parameters
DOMElement | string | null$elementID of element to get HTML from or false to get it from the whole tree
Returns
string Processed HTML
HtmlFormatter\HtmlFormatter::onHtmlReady (   $html)
protected

Override this in descendant class to modify HTML after it has been converted from DOM tree

Parameters
string$htmlHTML to process
Returns
string Processed HTML
HtmlFormatter\HtmlFormatter::parseItemsToRemove ( )
protected

Transforms CSS-style selectors into an internal representation suitable for processing by filterContent()

Returns
array
HtmlFormatter\HtmlFormatter::parseSelector (   $selector,
$type,
$rawName 
)
protected

Helper function for parseItemsToRemove(). This function extracts the selector type and the raw name of a selector from a CSS-style selector string and assigns those values to parameters passed by reference. For example, if given '#toc' as the $selector parameter, it will assign 'ID' as the $type and 'toc' as the $rawName.

Parameters
string$selectorCSS selector to parse
string$typeThe type of selector (ID, CLASS, TAG_CLASS, or TAG)
string$rawNameThe raw name of the selector
Returns
bool Whether the selector was successfully recognised
Exceptions
MWException
HtmlFormatter\HtmlFormatter::remove (   $selectors)

Adds one or more selector of content to remove. A subset of CSS selector syntax is supported:

<tag> <tag>.class .<class> #<id>

Parameters
array | string$selectorsSelector(s) of stuff to remove
HtmlFormatter\HtmlFormatter::setRemoveMedia (   $flag = true)

Sets whether images/videos/sounds should be removed from output

Parameters
bool$flag
static HtmlFormatter\HtmlFormatter::wrapHTML (   $html)
static

Turns a chunk of HTML into a proper document

Parameters
string$html
Returns
string

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