/**
* Constructor
*
- * @param string $html: Text to process
+ * @param string $html Text to process
*/
public function __construct( $html ) {
$this->html = $html;
/**
* Override this in descendant class to modify HTML after it has been converted from DOM tree
- * @param string $html: HTML to process
- * @return string: Processed HTML
+ * @param string $html HTML to process
+ * @return string Processed HTML
*/
protected function onHtmlReady( $html ) {
return $html;
}
/**
- * @return DOMDocument: DOM to manipulate
+ * @return DOMDocument DOM to manipulate
*/
public function getDoc() {
if ( !$this->doc ) {
* .<class>
* #<id>
*
- * @param Array|string $selectors: Selector(s) of stuff to remove
+ * @param array|string $selectors Selector(s) of stuff to remove
*/
public function remove( $selectors ) {
$this->itemsToRemove = array_merge( $this->itemsToRemove, (array)$selectors );
* 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.
*
- * @param Array|string $elements: Name(s) of tag(s) to flatten
+ * @param array|string $elements Name(s) of tag(s) to flatten
*/
public function flatten( $elements ) {
$this->elementsToFlatten = array_merge( $this->elementsToFlatten, (array)$elements );
}
/**
- * Removes content we've chosen to remove
+ * Removes content we've chosen to remove. The text of the removed elements can be
+ * extracted with the getText method.
+ * @return array of removed DOMElements
*/
public function filterContent() {
wfProfileIn( __METHOD__ );
$removals = $this->parseItemsToRemove();
- if ( !$removals ) {
+ // Bail out early if nothing to do
+ if ( array_reduce( $removals,
+ function( $carry, $item ) {
+ return $carry && !$item;
+ },
+ true
+ ) ) {
wfProfileOut( __METHOD__ );
- return;
+ return array();
}
$doc = $this->getDoc();
}
}
}
-
- $this->removeElements( $domElemsToRemove );
+ $removed = $this->removeElements( $domElemsToRemove );
// Elements with named IDs
$domElemsToRemove = array();
$domElemsToRemove[] = $itemToRemoveNode;
}
}
- $this->removeElements( $domElemsToRemove );
+ $removed = array_merge( $removed, $this->removeElements( $domElemsToRemove ) );
// CSS Classes
$domElemsToRemove = array();
}
}
}
- $this->removeElements( $domElemsToRemove );
+ $removed = array_merge( $removed, $this->removeElements( $domElemsToRemove ) );
// Tags with CSS Classes
foreach ( $removals['TAG_CLASS'] as $classToRemove ) {
$elements = $xpath->query(
'//' . $parts[0] . '[@class="' . $parts[1] . '"]'
);
-
- $this->removeElements( $elements );
+ $removed = array_merge( $removed, $this->removeElements( $elements ) );
}
wfProfileOut( __METHOD__ );
+ return $removed;
}
/**
* Removes a list of elelments from DOMDocument
* @param array|DOMNodeList $elements
+ * @return array of removed elements
*/
private function removeElements( $elements ) {
$list = $elements;
$element->parentNode->removeChild( $element );
}
}
+ return $list;
}
/**
}
/**
- * Performs final transformations and returns resulting HTML
+ * 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.
*
- * @param DOMElement|string|null $element: ID of element to get HTML from or false to get it from the whole tree
- * @return string: Processed HTML
+ * @param DOMElement|string|null $element ID of element to get HTML from or false to get it from the whole tree
+ * @return string Processed HTML
*/
public function getText( $element = null ) {
wfProfileIn( __METHOD__ );
if ( $this->doc ) {
+ wfProfileIn( __METHOD__ . '-dom' );
if ( $element !== null && !( $element instanceof DOMElement ) ) {
$element = $this->doc->getElementById( $element );
}
$body->appendChild( $element );
}
$html = $this->doc->saveHTML();
+ wfProfileOut( __METHOD__ . '-dom' );
+
+ wfProfileIn( __METHOD__ . '-fixes' );
$html = $this->fixLibXml( $html );
+ if ( wfIsWindows() ) {
+ // Cleanup for CRLF misprocessing of unknown origin on Windows.
+ //
+ // If this error continues in the future, please track it down in the
+ // XML code paths if possible and fix there.
+ $html = str_replace( ' ', '', $html );
+ }
+ wfProfileOut( __METHOD__ . '-fixes' );
} else {
$html = $this->html;
}
- if ( wfIsWindows() ) {
- // Appears to be cleanup for CRLF misprocessing of unknown origin
- // when running server on Windows platform.
- //
- // If this error continues in the future, please track it down in the
- // XML code paths if possible and fix there.
- $html = str_replace( ' ', '', $html );
- }
+ // Remove stuff added by wrapHTML()
$html = preg_replace( '/<!--.*?-->|^.*?<body>|<\/body>.*$/s', '', $html );
$html = $this->onHtmlReady( $html );
+ wfProfileIn( __METHOD__ . '-flatten' );
if ( $this->elementsToFlatten ) {
$elements = implode( '|', $this->elementsToFlatten );
$html = preg_replace( "#</?($elements)\\b[^>]*>#is", '', $html );
}
+ wfProfileOut( __METHOD__ . '-flatten' );
wfProfileOut( __METHOD__ );
return $html;
}
/**
- * @param $selector: CSS selector to parse
- * @param $type
- * @param $rawName
- * @return bool: Whether the selector was successfully recognised
+ * @param string $selector CSS selector to parse
+ * @param string $type
+ * @param string $rawName
+ * @return bool Whether the selector was successfully recognised
*/
protected function parseSelector( $selector, &$type, &$rawName ) {
if ( strpos( $selector, '.' ) === 0 ) {
dépôts / lhc / web / wiklou.git / blobdiff