mediawiki-extensions-CodeEd.../includes/CodeEditorHooks.php
Derick Alangi ef09440a94 Fix PHPDoc comment @return for CodeEditorHooks methods
Should return "true" (as there is no case for false) and not bool.

Change-Id: I2badcbb3b06c8a9593908b064629bfef8ea82488
2019-01-16 14:46:28 +01:00

64 lines
1.7 KiB
PHP

<?php
class CodeEditorHooks {
/**
* @param Title $title
* @param string $model
* @param string $format
* @return null|string
*/
public static function getPageLanguage( Title $title, $model, $format ) {
global $wgCodeEditorEnableCore;
if ( $wgCodeEditorEnableCore ) {
if ( $model === CONTENT_MODEL_JAVASCRIPT ) {
return 'javascript';
} elseif ( $model === CONTENT_MODEL_CSS ) {
return 'css';
} elseif ( $model === CONTENT_MODEL_JSON ) {
return 'json';
}
}
// Give extensions a chance
// Note: $model and $format were added around the time of MediaWiki 1.28.
$lang = null;
Hooks::run( 'CodeEditorGetPageLanguage', [ $title, &$lang, $model, $format ] );
return $lang;
}
/**
* @param User $user
* @param array &$defaultPreferences
* @return true
*/
public static function getPreferences( User $user, &$defaultPreferences ) {
$defaultPreferences['usecodeeditor'] = [
'type' => 'api',
'default' => '1',
];
return true;
}
/**
* @param EditPage $editpage
* @param OutputPage $output
* @return true
*/
public static function editPageShowEditFormInitial( EditPage $editpage, OutputPage $output ) {
$title = $editpage->getContextTitle();
$model = $editpage->contentModel;
$format = $editpage->contentFormat;
$lang = self::getPageLanguage( $title, $model, $format );
if ( $lang && $output->getUser()->getOption( 'usebetatoolbar' ) ) {
$output->addModules( 'ext.codeEditor' );
$output->addJsConfigVars( 'wgCodeEditorCurrentLanguage', $lang );
} elseif ( !ExtensionRegistry::getInstance()->isLoaded( "WikiEditor" ) ) {
throw new ErrorPageError( "codeeditor-error-title", "codeeditor-error-message" );
}
return true;
}
}