Page MenuHomeWickedGov Phorge
Files F4102885

TreeMutationTracer.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

TreeMutationTracer.php
View Options

<?php
namespace Wikimedia\RemexHtml\TreeBuilder;
use Wikimedia\RemexHtml\Tokenizer\Attributes;
/**
* This is a debugging helper class which calls the supplied callback function
* each time there is a TreeHandler event, giving a descriptive message. It
* then forwards the event through to the supplied handler.
*/
class TreeMutationTracer implements TreeHandler {
/** @var TreeHandler */
private $handler;
/** @var callable */
private $callback;
/** @var int */
private $verbosity;
/**
* Constructor.
*
* @param TreeHandler $handler The next pipeline stage
* @param callable $callback The message output function
* @param int $verbosity Set to non-zero to call dump() on the handler
* before and after each event.
*/
public function __construct( TreeHandler $handler, callable $callback, $verbosity = 0 ) {
$this->handler = $handler;
$this->callback = $callback;
$this->verbosity = $verbosity;
}
/**
* Send a message
*
* @param string $msg
*/
private function trace( $msg ) {
call_user_func( $this->callback, "[Tree] $msg" );
}
/**
* Send a message for an event
*
* @param string $funcName
* @param array $args
*/
private function traceEvent( $funcName, $args ) {
$this->trace( call_user_func_array( [ TraceFormatter::class, $funcName ], $args ) );
}
private function handleMutation( $funcName, $args ) {
$this->traceEvent( $funcName, $args );
$this->before();
call_user_func_array( [ $this->handler, $funcName ], $args );
$this->after();
}
private function handleSimple( $funcName, $args ) {
$this->traceEvent( $funcName, $args );
call_user_func_array( [ $this->handler, $funcName ], $args );
}
/**
* A helper called before the underlying handler is called.
*/
private function before() {
if ( $this->verbosity > 0 ) {
// @phan-suppress-next-line PhanUndeclaredMethod
$this->trace( "Before: " . $this->handler->dump() . "\n" );
}
}
/**
* A helper called after the underlying handler is called.
*/
private function after() {
if ( $this->verbosity > 0 ) {
// @phan-suppress-next-line PhanUndeclaredMethod
$this->trace( "After: " . $this->handler->dump() . "\n" );
}
}
/**
* @inheritDoc
*/
public function startDocument( $fns, $fn ) {
$this->handleSimple( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function endDocument( $pos ) {
$this->handleSimple( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function characters( $preposition, $refNode, $text, $start, $length,
$sourceStart, $sourceLength
) {
$this->handleMutation( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function insertElement( $preposition, $refNode, Element $element, $void,
$sourceStart, $sourceLength
) {
$this->handleMutation( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function endTag( Element $element, $sourceStart, $sourceLength ) {
$this->handleMutation( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function doctype( $name, $public, $system, $quirks, $sourceStart, $sourceLength ) {
$this->handleMutation( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function comment( $preposition, $refNode, $text, $sourceStart, $sourceLength ) {
$this->handleMutation( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function error( $text, $pos ) {
$this->handleSimple( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function mergeAttributes( Element $element, Attributes $attrs, $sourceStart ) {
$this->handleMutation( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function removeNode( Element $element, $sourceStart ) {
$this->handleMutation( __FUNCTION__, func_get_args() );
}
/**
* @inheritDoc
*/
public function reparentChildren( Element $element, Element $newParent, $sourceStart ) {
$this->handleMutation( __FUNCTION__, func_get_args() );
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 17:38 (3 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ab/9e/71578dca30aef13a42403ba9b2c8
Default Alt Text
TreeMutationTracer.php (3 KB)

Event Timeline