Page MenuHomeWickedGov Phorge

DOMHandlerFactory.php
No OneTemporary

Size
4 KB
Referenced Files
None
Subscribers
None

DOMHandlerFactory.php

<?php
declare( strict_types = 1 );
namespace Wikimedia\Parsoid\Html2Wt\DOMHandlers;
use Wikimedia\Parsoid\DOM\DocumentFragment;
use Wikimedia\Parsoid\DOM\Element;
use Wikimedia\Parsoid\DOM\Node;
use Wikimedia\Parsoid\Utils\DOMCompat;
use Wikimedia\Parsoid\Utils\DOMDataUtils;
use Wikimedia\Parsoid\Utils\DOMUtils;
use Wikimedia\Parsoid\Utils\WTUtils;
use Wikimedia\Parsoid\Wikitext\Consts;
/**
* Factory for picking the right DOMHandler for a DOM element.
* FIXME: memoize handlers, maybe?
*/
class DOMHandlerFactory {
/**
* Get the DOMHandler that's appropriate for serializing a HTML tag.
*
* Porting note: this is the equivalent of DOMHandlers.tagHandlers[tag].
* @param string $tag
* @return DOMHandler|null
*/
public function newFromTagHandler( string $tag ): ?DOMHandler {
switch ( $tag ) {
case 'a':
return new AHandler();
case 'audio':
return new MediaHandler();
case 'b':
return new QuoteHandler( "'''" );
case 'body':
return new BodyHandler();
case 'br':
return new BRHandler();
case 'caption':
return new CaptionHandler();
case 'dd':
return new DDHandler(); // multi-line dt/dd
case 'dd_row':
return new DDHandler( 'row' ); // single-line dt/dd
case 'dl':
return new ListHandler( [ 'dt', 'dd' ] );
case 'dt':
return new DTHandler();
case 'figure':
return new FigureHandler();
// TODO: Remove when 2.1.x content is deprecated, since we no
// longer emit inline media in figure-inline. See the test,
// "Serialize simple image with figure-inline wrapper"
case 'figure-inline':
return new MediaHandler();
case 'hr':
return new HRHandler();
case 'h1':
return new HeadingHandler( '=' );
case 'h2':
return new HeadingHandler( '==' );
case 'h3':
return new HeadingHandler( '===' );
case 'h4':
return new HeadingHandler( '====' );
case 'h5':
return new HeadingHandler( '=====' );
case 'h6':
return new HeadingHandler( '======' );
case 'i':
return new QuoteHandler( "''" );
case 'img':
return new ImgHandler();
case 'li':
return new LIHandler();
case 'link':
return new LinkHandler();
case 'meta':
return new MetaHandler();
case 'ol':
return new ListHandler( [ 'li' ] );
case 'p':
return new PHandler();
case 'pre':
return new PreHandler(); // Wikitext indent pre generated with leading space
case 'pre_html':
return new HTMLPreHandler(); // HTML pre
case 'span':
return new SpanHandler();
case 'table':
return new TableHandler();
case 'tbody':
return new JustChildrenHandler();
case 'td':
return new TDHandler();
case 'tfoot':
return new JustChildrenHandler();
case 'th':
return new THHandler();
case 'thead':
return new JustChildrenHandler();
case 'tr':
return new TRHandler();
case 'ul':
return new ListHandler( [ 'li' ] );
case 'video':
return new MediaHandler();
default:
return null;
}
}
/**
* Get a DOMHandler for an element node.
* @param ?Node $node
* @return DOMHandler
*/
public function getDOMHandler( ?Node $node ): DOMHandler {
if ( $node instanceof DocumentFragment ) {
return new BodyHandler();
}
if ( !( $node instanceof Element ) ) {
return new DOMHandler();
}
'@phan-var Element $node';/** @var Element $node */
if ( WTUtils::isFirstEncapsulationWrapperNode( $node ) ) {
return new EncapsulatedContentHandler();
}
$dp = DOMDataUtils::getDataParsoid( $node );
// If available, use a specialized handler for serializing
// to the specialized syntactic form of the tag.
$handler = $this->newFromTagHandler( DOMCompat::nodeName( $node ) . '_' . ( $dp->stx ?? null ) );
// Unless a specialized handler is available, use the HTML handler
// for html-stx tags. But, <a> tags should never serialize as HTML.
if ( !$handler && ( $dp->stx ?? null ) === 'html' && DOMCompat::nodeName( $node ) !== 'a' ) {
return new FallbackHTMLHandler();
}
// If in a HTML table tag, serialize table tags in the table
// using HTML tags, instead of native wikitext tags.
if ( isset( Consts::$HTML['ChildTableTags'][DOMCompat::nodeName( $node )] )
&& !isset( Consts::$ZeroWidthWikitextTags[DOMCompat::nodeName( $node )] )
&& WTUtils::inHTMLTableTag( $node )
) {
return new FallbackHTMLHandler();
}
// If parent node is a list in html-syntax, then serialize
// list content in html-syntax rather than wiki-syntax.
if ( DOMUtils::isListItem( $node )
&& DOMUtils::isList( $node->parentNode )
&& WTUtils::isLiteralHTMLNode( $node->parentNode )
) {
return new FallbackHTMLHandler();
}
// Pick the best available handler
return $handler ?: $this->newFromTagHandler( DOMCompat::nodeName( $node ) ) ?: new FallbackHTMLHandler();
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Nov 21, 23:21 (1 d, 19 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
16/3f/665a5e497dd4f50ff1c653767b89
Default Alt Text
DOMHandlerFactory.php (4 KB)

Event Timeline