Page MenuHomeWickedGov Phorge
Files F4107217

ContentHeadingItem.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ContentHeadingItem.php
View Options

<?php
namespace MediaWiki\Extension\DiscussionTools\ThreadItem;
use MediaWiki\Extension\DiscussionTools\ImmutableRange;
use Wikimedia\Assert\Assert;
use Wikimedia\Parsoid\DOM\Element;
class ContentHeadingItem extends ContentThreadItem implements HeadingItem {
use HeadingItemTrait {
jsonSerialize as traitJsonSerialize;
}
private bool $placeholderHeading;
private int $headingLevel;
private bool $uneditableSection = false;
// Placeholder headings must have a level higher than real headings (1-6)
private const PLACEHOLDER_HEADING_LEVEL = 99;
/**
* @param ImmutableRange $range
* @param bool|string $transcludedFrom
* @param ?int $headingLevel Heading level (1-6). Use null for a placeholder heading.
*/
public function __construct(
ImmutableRange $range, $transcludedFrom, ?int $headingLevel
) {
parent::__construct( 'heading', 0, $range, $transcludedFrom );
$this->placeholderHeading = $headingLevel === null;
$this->headingLevel = $this->placeholderHeading ? static::PLACEHOLDER_HEADING_LEVEL : $headingLevel;
}
/**
* Get a title based on the hash ID, such that it can be linked to
*
* @return string Title
*/
public function getLinkableTitle(): string {
$title = '';
// If this comment is in 0th section, there's no section title for the edit summary
if ( !$this->isPlaceholderHeading() ) {
$id = $this->getLinkableId();
if ( $id ) {
// Replace underscores with spaces to undo Sanitizer::escapeIdInternal().
// This assumes that $wgFragmentMode is [ 'html5', 'legacy' ] or [ 'html5' ],
// otherwise the escaped IDs are super garbled and can't be unescaped reliably.
$title = str_replace( '_', ' ', $id );
}
// else: Not a real section, probably just HTML markup in wikitext
}
return $title;
}
/**
* Return the ID found on the headline node, if it has one.
*
* In Parsoid HTML, it is stored in the `<hN id>` attribute.
* In legacy parser HTML, it is stored in the `<hN data-mw-anchor>` attribute.
* In integration tests and in JS, things are a little bit wilder than that.
*
* @return string
*/
public function getLinkableId(): string {
$headline = $this->getHeadlineNode();
return ( $headline->getAttribute( 'id' ) ?: $headline->getAttribute( 'data-mw-anchor' ) ) ?? '';
}
/**
* Return the node on which the ID attribute is set.
*
* @return Element Headline node, normally a `<h1>`-`<h6>` element (unless it's a placeholder heading).
* In integration tests and in JS, it can be a `<span class="mw-headline">` (see T363031).
*/
public function getHeadlineNode(): Element {
// This value comes from CommentUtils::getHeadlineNode(), this function just guarantees the type
$headline = $this->getRange()->startContainer;
Assert::precondition( $headline instanceof Element, 'HeadingItem refers to an element node' );
return $headline;
}
public function isUneditableSection(): bool {
return $this->uneditableSection;
}
/**
* @param bool $uneditableSection The heading represents a section that can't be
* edited on its own.
*/
public function setUneditableSection( bool $uneditableSection ): void {
$this->uneditableSection = $uneditableSection;
}
/**
* @return int Heading level (1-6)
*/
public function getHeadingLevel(): int {
return $this->headingLevel;
}
/**
* @param int $headingLevel Heading level (1-6)
*/
public function setHeadingLevel( int $headingLevel ): void {
$this->headingLevel = $headingLevel;
}
public function isPlaceholderHeading(): bool {
return $this->placeholderHeading;
}
public function setPlaceholderHeading( bool $placeholderHeading ): void {
$this->placeholderHeading = $placeholderHeading;
}
/**
* @inheritDoc
*/
public function jsonSerialize( bool $deep = false, ?callable $callback = null ): array {
$data = $this->traitJsonSerialize( $deep, $callback );
// When this is false (which is most of the time), omit the key for efficiency
if ( $this->isUneditableSection() ) {
$data[ 'uneditableSection' ] = true;
}
return $data;
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 19:57 (2 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a2/40/96924d83f145514dfdc342f6219c
Default Alt Text
ContentHeadingItem.php (3 KB)

Event Timeline