/**
* 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
+ * @return array Array of removed DOMElements
*/
public function filterContent() {
wfProfileIn( __METHOD__ );
// Bail out early if nothing to do
if ( array_reduce( $removals,
- function( $carry, $item ) {
+ function ( $carry, $item ) {
return $carry && !$item;
},
true
/**
* Removes a list of elelments from DOMDocument
* @param array|DOMNodeList $elements
- * @return array of removed elements
+ * @return array Array of removed elements
*/
private function removeElements( $elements ) {
$list = $elements;
private function fixLibXML( $html ) {
wfProfileIn( __METHOD__ );
static $replacements;
- if ( ! $replacements ) {
+ if ( !$replacements ) {
// We don't include rules like '"' => '"' because entities had already been
// normalized by libxml. Using this function with input not sanitized by libxml is UNSAFE!
$replacements = new ReplacementArray( array(
}
/**
+ * 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.
* @param string $selector CSS selector to parse
- * @param string $type
- * @param string $rawName
+ * @param string $type The type of selector (ID, CLASS, TAG_CLASS, or TAG)
+ * @param string $rawName The raw name of the selector
* @return bool Whether the selector was successfully recognised
*/
protected function parseSelector( $selector, &$type, &$rawName ) {
}
/**
- * Transforms CSS selectors into an internal representation suitable for processing
+ * Transforms CSS-style selectors into an internal representation suitable for
+ * processing by filterContent()
* @return array
*/
protected function parseItemsToRemove() {