Page MenuHomeWickedGov Phorge
Files F4156667

GadgetDefinitionContentHandler.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

GadgetDefinitionContentHandler.php
View Options

<?php
/**
* 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.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Extension\Gadgets\Content;
use MediaWiki\Content\Content;
use MediaWiki\Content\JsonContentHandler;
use MediaWiki\Content\Renderer\ContentParseParams;
use MediaWiki\Content\ValidationParams;
use MediaWiki\Extension\Gadgets\GadgetRepo;
use MediaWiki\Extension\Gadgets\MediaWikiGadgetsJsonRepo;
use MediaWiki\Json\FormatJson;
use MediaWiki\Linker\Linker;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Title\Title;
use StatusValue;
class GadgetDefinitionContentHandler extends JsonContentHandler {
public function __construct(
string $modelId,
private readonly GadgetRepo $gadgetRepo,
) {
parent::__construct( $modelId );
}
/**
* @param Title $title
* @return bool
*/
public function canBeUsedOn( Title $title ) {
return MediaWikiGadgetsJsonRepo::isGadgetDefinitionTitle( $title );
}
/** @inheritDoc */
protected function getContentClass() {
return GadgetDefinitionContent::class;
}
/** @inheritDoc */
public function makeEmptyContent() {
$class = $this->getContentClass();
return new $class( FormatJson::encode( $this->getEmptyDefinition(), "\t" ) );
}
/**
* @param Content $content
* @param ValidationParams $validationParams
* @return StatusValue
*/
public function validateSave( Content $content, ValidationParams $validationParams ) {
$status = parent::validateSave( $content, $validationParams );
'@phan-var GadgetDefinitionContent $content';
if ( !$status->isOK() ) {
return $content->validate();
}
return $status;
}
/**
* @return array<string,array>
*/
public function getEmptyDefinition() {
return [
'settings' => [
'section' => '',
],
'module' => [
'pages' => [],
'dependencies' => [],
]
];
}
/**
* @return array<string,array>
*/
public function getDefaultMetadata() {
return [
'settings' => [
'rights' => [],
'default' => false,
'package' => false,
'requiresES6' => false,
'hidden' => false,
'skins' => [],
'actions' => [],
'namespaces' => [],
'categories' => [],
'contentModels' => [],
'section' => '',
'supportsUrlLoad' => false,
],
'module' => [
'pages' => [],
'peers' => [],
'dependencies' => [],
'messages' => [],
'codexIcons' => [],
'type' => '',
],
];
}
/**
* @inheritDoc
*/
protected function fillParserOutput(
Content $content,
ContentParseParams $cpoParams,
ParserOutput &$parserOutput
) {
'@phan-var GadgetDefinitionContent $content';
// Create a deep clone. FIXME: unserialize(serialize()) is hacky.
$data = unserialize( serialize( $content->getData()->getValue() ) );
if ( $data !== null ) {
if ( isset( $data->module->pages ) ) {
foreach ( $data->module->pages as &$page ) {
$title = Title::makeTitleSafe( NS_MEDIAWIKI, "Gadget-$page" );
$this->makeLink( $parserOutput, $page, $title );
}
}
if ( isset( $data->module->dependencies ) ) {
foreach ( $data->module->dependencies as &$dep ) {
if ( str_starts_with( $dep, 'ext.gadget.' ) ) {
$gadgetId = explode( 'ext.gadget.', $dep )[ 1 ];
$title = $this->gadgetRepo->getGadgetDefinitionTitle( $gadgetId );
$this->makeLink( $parserOutput, $dep, $title );
}
}
}
if ( isset( $data->module->peers ) ) {
foreach ( $data->module->peers as &$peer ) {
$title = $this->gadgetRepo->getGadgetDefinitionTitle( $peer );
$this->makeLink( $parserOutput, $peer, $title );
}
}
if ( isset( $data->module->messages ) ) {
foreach ( $data->module->messages as &$msg ) {
$title = Title::makeTitleSafe( NS_MEDIAWIKI, $msg );
$this->makeLink( $parserOutput, $msg, $title );
}
}
if ( isset( $data->settings->categories ) ) {
foreach ( $data->settings->categories as &$category ) {
$title = Title::makeTitleSafe( NS_CATEGORY, $category );
$this->makeLink( $parserOutput, $category, $title );
}
}
if ( isset( $data->settings->section ) && $data->settings->section ) {
$this->makeLink(
$parserOutput,
$data->settings->section,
Title::makeTitleSafe( NS_MEDIAWIKI, "gadget-section-" . $data->settings->section )
);
}
}
if ( !$cpoParams->getGenerateHtml() || !$content->isValid() ) {
$parserOutput->setContentHolderText( '' );
} else {
$parserOutput->setContentHolderText( $content->rootValueTable( $data ) );
$parserOutput->addModuleStyles( [ 'mediawiki.content.json' ] );
}
}
/**
* Create a link on the page
* @param ParserOutput $parserOutput
* @param string &$text The text to link
* @param Title|null $title Link target title
* @return void
*/
private function makeLink( ParserOutput $parserOutput, string &$text, ?Title $title ) {
if ( $title ) {
$parserOutput->addLink( $title );
$text = new GadgetDefinitionContentArmor(
Linker::link( $title, htmlspecialchars( '"' . $text . '"' ) )
);
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 22:26 (8 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c5/de/bb6e780de3b73d866733f4725683
Default Alt Text
GadgetDefinitionContentHandler.php (5 KB)

Event Timeline