type = $type; $this->level = $level; $this->range = $range; } /** * @return array JSON-serializable array */ public function jsonSerialize() : array { // The output of this method can end up in the HTTP cache (Varnish). Avoid changing it; // and when doing so, ensure that frontend code can handle both the old and new outputs. // See ThreadItem.static.newFromJSON in JS. return [ 'type' => $this->type, 'level' => $this->level, 'id' => $this->id, 'replies' => array_map( function ( ThreadItem $comment ) { return $comment->getId(); }, $this->replies ) ]; } /** * Get the list of authors in the comment tree below this thread item. * * Usually called on a HeadingItem to find all authors in a thread. * * @return string[] Author usernames */ public function getAuthorsBelow() : array { $authors = []; $getAuthorSet = function ( ThreadItem $comment ) use ( &$authors, &$getAuthorSet ) { if ( $comment instanceof CommentItem ) { $author = $comment->getAuthor(); if ( $author ) { $authors[ $author ] = true; } } // Get the set of authors in the same format from each reply array_map( $getAuthorSet, $comment->getReplies() ); }; array_map( $getAuthorSet, $this->getReplies() ); ksort( $authors ); return array_keys( $authors ); } /** * Get the name of the page from which this thread item is transcluded (if any). * * @return string|bool `false` if this item is not transcluded. A string if it's transcluded * from a single page (the page title, in text form with spaces). `true` if it's transcluded, but * we can't determine the source. */ public function getTranscludedFrom() { // If some template is used within the comment (e.g. {{ping|…}} or {{tl|…}}, or a // non-substituted signature template), that *does not* mean the comment is transcluded. // We only want to consider comments to be transcluded if all wrapper elements (usually //

) are marked as part of a single transclusion. // If we can't find "exact" wrappers, using only the end container works out well // (because the main purpose of this method is to decide on which page we should post // replies to the given comment, and they'll go after the comment). $coveredNodes = CommentUtils::getFullyCoveredSiblings( $this ) ?: [ $this->getRange()->endContainer ]; $node = CommentUtils::getTranscludedFromElement( $coveredNodes[ 0 ] ); $length = count( $coveredNodes ); for ( $i = 1; $i < $length; $i++ ) { if ( $node !== CommentUtils::getTranscludedFromElement( $coveredNodes[ $i ] ) ) { // Comment is only partially transcluded, that should be fine return false; } } if ( !$node ) { // No mw:Transclusion node found, this item is not transcluded return false; } $dataMw = json_decode( $node->getAttribute( 'data-mw' ), true ); // Only return a page name if this is a simple single-template transclusion. if ( is_array( $dataMw ) && $dataMw['parts'] && count( $dataMw['parts'] ) === 1 && $dataMw['parts'][0]['template'] && // 'href' will be unset if this is a parser function rather than a template isset( $dataMw['parts'][0]['template']['target']['href'] ) ) { $title = CommentUtils::getTitleFromUrl( $dataMw['parts'][0]['template']['target']['href'] ); return $title->getPrefixedText(); } // Multi-template transclusion, or a parser function call, or template-affected wikitext outside // of a template call, or a mix of the above return true; } /** * Get the HTML of this thread item * * @return string HTML */ public function getHTML() : string { $fragment = $this->getRange()->cloneContents(); CommentModifier::unwrapFragment( $fragment ); $container = $fragment->ownerDocument->createElement( 'div' ); $container->appendChild( $fragment ); return DOMCompat::getInnerHTML( $container ); } /** * Get the text of this thread item * * @return string Text */ public function getText() : string { $fragment = $this->getRange()->cloneContents(); return $fragment->textContent; } /** * @return string Thread item type */ public function getType() : string { return $this->type; } /** * @return int Indentation level */ public function getLevel() : int { return $this->level; } /** * @return ThreadItem|null Parent thread item */ public function getParent() : ?ThreadItem { return $this->parent; } /** * @return ImmutableRange Range of the entire thread item */ public function getRange() : ImmutableRange { return $this->range; } /** * @return DOMNode Root node (level is relative to this node) */ public function getRootNode() : DOMNode { return $this->rootNode; } /** * @return string Thread item name */ public function getName() : string { return $this->name; } /** * @return string Thread ID */ public function getId() : string { return $this->id; } /** * @return string|null Thread ID, according to an older algorithm */ public function getLegacyId() : ?string { return $this->legacyId; } /** * @return ThreadItem[] Replies to this thread item */ public function getReplies() : array { return $this->replies; } /** * @return string[] Warnings */ public function getWarnings() : array { return $this->warnings; } /** * @param int $level Indentation level */ public function setLevel( int $level ) : void { $this->level = $level; } /** * @param ThreadItem $parent */ public function setParent( ThreadItem $parent ) { $this->parent = $parent; } /** * @param ImmutableRange $range Thread item range */ public function setRange( ImmutableRange $range ) : void { $this->range = $range; } /** * @param DOMNode $rootNode Root node (level is relative to this node) */ public function setRootNode( DOMNode $rootNode ) : void { $this->rootNode = $rootNode; } /** * @param string|null $name Thread item name */ public function setName( ?string $name ) : void { $this->name = $name; } /** * @param string|null $id Thread ID */ public function setId( ?string $id ) : void { $this->id = $id; } /** * @param string|null $id Thread ID */ public function setLegacyId( ?string $id ) : void { $this->legacyId = $id; } /** * @param string $warning */ public function addWarning( string $warning ) : void { $this->warnings[] = $warning; } /** * @param string[] $warnings */ public function addWarnings( array $warnings ) : void { $this->warnings = array_merge( $this->warnings, $warnings ); } /** * @param ThreadItem $reply Reply comment */ public function addReply( ThreadItem $reply ) : void { $this->replies[] = $reply; } }