MediaWiki  1.23.2
generateJqueryMsgData.php
Go to the documentation of this file.
1 <?php
16 /*
17  * @example QUnit
18  * <code>
19  QUnit.test( 'Output matches PHP parser', mw.libs.phpParserData.tests.length, function ( assert ) {
20  mw.messages.set( mw.libs.phpParserData.messages );
21  $.each( mw.libs.phpParserData.tests, function ( i, test ) {
22  QUnit.stop();
23  getMwLanguage( test.lang, function ( langClass ) {
24  var parser = new mw.jqueryMsg.parser( { language: langClass } );
25  assert.equal(
26  parser.parse( test.key, test.args ).html(),
27  test.result,
28  test.name
29  );
30  QUnit.start();
31  } );
32  } );
33  });
34  * </code>
35  *
36  * @example Jasmine
37  * <code>
38  describe( 'match output to output from PHP parser', function () {
39  mw.messages.set( mw.libs.phpParserData.messages );
40  $.each( mw.libs.phpParserData.tests, function ( i, test ) {
41  it( 'should parse ' + test.name, function () {
42  var langClass;
43  runs( function () {
44  getMwLanguage( test.lang, function ( gotIt ) {
45  langClass = gotIt;
46  });
47  });
48  waitsFor( function () {
49  return langClass !== undefined;
50  }, 'Language class should be loaded', 1000 );
51  runs( function () {
52  console.log( test.lang, 'running tests' );
53  var parser = new mw.jqueryMsg.parser( { language: langClass } );
54  expect(
55  parser.parse( test.key, test.args ).html()
56  ).toEqual( test.result );
57  } );
58  } );
59  } );
60  } );
61  * </code>
62  */
63 
64 require __DIR__ . '/../../../maintenance/Maintenance.php';
65 
67 
69  'undelete_short' => array(
70  array( 0 ),
71  array( 1 ),
72  array( 2 ),
73  array( 5 ),
74  array( 21 ),
75  array( 101 )
76  ),
77  'category-subcat-count' => array(
78  array( 0, 10 ),
79  array( 1, 1 ),
80  array( 1, 2 ),
81  array( 3, 30 )
82  )
83  );
84 
85  public function __construct() {
86  parent::__construct();
87  $this->mDescription = 'Create a specification for message parsing ini JSON format';
88  // add any other options here
89  }
90 
91  public function execute() {
92  list( $messages, $tests ) = $this->getMessagesAndTests();
93  $this->writeJavascriptFile( $messages, $tests, __DIR__ . '/mediawiki.jqueryMsg.data.js' );
94  }
95 
96  private function getMessagesAndTests() {
97  $messages = array();
98  $tests = array();
99  foreach ( array( 'en', 'fr', 'ar', 'jp', 'zh' ) as $languageCode ) {
100  foreach ( self::$keyToTestArgs as $key => $testArgs ) {
101  foreach ( $testArgs as $args ) {
102  // Get the raw message, without any transformations.
103  $template = wfMessage( $key )->inLanguage( $languageCode )->plain();
104 
105  // Get the magic-parsed version with args.
106  $result = wfMessage( $key, $args )->inLanguage( $languageCode )->text();
107 
108  // Record the template, args, language, and expected result
109  // fake multiple languages by flattening them together.
110  $langKey = $languageCode . '_' . $key;
111  $messages[$langKey] = $template;
112  $tests[] = array(
113  'name' => $languageCode . ' ' . $key . ' ' . join( ',', $args ),
114  'key' => $langKey,
115  'args' => $args,
116  'result' => $result,
117  'lang' => $languageCode
118  );
119  }
120  }
121  }
122  return array( $messages, $tests );
123  }
124 
125  private function writeJavascriptFile( $messages, $tests, $dataSpecFile ) {
126  $phpParserData = array(
127  'messages' => $messages,
128  'tests' => $tests,
129  );
130 
131  $output =
132  "// This file stores the output from the PHP parser for various messages, arguments,\n"
133  . "// languages, and parser modes. Intended for use by a unit test framework by looping\n"
134  . "// through the object and comparing its parser return value with the 'result' property.\n"
135  . '// Last generated with ' . basename( __FILE__ ) . ' at ' . gmdate( 'r' ) . "\n"
136  // This file will contain unquoted JSON strings as javascript native object literals,
137  // flip the quotemark convention for this file.
138  . "\n"
139  . 'mediaWiki.libs.phpParserData = ' . FormatJson::encode( $phpParserData, true ) . ";\n";
140 
141  $fp = file_put_contents( $dataSpecFile, $output );
142  if ( $fp === false ) {
143  die( "Couldn't write to $dataSpecFile." );
144  }
145  }
146 }
147 
148 $maintClass = "GenerateJqueryMsgData";
149 require_once RUN_MAINTENANCE_IF_MAIN;
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
$messages
$messages
Definition: LogTests.i18n.php:8
GenerateJqueryMsgData\writeJavascriptFile
writeJavascriptFile( $messages, $tests, $dataSpecFile)
Definition: generateJqueryMsgData.php:125
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:104
GenerateJqueryMsgData\$keyToTestArgs
static $keyToTestArgs
Definition: generateJqueryMsgData.php:68
GenerateJqueryMsgData\__construct
__construct()
Default constructor.
Definition: generateJqueryMsgData.php:85
GenerateJqueryMsgData\getMessagesAndTests
getMessagesAndTests()
Definition: generateJqueryMsgData.php:96
wfMessage
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
GenerateJqueryMsgData
This PHP script defines the spec that the mediawiki.jqueryMsg module should conform to.
Definition: generateJqueryMsgData.php:66
$args
if( $line===false) $args
Definition: cdb.php:62
$output
& $output
Definition: hooks.txt:375
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
$maintClass
$maintClass
Definition: generateJqueryMsgData.php:148
GenerateJqueryMsgData\execute
execute()
Do the actual work.
Definition: generateJqueryMsgData.php:91