Page MenuHomeWickedGov Phorge
Files F5957962

PageConfig.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

PageConfig.php
View Options

<?php
/**
* Copyright (C) 2011-2022 Wikimedia Foundation and others.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
namespace MediaWiki\Parser\Parsoid\Config;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Revision\SlotRoleHandler;
use MediaWiki\Title\Title;
use Wikimedia\Bcp47Code\Bcp47Code;
use Wikimedia\Parsoid\Config\PageConfig as IPageConfig;
use Wikimedia\Parsoid\Config\PageContent as IPageContent;
/**
* Page-level configuration interface for Parsoid
*
* This is effectively "Parsoid's view of ParserOptions".
*
* @since 1.39
* @internal
*/
class PageConfig extends IPageConfig {
private ParserOptions $parserOptions;
private SlotRoleHandler $slotRoleHandler;
private Title $title;
private ?RevisionRecord $revision = null;
private Bcp47Code $pageLanguage;
private string $pageLanguageDir;
/**
* @param ParserOptions $parserOptions
* @param SlotRoleHandler $slotRoleHandler
* @param Title $title Title being parsed
* @param ?RevisionRecord $revision
* @param Bcp47Code $pageLanguage
* @param string $pageLanguageDir
*/
public function __construct(
ParserOptions $parserOptions,
SlotRoleHandler $slotRoleHandler,
Title $title,
?RevisionRecord $revision,
Bcp47Code $pageLanguage,
string $pageLanguageDir
) {
$this->parserOptions = $parserOptions;
$this->slotRoleHandler = $slotRoleHandler;
$this->title = $title;
$this->revision = $revision;
$this->pageLanguage = $pageLanguage;
$this->pageLanguageDir = $pageLanguageDir;
}
/**
* Get content model
* @return string
*/
public function getContentModel(): string {
// @todo Check just the main slot, or all slots, or what?
$rev = $this->getRevision();
if ( $rev ) {
$content = $rev->getContent( SlotRecord::MAIN );
if ( $content ) {
return $content->getModel();
} else {
// The page does have a content model but we can't see it. Returning the
// default model is not really correct. But we can't see the content either
// so it won't matter much what we do here.
return $this->slotRoleHandler->getDefaultModel( $this->title );
}
} else {
return $this->slotRoleHandler->getDefaultModel( $this->title );
}
}
/** @inheritDoc */
public function getLinkTarget(): Title {
return $this->title;
}
/** @inheritDoc */
public function getPageId(): int {
return $this->title->getArticleID();
}
/** @inheritDoc */
public function getPageLanguageBcp47(): Bcp47Code {
return $this->pageLanguage;
}
/** @inheritDoc */
public function getPageLanguageDir(): string {
return $this->pageLanguageDir;
}
/**
* @internal Used by DataAccess; not part of Parsoid's interface.
* @return ParserOptions
*/
public function getParserOptions(): ParserOptions {
return $this->parserOptions;
}
/**
* Use ParserOptions::getTemplateCallback() to fetch the correct
* (usually latest) RevisionRecord for the given title.
*
* @param Title $title
* @return ?RevisionRecord
*/
public function fetchRevisionRecordOfTemplate( Title $title ): ?RevisionRecord {
// See Parser::fetchTemplateAndTitle(), but stateless
// (Parsoid will track dependencies, etc, itself.)
// The callback defaults to Parser::statelessFetchTemplate()
$templateCb = $this->parserOptions->getTemplateCallback();
$stuff = $templateCb( $title, $this );
return $stuff['revision-record'] ?? null;
}
/**
* @return ?RevisionRecord
*/
private function getRevision(): ?RevisionRecord {
return $this->revision;
}
/** @inheritDoc */
public function getRevisionId(): ?int {
$rev = $this->getRevision();
return $rev ? $rev->getId() : null;
}
/** @inheritDoc */
public function getParentRevisionId(): ?int {
$rev = $this->getRevision();
return $rev ? $rev->getParentId() : null;
}
/** @inheritDoc */
public function getRevisionTimestamp(): ?string {
$rev = $this->getRevision();
return $rev ? $rev->getTimestamp() : null;
}
/** @inheritDoc */
public function getRevisionUser(): ?string {
$rev = $this->getRevision();
$user = $rev ? $rev->getUser() : null;
return $user ? $user->getName() : null;
}
/** @inheritDoc */
public function getRevisionUserId(): ?int {
$rev = $this->getRevision();
$user = $rev ? $rev->getUser() : null;
return $user ? $user->getId() : null;
}
/** @inheritDoc */
public function getRevisionSha1(): ?string {
$rev = $this->getRevision();
if ( $rev ) {
// This matches what the Parsoid/JS gets from the API
// FIXME: Maybe we don't need to do this in the future?
return \Wikimedia\base_convert( $rev->getSha1(), 36, 16, 40 );
} else {
return null;
}
}
/** @inheritDoc */
public function getRevisionSize(): ?int {
$rev = $this->getRevision();
return $rev ? $rev->getSize() : null;
}
/** @inheritDoc */
public function getRevisionContent(): ?IPageContent {
$rev = $this->getRevision();
return $rev ? new PageContent( $rev ) : null;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 05:27 (2 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ea/98/392a95a0f58f8aebb7ee03b581ff
Default Alt Text
PageConfig.php (5 KB)

Event Timeline