MediaWiki  master
ApiParse.php
Go to the documentation of this file.
1 <?php
24 
28 class ApiParse extends ApiBase {
29 
31  private $section = null;
32 
34  private $content = null;
35 
37  private $pstContent = null;
38 
40  private $contentIsDeleted = false, $contentIsSuppressed = false;
41 
42  public function execute() {
43  // The data is hot but user-dependent, like page views, so we set vary cookies
44  $this->getMain()->setCacheMode( 'anon-public-user-private' );
45 
46  // Get parameters
47  $params = $this->extractRequestParams();
48 
49  // No easy way to say that text and title or revid are allowed together
50  // while the rest aren't, so just do it in three calls.
51  $this->requireMaxOneParameter( $params, 'page', 'pageid', 'oldid', 'text' );
52  $this->requireMaxOneParameter( $params, 'page', 'pageid', 'oldid', 'title' );
53  $this->requireMaxOneParameter( $params, 'page', 'pageid', 'oldid', 'revid' );
54 
55  $text = $params['text'];
56  $title = $params['title'];
57  if ( $title === null ) {
58  $titleProvided = false;
59  // A title is needed for parsing, so arbitrarily choose one
60  $title = 'API';
61  } else {
62  $titleProvided = true;
63  }
64 
65  $page = $params['page'];
66  $pageid = $params['pageid'];
67  $oldid = $params['oldid'];
68 
69  $model = $params['contentmodel'];
70  $format = $params['contentformat'];
71 
72  $prop = array_flip( $params['prop'] );
73 
74  if ( isset( $params['section'] ) ) {
75  $this->section = $params['section'];
76  if ( !preg_match( '/^((T-)?\d+|new)$/', $this->section ) ) {
77  $this->dieWithError( 'apierror-invalidsection' );
78  }
79  } else {
80  $this->section = false;
81  }
82 
83  // The parser needs $wgTitle to be set, apparently the
84  // $title parameter in Parser::parse isn't enough *sigh*
85  // TODO: Does this still need $wgTitle?
86  global $wgTitle;
87 
88  $redirValues = null;
89 
90  $needContent = isset( $prop['wikitext'] ) ||
91  isset( $prop['parsetree'] ) || $params['generatexml'];
92 
93  // Return result
94  $result = $this->getResult();
95 
96  if ( !is_null( $oldid ) || !is_null( $pageid ) || !is_null( $page ) ) {
97  if ( $this->section === 'new' ) {
98  $this->dieWithError( 'apierror-invalidparammix-parse-new-section', 'invalidparammix' );
99  }
100  if ( !is_null( $oldid ) ) {
101  // Don't use the parser cache
102  $rev = Revision::newFromId( $oldid );
103  if ( !$rev ) {
104  $this->dieWithError( [ 'apierror-nosuchrevid', $oldid ] );
105  }
106 
107  $this->checkTitleUserPermissions( $rev->getTitle(), 'read' );
108  if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
109  $this->dieWithError(
110  [ 'apierror-permissiondenied', $this->msg( 'action-deletedtext' ) ]
111  );
112  }
113 
114  $titleObj = $rev->getTitle();
115  $wgTitle = $titleObj;
116  $pageObj = WikiPage::factory( $titleObj );
117  list( $popts, $reset, $suppressCache ) = $this->makeParserOptions( $pageObj, $params );
118  $p_result = $this->getParsedContent(
119  $pageObj, $popts, $suppressCache, $pageid, $rev, $needContent
120  );
121  } else { // Not $oldid, but $pageid or $page
122  if ( $params['redirects'] ) {
123  $reqParams = [
124  'redirects' => '',
125  ];
126  if ( !is_null( $pageid ) ) {
127  $reqParams['pageids'] = $pageid;
128  } else { // $page
129  $reqParams['titles'] = $page;
130  }
131  $req = new FauxRequest( $reqParams );
132  $main = new ApiMain( $req );
133  $pageSet = new ApiPageSet( $main );
134  $pageSet->execute();
135  $redirValues = $pageSet->getRedirectTitlesAsResult( $this->getResult() );
136 
137  $to = $page;
138  foreach ( $pageSet->getRedirectTitles() as $title ) {
139  $to = $title->getFullText();
140  }
141  $pageParams = [ 'title' => $to ];
142  } elseif ( !is_null( $pageid ) ) {
143  $pageParams = [ 'pageid' => $pageid ];
144  } else { // $page
145  $pageParams = [ 'title' => $page ];
146  }
147 
148  $pageObj = $this->getTitleOrPageId( $pageParams, 'fromdb' );
149  $titleObj = $pageObj->getTitle();
150  if ( !$titleObj || !$titleObj->exists() ) {
151  $this->dieWithError( 'apierror-missingtitle' );
152  }
153 
154  $this->checkTitleUserPermissions( $titleObj, 'read' );
155  $wgTitle = $titleObj;
156 
157  if ( isset( $prop['revid'] ) ) {
158  $oldid = $pageObj->getLatest();
159  }
160 
161  list( $popts, $reset, $suppressCache ) = $this->makeParserOptions( $pageObj, $params );
162  $p_result = $this->getParsedContent(
163  $pageObj, $popts, $suppressCache, $pageid, null, $needContent
164  );
165  }
166  } else { // Not $oldid, $pageid, $page. Hence based on $text
167  $titleObj = Title::newFromText( $title );
168  if ( !$titleObj || $titleObj->isExternal() ) {
169  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $title ) ] );
170  }
171  $revid = $params['revid'];
172  if ( $revid !== null ) {
173  $rev = Revision::newFromId( $revid );
174  if ( !$rev ) {
175  $this->dieWithError( [ 'apierror-nosuchrevid', $revid ] );
176  }
177  $pTitleObj = $titleObj;
178  $titleObj = $rev->getTitle();
179  if ( $titleProvided ) {
180  if ( !$titleObj->equals( $pTitleObj ) ) {
181  $this->addWarning( [ 'apierror-revwrongpage', $rev->getId(),
182  wfEscapeWikiText( $pTitleObj->getPrefixedText() ) ] );
183  }
184  } else {
185  // Consider the title derived from the revid as having
186  // been provided.
187  $titleProvided = true;
188  }
189  }
190  $wgTitle = $titleObj;
191  if ( $titleObj->canExist() ) {
192  $pageObj = WikiPage::factory( $titleObj );
193  } else {
194  // Do like MediaWiki::initializeArticle()
195  $article = Article::newFromTitle( $titleObj, $this->getContext() );
196  $pageObj = $article->getPage();
197  }
198 
199  list( $popts, $reset ) = $this->makeParserOptions( $pageObj, $params );
200  $textProvided = !is_null( $text );
201 
202  if ( !$textProvided ) {
203  if ( $titleProvided && ( $prop || $params['generatexml'] ) ) {
204  if ( $revid !== null ) {
205  $this->addWarning( 'apiwarn-parse-revidwithouttext' );
206  } else {
207  $this->addWarning( 'apiwarn-parse-titlewithouttext' );
208  }
209  }
210  // Prevent warning from ContentHandler::makeContent()
211  $text = '';
212  }
213 
214  // If we are parsing text, do not use the content model of the default
215  // API title, but default to wikitext to keep BC.
216  if ( $textProvided && !$titleProvided && is_null( $model ) ) {
217  $model = CONTENT_MODEL_WIKITEXT;
218  $this->addWarning( [ 'apiwarn-parse-nocontentmodel', $model ] );
219  }
220 
221  try {
222  $this->content = ContentHandler::makeContent( $text, $titleObj, $model, $format );
223  } catch ( MWContentSerializationException $ex ) {
224  $this->dieWithException( $ex, [
225  'wrap' => ApiMessage::create( 'apierror-contentserializationexception', 'parseerror' )
226  ] );
227  }
228 
229  if ( $this->section !== false ) {
230  if ( $this->section === 'new' ) {
231  // Insert the section title above the content.
232  if ( !is_null( $params['sectiontitle'] ) && $params['sectiontitle'] !== '' ) {
233  $this->content = $this->content->addSectionHeader( $params['sectiontitle'] );
234  }
235  } else {
236  $this->content = $this->getSectionContent( $this->content, $titleObj->getPrefixedText() );
237  }
238  }
239 
240  if ( $params['pst'] || $params['onlypst'] ) {
241  $this->pstContent = $this->content->preSaveTransform( $titleObj, $this->getUser(), $popts );
242  }
243  if ( $params['onlypst'] ) {
244  // Build a result and bail out
245  $result_array = [];
246  $result_array['text'] = $this->pstContent->serialize( $format );
247  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'text';
248  if ( isset( $prop['wikitext'] ) ) {
249  $result_array['wikitext'] = $this->content->serialize( $format );
250  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'wikitext';
251  }
252  if ( !is_null( $params['summary'] ) ||
253  ( !is_null( $params['sectiontitle'] ) && $this->section === 'new' )
254  ) {
255  $result_array['parsedsummary'] = $this->formatSummary( $titleObj, $params );
256  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'parsedsummary';
257  }
258 
259  $result->addValue( null, $this->getModuleName(), $result_array );
260 
261  return;
262  }
263 
264  // Not cached (save or load)
265  if ( $params['pst'] ) {
266  $p_result = $this->pstContent->getParserOutput( $titleObj, $revid, $popts );
267  } else {
268  $p_result = $this->content->getParserOutput( $titleObj, $revid, $popts );
269  }
270  }
271 
272  $result_array = [];
273 
274  $result_array['title'] = $titleObj->getPrefixedText();
275  $result_array['pageid'] = $pageid ?: $pageObj->getId();
276  if ( $this->contentIsDeleted ) {
277  $result_array['textdeleted'] = true;
278  }
279  if ( $this->contentIsSuppressed ) {
280  $result_array['textsuppressed'] = true;
281  }
282 
283  if ( isset( $params['useskin'] ) ) {
284  $factory = MediaWikiServices::getInstance()->getSkinFactory();
285  $skin = $factory->makeSkin( Skin::normalizeKey( $params['useskin'] ) );
286  } else {
287  $skin = null;
288  }
289 
290  $outputPage = null;
291  if ( $skin || isset( $prop['headhtml'] ) || isset( $prop['categorieshtml'] ) ) {
292  // Enabling the skin via 'useskin', 'headhtml', or 'categorieshtml'
293  // gets OutputPage and Skin involved, which (among others) applies
294  // these hooks:
295  // - ParserOutputHooks
296  // - Hook: LanguageLinks
297  // - Hook: OutputPageParserOutput
298  // - Hook: OutputPageMakeCategoryLinks
299  $context = new DerivativeContext( $this->getContext() );
300  $context->setTitle( $titleObj );
301  $context->setWikiPage( $pageObj );
302 
303  if ( $skin ) {
304  // Use the skin specified by 'useskin'
305  $context->setSkin( $skin );
306  // Context clones the skin, refetch to stay in sync. (T166022)
307  $skin = $context->getSkin();
308  } else {
309  // Make sure the context's skin refers to the context. Without this,
310  // $outputPage->getSkin()->getOutput() !== $outputPage which
311  // confuses some of the output.
312  $context->setSkin( $context->getSkin() );
313  }
314 
315  $outputPage = new OutputPage( $context );
316  $outputPage->addParserOutputMetadata( $p_result );
317  if ( $this->content ) {
318  $outputPage->addContentOverride( $titleObj, $this->content );
319  }
320  $context->setOutput( $outputPage );
321 
322  if ( $skin ) {
323  // Based on OutputPage::headElement()
324  $skin->setupSkinUserCss( $outputPage );
325  // Based on OutputPage::output()
326  $outputPage->loadSkinModules( $skin );
327  }
328 
329  Hooks::run( 'ApiParseMakeOutputPage', [ $this, $outputPage ] );
330  }
331 
332  if ( !is_null( $oldid ) ) {
333  $result_array['revid'] = (int)$oldid;
334  }
335 
336  if ( $params['redirects'] && !is_null( $redirValues ) ) {
337  $result_array['redirects'] = $redirValues;
338  }
339 
340  if ( isset( $prop['text'] ) ) {
341  $result_array['text'] = $p_result->getText( [
342  'allowTOC' => !$params['disabletoc'],
343  'enableSectionEditLinks' => !$params['disableeditsection'],
344  'wrapperDivClass' => $params['wrapoutputclass'],
345  'deduplicateStyles' => !$params['disablestylededuplication'],
346  ] );
347  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'text';
348  }
349 
350  if ( !is_null( $params['summary'] ) ||
351  ( !is_null( $params['sectiontitle'] ) && $this->section === 'new' )
352  ) {
353  $result_array['parsedsummary'] = $this->formatSummary( $titleObj, $params );
354  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'parsedsummary';
355  }
356 
357  if ( isset( $prop['langlinks'] ) ) {
358  if ( $skin ) {
359  $langlinks = $outputPage->getLanguageLinks();
360  } else {
361  $langlinks = $p_result->getLanguageLinks();
362  // The deprecated 'effectivelanglinks' option depredates OutputPage
363  // support via 'useskin'. If not already applied, then run just this
364  // one hook of OutputPage::addParserOutputMetadata here.
365  if ( $params['effectivelanglinks'] ) {
366  $linkFlags = [];
367  Hooks::run( 'LanguageLinks', [ $titleObj, &$langlinks, &$linkFlags ] );
368  }
369  }
370 
371  $result_array['langlinks'] = $this->formatLangLinks( $langlinks );
372  }
373  if ( isset( $prop['categories'] ) ) {
374  $result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() );
375  }
376  if ( isset( $prop['categorieshtml'] ) ) {
377  $result_array['categorieshtml'] = $outputPage->getSkin()->getCategories();
378  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'categorieshtml';
379  }
380  if ( isset( $prop['links'] ) ) {
381  $result_array['links'] = $this->formatLinks( $p_result->getLinks() );
382  }
383  if ( isset( $prop['templates'] ) ) {
384  $result_array['templates'] = $this->formatLinks( $p_result->getTemplates() );
385  }
386  if ( isset( $prop['images'] ) ) {
387  $result_array['images'] = array_keys( $p_result->getImages() );
388  }
389  if ( isset( $prop['externallinks'] ) ) {
390  $result_array['externallinks'] = array_keys( $p_result->getExternalLinks() );
391  }
392  if ( isset( $prop['sections'] ) ) {
393  $result_array['sections'] = $p_result->getSections();
394  }
395  if ( isset( $prop['parsewarnings'] ) ) {
396  $result_array['parsewarnings'] = $p_result->getWarnings();
397  }
398 
399  if ( isset( $prop['displaytitle'] ) ) {
400  $result_array['displaytitle'] = $p_result->getDisplayTitle() !== false
401  ? $p_result->getDisplayTitle() : $titleObj->getPrefixedText();
402  }
403 
404  if ( isset( $prop['headitems'] ) ) {
405  if ( $skin ) {
406  $result_array['headitems'] = $this->formatHeadItems( $outputPage->getHeadItemsArray() );
407  } else {
408  $result_array['headitems'] = $this->formatHeadItems( $p_result->getHeadItems() );
409  }
410  }
411 
412  if ( isset( $prop['headhtml'] ) ) {
413  $result_array['headhtml'] = $outputPage->headElement( $context->getSkin() );
414  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'headhtml';
415  }
416 
417  if ( isset( $prop['modules'] ) ) {
418  if ( $skin ) {
419  $result_array['modules'] = $outputPage->getModules();
420  // Deprecated since 1.32 (T188689)
421  $result_array['modulescripts'] = [];
422  $result_array['modulestyles'] = $outputPage->getModuleStyles();
423  } else {
424  $result_array['modules'] = array_values( array_unique( $p_result->getModules() ) );
425  // Deprecated since 1.32 (T188689)
426  $result_array['modulescripts'] = [];
427  $result_array['modulestyles'] = array_values( array_unique( $p_result->getModuleStyles() ) );
428  }
429  }
430 
431  if ( isset( $prop['jsconfigvars'] ) ) {
432  $jsconfigvars = $skin ? $outputPage->getJsConfigVars() : $p_result->getJsConfigVars();
433  $result_array['jsconfigvars'] = ApiResult::addMetadataToResultVars( $jsconfigvars );
434  }
435 
436  if ( isset( $prop['encodedjsconfigvars'] ) ) {
437  $jsconfigvars = $skin ? $outputPage->getJsConfigVars() : $p_result->getJsConfigVars();
438  $result_array['encodedjsconfigvars'] = FormatJson::encode(
439  $jsconfigvars,
440  false,
442  );
443  $result_array[ApiResult::META_SUBELEMENTS][] = 'encodedjsconfigvars';
444  }
445 
446  if ( isset( $prop['modules'] ) &&
447  !isset( $prop['jsconfigvars'] ) && !isset( $prop['encodedjsconfigvars'] ) ) {
448  $this->addWarning( 'apiwarn-moduleswithoutvars' );
449  }
450 
451  if ( isset( $prop['indicators'] ) ) {
452  if ( $skin ) {
453  $result_array['indicators'] = (array)$outputPage->getIndicators();
454  } else {
455  $result_array['indicators'] = (array)$p_result->getIndicators();
456  }
457  ApiResult::setArrayType( $result_array['indicators'], 'BCkvp', 'name' );
458  }
459 
460  if ( isset( $prop['iwlinks'] ) ) {
461  $result_array['iwlinks'] = $this->formatIWLinks( $p_result->getInterwikiLinks() );
462  }
463 
464  if ( isset( $prop['wikitext'] ) ) {
465  $result_array['wikitext'] = $this->content->serialize( $format );
466  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'wikitext';
467  if ( !is_null( $this->pstContent ) ) {
468  $result_array['psttext'] = $this->pstContent->serialize( $format );
469  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'psttext';
470  }
471  }
472  if ( isset( $prop['properties'] ) ) {
473  $result_array['properties'] = (array)$p_result->getProperties();
474  ApiResult::setArrayType( $result_array['properties'], 'BCkvp', 'name' );
475  }
476 
477  if ( isset( $prop['limitreportdata'] ) ) {
478  $result_array['limitreportdata'] =
479  $this->formatLimitReportData( $p_result->getLimitReportData() );
480  }
481  if ( isset( $prop['limitreporthtml'] ) ) {
482  $result_array['limitreporthtml'] = EditPage::getPreviewLimitReport( $p_result );
483  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'limitreporthtml';
484  }
485 
486  if ( isset( $prop['parsetree'] ) || $params['generatexml'] ) {
487  if ( $this->content->getModel() != CONTENT_MODEL_WIKITEXT ) {
488  $this->dieWithError( 'apierror-parsetree-notwikitext', 'notwikitext' );
489  }
490 
491  $parser = MediaWikiServices::getInstance()->getParser();
492  $parser->startExternalParse( $titleObj, $popts, Parser::OT_PREPROCESS );
493  $xml = $parser->preprocessToDom( $this->content->getText() )->__toString();
494  $result_array['parsetree'] = $xml;
495  $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'parsetree';
496  }
497 
498  $result_mapping = [
499  'redirects' => 'r',
500  'langlinks' => 'll',
501  'categories' => 'cl',
502  'links' => 'pl',
503  'templates' => 'tl',
504  'images' => 'img',
505  'externallinks' => 'el',
506  'iwlinks' => 'iw',
507  'sections' => 's',
508  'headitems' => 'hi',
509  'modules' => 'm',
510  'indicators' => 'ind',
511  'modulescripts' => 'm',
512  'modulestyles' => 'm',
513  'properties' => 'pp',
514  'limitreportdata' => 'lr',
515  'parsewarnings' => 'pw'
516  ];
517  $this->setIndexedTagNames( $result_array, $result_mapping );
518  $result->addValue( null, $this->getModuleName(), $result_array );
519  }
520 
529  protected function makeParserOptions( WikiPage $pageObj, array $params ) {
530  $popts = $pageObj->makeParserOptions( $this->getContext() );
531  $popts->enableLimitReport( !$params['disablepp'] && !$params['disablelimitreport'] );
532  $popts->setIsPreview( $params['preview'] || $params['sectionpreview'] );
533  $popts->setIsSectionPreview( $params['sectionpreview'] );
534  if ( $params['disabletidy'] ) {
535  $popts->setTidy( false );
536  }
537  if ( $params['wrapoutputclass'] !== '' ) {
538  $popts->setWrapOutputClass( $params['wrapoutputclass'] );
539  }
540 
541  $reset = null;
542  $suppressCache = false;
543  Hooks::run( 'ApiMakeParserOptions',
544  [ $popts, $pageObj->getTitle(), $params, $this, &$reset, &$suppressCache ] );
545 
546  // Force cache suppression when $popts aren't cacheable.
547  $suppressCache = $suppressCache || !$popts->isSafeToCache();
548 
549  return [ $popts, $reset, $suppressCache ];
550  }
551 
561  private function getParsedContent(
562  WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent
563  ) {
564  $revId = $rev ? $rev->getId() : null;
565  $isDeleted = $rev && $rev->isDeleted( Revision::DELETED_TEXT );
566 
567  if ( $getContent || $this->section !== false || $isDeleted ) {
568  if ( $rev ) {
569  $this->content = $rev->getContent( Revision::FOR_THIS_USER, $this->getUser() );
570  if ( !$this->content ) {
571  $this->dieWithError( [ 'apierror-missingcontent-revid', $revId ] );
572  }
573  } else {
574  $this->content = $page->getContent( Revision::FOR_THIS_USER, $this->getUser() );
575  if ( !$this->content ) {
576  $this->dieWithError( [ 'apierror-missingcontent-pageid', $page->getId() ] );
577  }
578  }
579  $this->contentIsDeleted = $isDeleted;
580  $this->contentIsSuppressed = $rev &&
582  }
583 
584  if ( $this->section !== false ) {
585  $this->content = $this->getSectionContent(
586  $this->content,
587  $pageId === null ? $page->getTitle()->getPrefixedText() : $this->msg( 'pageid', $pageId )
588  );
589  return $this->content->getParserOutput( $page->getTitle(), $revId, $popts );
590  }
591 
592  if ( $isDeleted ) {
593  // getParserOutput can't do revdeled revisions
594  $pout = $this->content->getParserOutput( $page->getTitle(), $revId, $popts );
595  } else {
596  // getParserOutput will save to Parser cache if able
597  $pout = $page->getParserOutput( $popts, $revId, $suppressCache );
598  }
599  if ( !$pout ) {
600  $this->dieWithError( [ 'apierror-nosuchrevid', $revId ?: $page->getLatest() ] ); // @codeCoverageIgnore
601  }
602 
603  return $pout;
604  }
605 
613  private function getSectionContent( Content $content, $what ) {
614  // Not cached (save or load)
615  $section = $content->getSection( $this->section );
616  if ( $section === false ) {
617  $this->dieWithError( [ 'apierror-nosuchsection-what', $this->section, $what ], 'nosuchsection' );
618  }
619  if ( $section === null ) {
620  $this->dieWithError( [ 'apierror-sectionsnotsupported-what', $what ], 'nosuchsection' );
621  $section = false;
622  }
623 
624  return $section;
625  }
626 
634  private function formatSummary( $title, $params ) {
635  $summary = $params['summary'] ?? '';
636  $sectionTitle = $params['sectiontitle'] ?? '';
637 
638  if ( $this->section === 'new' && ( $sectionTitle === '' || $summary === '' ) ) {
639  if ( $sectionTitle !== '' ) {
640  $summary = $params['sectiontitle'];
641  }
642  if ( $summary !== '' ) {
643  $summary = wfMessage( 'newsectionsummary' )
644  ->rawParams( MediaWikiServices::getInstance()->getParser()
645  ->stripSectionName( $summary ) )
646  ->inContentLanguage()->text();
647  }
648  }
649  return Linker::formatComment( $summary, $title, $this->section === 'new' );
650  }
651 
652  private function formatLangLinks( $links ) {
653  $result = [];
654  foreach ( $links as $link ) {
655  $entry = [];
656  $bits = explode( ':', $link, 2 );
657  $title = Title::newFromText( $link );
658 
659  $entry['lang'] = $bits[0];
660  if ( $title ) {
661  $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
662  // localised language name in 'uselang' language
663  $entry['langname'] = Language::fetchLanguageName(
664  $title->getInterwiki(),
665  $this->getLanguage()->getCode()
666  );
667 
668  // native language name
669  $entry['autonym'] = Language::fetchLanguageName( $title->getInterwiki() );
670  }
671  ApiResult::setContentValue( $entry, 'title', $bits[1] );
672  $result[] = $entry;
673  }
674 
675  return $result;
676  }
677 
678  private function formatCategoryLinks( $links ) {
679  $result = [];
680 
681  if ( !$links ) {
682  return $result;
683  }
684 
685  // Fetch hiddencat property
686  $lb = new LinkBatch;
687  $lb->setArray( [ NS_CATEGORY => $links ] );
688  $db = $this->getDB();
689  $res = $db->select( [ 'page', 'page_props' ],
690  [ 'page_title', 'pp_propname' ],
691  $lb->constructSet( 'page', $db ),
692  __METHOD__,
693  [],
694  [ 'page_props' => [
695  'LEFT JOIN', [ 'pp_propname' => 'hiddencat', 'pp_page = page_id' ]
696  ] ]
697  );
698  $hiddencats = [];
699  foreach ( $res as $row ) {
700  $hiddencats[$row->page_title] = isset( $row->pp_propname );
701  }
702 
703  $linkCache = MediaWikiServices::getInstance()->getLinkCache();
704 
705  foreach ( $links as $link => $sortkey ) {
706  $entry = [];
707  $entry['sortkey'] = $sortkey;
708  // array keys will cast numeric category names to ints, so cast back to string
709  ApiResult::setContentValue( $entry, 'category', (string)$link );
710  if ( !isset( $hiddencats[$link] ) ) {
711  $entry['missing'] = true;
712 
713  // We already know the link doesn't exist in the database, so
714  // tell LinkCache that before calling $title->isKnown().
715  $title = Title::makeTitle( NS_CATEGORY, $link );
716  $linkCache->addBadLinkObj( $title );
717  if ( $title->isKnown() ) {
718  $entry['known'] = true;
719  }
720  } elseif ( $hiddencats[$link] ) {
721  $entry['hidden'] = true;
722  }
723  $result[] = $entry;
724  }
725 
726  return $result;
727  }
728 
729  private function formatLinks( $links ) {
730  $result = [];
731  foreach ( $links as $ns => $nslinks ) {
732  foreach ( $nslinks as $title => $id ) {
733  $entry = [];
734  $entry['ns'] = $ns;
735  ApiResult::setContentValue( $entry, 'title', Title::makeTitle( $ns, $title )->getFullText() );
736  $entry['exists'] = $id != 0;
737  $result[] = $entry;
738  }
739  }
740 
741  return $result;
742  }
743 
744  private function formatIWLinks( $iw ) {
745  $result = [];
746  foreach ( $iw as $prefix => $titles ) {
747  foreach ( array_keys( $titles ) as $title ) {
748  $entry = [];
749  $entry['prefix'] = $prefix;
750 
751  $title = Title::newFromText( "{$prefix}:{$title}" );
752  if ( $title ) {
753  $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
754  }
755 
756  ApiResult::setContentValue( $entry, 'title', $title->getFullText() );
757  $result[] = $entry;
758  }
759  }
760 
761  return $result;
762  }
763 
764  private function formatHeadItems( $headItems ) {
765  $result = [];
766  foreach ( $headItems as $tag => $content ) {
767  $entry = [];
768  $entry['tag'] = $tag;
769  ApiResult::setContentValue( $entry, 'content', $content );
770  $result[] = $entry;
771  }
772 
773  return $result;
774  }
775 
776  private function formatLimitReportData( $limitReportData ) {
777  $result = [];
778 
779  foreach ( $limitReportData as $name => $value ) {
780  $entry = [];
781  $entry['name'] = $name;
782  if ( !is_array( $value ) ) {
783  $value = [ $value ];
784  }
786  $entry = array_merge( $entry, $value );
787  $result[] = $entry;
788  }
789 
790  return $result;
791  }
792 
793  private function setIndexedTagNames( &$array, $mapping ) {
794  foreach ( $mapping as $key => $name ) {
795  if ( isset( $array[$key] ) ) {
796  ApiResult::setIndexedTagName( $array[$key], $name );
797  }
798  }
799  }
800 
801  public function getAllowedParams() {
802  return [
803  'title' => null,
804  'text' => [
805  ApiBase::PARAM_TYPE => 'text',
806  ],
807  'revid' => [
808  ApiBase::PARAM_TYPE => 'integer',
809  ],
810  'summary' => null,
811  'page' => null,
812  'pageid' => [
813  ApiBase::PARAM_TYPE => 'integer',
814  ],
815  'redirects' => false,
816  'oldid' => [
817  ApiBase::PARAM_TYPE => 'integer',
818  ],
819  'prop' => [
820  ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|' .
821  'images|externallinks|sections|revid|displaytitle|iwlinks|' .
822  'properties|parsewarnings',
823  ApiBase::PARAM_ISMULTI => true,
825  'text',
826  'langlinks',
827  'categories',
828  'categorieshtml',
829  'links',
830  'templates',
831  'images',
832  'externallinks',
833  'sections',
834  'revid',
835  'displaytitle',
836  'headhtml',
837  'modules',
838  'jsconfigvars',
839  'encodedjsconfigvars',
840  'indicators',
841  'iwlinks',
842  'wikitext',
843  'properties',
844  'limitreportdata',
845  'limitreporthtml',
846  'parsetree',
847  'parsewarnings',
848  'headitems',
849  ],
851  'parsetree' => [ 'apihelp-parse-paramvalue-prop-parsetree', CONTENT_MODEL_WIKITEXT ],
852  ],
854  'headitems' => 'apiwarn-deprecation-parse-headitems',
855  ],
856  ],
857  'wrapoutputclass' => 'mw-parser-output',
858  'pst' => false,
859  'onlypst' => false,
860  'effectivelanglinks' => [
861  ApiBase::PARAM_DFLT => false,
863  ],
864  'section' => null,
865  'sectiontitle' => [
866  ApiBase::PARAM_TYPE => 'string',
867  ],
868  'disablepp' => [
869  ApiBase::PARAM_DFLT => false,
871  ],
872  'disablelimitreport' => false,
873  'disableeditsection' => false,
874  'disabletidy' => [
875  ApiBase::PARAM_DFLT => false,
876  ApiBase::PARAM_DEPRECATED => true, // Since 1.32
877  ],
878  'disablestylededuplication' => false,
879  'generatexml' => [
880  ApiBase::PARAM_DFLT => false,
882  'apihelp-parse-param-generatexml', CONTENT_MODEL_WIKITEXT
883  ],
885  ],
886  'preview' => false,
887  'sectionpreview' => false,
888  'disabletoc' => false,
889  'useskin' => [
890  ApiBase::PARAM_TYPE => array_keys( Skin::getAllowedSkins() ),
891  ],
892  'contentformat' => [
894  ],
895  'contentmodel' => [
897  ]
898  ];
899  }
900 
901  protected function getExamplesMessages() {
902  return [
903  'action=parse&page=Project:Sandbox'
904  => 'apihelp-parse-example-page',
905  'action=parse&text={{Project:Sandbox}}&contentmodel=wikitext'
906  => 'apihelp-parse-example-text',
907  'action=parse&text={{PAGENAME}}&title=Test'
908  => 'apihelp-parse-example-texttitle',
909  'action=parse&summary=Some+[[link]]&prop='
910  => 'apihelp-parse-example-summary',
911  ];
912  }
913 
914  public function getHelpUrls() {
915  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#parse';
916  }
917 }
getContent( $audience=Revision::FOR_PUBLIC, User $user=null)
Get the content of the current revision.
Definition: WikiPage.php:816
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
getExamplesMessages()
Definition: ApiParse.php:901
const FOR_THIS_USER
Definition: Revision.php:55
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
setArray( $array)
Set the link list to a given 2-d array First key is the namespace, second is the DB key...
Definition: LinkBatch.php:100
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
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
formatCategoryLinks( $links)
Definition: ApiParse.php:678
getResult()
Get the result object.
Definition: ApiBase.php:639
static normalizeKey( $key)
Normalize a skin preference value to a form that can be loaded.
Definition: Skin.php:102
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:231
getLatest()
Get the page_latest field.
Definition: WikiPage.php:710
getParsedContent(WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent)
Definition: ApiParse.php:561
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
static getAllContentFormats()
per default it will return the text for text based content
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
getMain()
Get the main module.
Definition: ApiBase.php:535
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
static getContentModels()
getDB()
Gets a default replica DB connection object.
Definition: ApiBase.php:667
An IContextSource implementation which will inherit context from another source but allow individual ...
formatSummary( $title, $params)
This mimicks the behavior of EditPage in formatting a summary.
Definition: ApiParse.php:634
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
$value
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2008
formatHeadItems( $headItems)
Definition: ApiParse.php:764
const PROTO_CURRENT
Definition: Defines.php:218
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:760
dieWithException( $exception, array $options=[])
Abort execution with an error derived from an exception.
Definition: ApiBase.php:2020
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:164
formatLimitReportData( $limitReportData)
Definition: ApiParse.php:776
setIndexedTagNames(&$array, $mapping)
Definition: ApiParse.php:793
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:478
IContextSource $context
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1799
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
const OT_PREPROCESS
Definition: Parser.php:114
getSection( $sectionId)
Returns the section with the given ID.
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. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. 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:1980
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3050
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
formatIWLinks( $iw)
Definition: ApiParse.php:744
getSectionContent(Content $content, $what)
Extract the requested section from the given Content.
Definition: ApiParse.php:613
formatLinks( $links)
Definition: ApiParse.php:729
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead 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
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition: Linker.php:1160
formatLangLinks( $links)
Definition: ApiParse.php:652
static getPreviewLimitReport(ParserOutput $output=null)
Get the Limit report for page previews.
Definition: EditPage.php:3670
getHelpUrls()
Definition: ApiParse.php:914
$res
Definition: database.txt:21
static addMetadataToResultVars( $vars, $forceHash=true)
Add the correct metadata to an array of vars we want to export through the API.
Definition: ApiResult.php:1150
getContext()
Get the base IContextSource object.
$params
getTitle()
Get the title object of the article.
Definition: WikiPage.php:294
const NS_CATEGORY
Definition: Defines.php:74
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:41
const DELETED_RESTRICTED
Definition: Revision.php:49
bool $contentIsDeleted
Definition: ApiParse.php:40
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:519
bool $contentIsSuppressed
Definition: ApiParse.php:40
execute()
Definition: ApiParse.php:42
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 $skin
Definition: hooks.txt:1982
checkTitleUserPermissions(LinkTarget $linkTarget, $actions, $options=[])
Helper function for permission-denied errors.
Definition: ApiBase.php:2147
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1766
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
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:930
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
const DELETED_TEXT
Definition: Revision.php:46
static setIndexedTagNameRecursive(array &$arr, $tag)
Set indexed tag name on $arr and all subarrays.
Definition: ApiResult.php:641
makeParserOptions( $context)
Get parser options suitable for rendering the primary article wikitext.
Definition: WikiPage.php:1949
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
static fetchLanguageName( $code, $inLanguage=self::AS_AUTONYMS, $include=self::ALL)
Definition: Language.php:937
getTitleOrPageId( $params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
Definition: ApiBase.php:1033
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
this hook is for auditing only $req
Definition: hooks.txt:979
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
getAllowedParams()
Definition: ApiParse.php:801
const META_SUBELEMENTS
Key for the &#39;subelements&#39; metadata item.
Definition: ApiResult.php:78
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1927
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
Definition: ApiBase.php:209
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:42
getParserOutput(ParserOptions $parserOptions, $oldid=null, $forceParse=false)
Get a ParserOutput for the given ParserOptions and revision ID.
Definition: WikiPage.php:1223
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:112
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file & $article
Definition: hooks.txt:1473
static newFromTitle( $title, IContextSource $context)
Create an Article object of the appropriate class for the given page.
Definition: Article.php:160
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
Definition: api.php:57
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:118
makeParserOptions(WikiPage $pageObj, array $params)
Constructs a ParserOptions object.
Definition: ApiParse.php:529
const META_BC_SUBELEMENTS
Key for the &#39;BC subelements&#39; metadata item.
Definition: ApiResult.php:143
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
static getAllowedSkins()
Fetch the list of user-selectable skins in regards to $wgSkipSkins.
Definition: Skin.php:81
Exception representing a failure to serialize or unserialize a content object.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:40
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319