6806400129
Reasons for touching this are:
* "@param type $var" were mixed in a lot of places. Both works but the
MediaWiki coding conventions suggest that specific order.
* Things like String and Bool aren't objects and shouldn't be uppercase.
* Tried to fill missing types in "@param $var".
* Tried to fill missing descriptions in "@return type" when I could.
* Removed duplicate descriptions if a @see is sufficend.
* Removed useless descriptions ("isUsefull returns true if usefull").
* Removed useless @return void.
* Replaces mixed[] with array (does have the exact same meaning).
* Tried to find better replacements for "varargs", phpDocumentor
suggest $var,...
* Order should be @since, @param, @throws, @return, @see. This is the
order Doxygen renders this.
There is always more to do but I think this is already much better
than before. Please feel free to put more change sets on top of mine
or request more changes by adding comments.
Change-Id: I05262ce06caabf79f68772302524ac91bbead1c6
75 lines
1.9 KiB
PHP
75 lines
1.9 KiB
PHP
<?php
|
|
/**
|
|
* Content for JavaScript pages.
|
|
*
|
|
* 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
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @file
|
|
* @ingroup Content
|
|
*
|
|
* @author Daniel Kinzler
|
|
*/
|
|
|
|
/**
|
|
* Content for JavaScript pages.
|
|
*
|
|
* @ingroup Content
|
|
*/
|
|
class JavaScriptContent extends TextContent {
|
|
|
|
/**
|
|
* @param string $text JavaScript code.
|
|
*/
|
|
public function __construct( $text ) {
|
|
parent::__construct( $text, CONTENT_MODEL_JAVASCRIPT );
|
|
}
|
|
|
|
/**
|
|
* Returns a Content object with pre-save transformations applied using
|
|
* Parser::preSaveTransform().
|
|
*
|
|
* @param Title $title
|
|
* @param User $user
|
|
* @param ParserOptions $popts
|
|
*
|
|
* @return JavaScriptContent
|
|
*/
|
|
public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
|
|
global $wgParser;
|
|
// @todo Make pre-save transformation optional for script pages
|
|
// See bug #32858
|
|
|
|
$text = $this->getNativeData();
|
|
$pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
|
|
|
|
return new JavaScriptContent( $pst );
|
|
}
|
|
|
|
/**
|
|
* @return string JavaScript wrapped in a <pre> tag.
|
|
*/
|
|
protected function getHtml() {
|
|
$html = "";
|
|
$html .= "<pre class=\"mw-code mw-js\" dir=\"ltr\">\n";
|
|
$html .= $this->getHighlightHtml();
|
|
$html .= "\n</pre>\n";
|
|
|
|
return $html;
|
|
}
|
|
|
|
}
|