Go to the documentation of this file.
44 $this->
getMain()->setCacheMode(
'anon-public-user-private' );
58 $titleProvided =
false;
62 $titleProvided =
true;
69 $model =
$params[
'contentmodel'];
70 $format =
$params[
'contentformat'];
72 $prop = array_flip(
$params[
'prop'] );
74 if ( isset(
$params[
'section'] ) ) {
75 $this->section =
$params[
'section'];
76 if ( !preg_match(
'/^((T-)?\d+|new)$/', $this->section ) ) {
80 $this->section =
false;
90 $needContent = isset( $prop[
'wikitext'] ) ||
91 isset( $prop[
'parsetree'] ) ||
$params[
'generatexml'];
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' );
100 if ( !is_null( $oldid ) ) {
104 $this->
dieWithError( [
'apierror-nosuchrevid', $oldid ] );
110 [
'apierror-permissiondenied', $this->
msg(
'action-deletedtext' ) ]
114 $titleObj =
$rev->getTitle();
119 $pageObj, $popts, $suppressCache, $pageid,
$rev, $needContent
126 if ( !is_null( $pageid ) ) {
127 $reqParams[
'pageids'] = $pageid;
129 $reqParams[
'titles'] = $page;
135 $redirValues = $pageSet->getRedirectTitlesAsResult( $this->
getResult() );
138 foreach ( $pageSet->getRedirectTitles()
as $title ) {
139 $to =
$title->getFullText();
141 $pageParams = [
'title' => $to ];
142 } elseif ( !is_null( $pageid ) ) {
143 $pageParams = [
'pageid' => $pageid ];
145 $pageParams = [
'title' => $page ];
149 $titleObj = $pageObj->getTitle();
150 if ( !$titleObj || !$titleObj->exists() ) {
157 if ( isset( $prop[
'revid'] ) ) {
158 $oldid = $pageObj->getLatest();
163 $pageObj, $popts, $suppressCache, $pageid,
null, $needContent
168 if ( !$titleObj || $titleObj->isExternal() ) {
172 if ( $revid !==
null ) {
175 $this->
dieWithError( [
'apierror-nosuchrevid', $revid ] );
177 $pTitleObj = $titleObj;
178 $titleObj =
$rev->getTitle();
179 if ( $titleProvided ) {
180 if ( !$titleObj->equals( $pTitleObj ) ) {
187 $titleProvided =
true;
191 if ( $titleObj->canExist() ) {
200 $textProvided = !is_null( $text );
202 if ( !$textProvided ) {
203 if ( $titleProvided && ( $prop ||
$params[
'generatexml'] ) ) {
204 if ( $revid !==
null ) {
205 $this->
addWarning(
'apiwarn-parse-revidwithouttext' );
207 $this->
addWarning(
'apiwarn-parse-titlewithouttext' );
216 if ( $textProvided && !$titleProvided && is_null( $model ) ) {
218 $this->
addWarning( [
'apiwarn-parse-nocontentmodel', $model ] );
225 'wrap' =>
ApiMessage::create(
'apierror-contentserializationexception',
'parseerror' )
229 if ( $this->section !==
false ) {
230 if ( $this->section ===
'new' ) {
232 if ( !is_null(
$params[
'sectiontitle'] ) &&
$params[
'sectiontitle'] !==
'' ) {
241 $this->pstContent = $this->
content->preSaveTransform( $titleObj, $this->
getUser(), $popts );
246 $result_array[
'text'] = $this->pstContent->serialize( $format );
248 if ( isset( $prop[
'wikitext'] ) ) {
249 $result_array[
'wikitext'] = $this->
content->serialize( $format );
252 if ( !is_null(
$params[
'summary'] ) ||
253 ( !is_null(
$params[
'sectiontitle'] ) && $this->section ===
'new' )
266 $p_result = $this->pstContent->getParserOutput( $titleObj, $revid, $popts );
268 $p_result = $this->
content->getParserOutput( $titleObj, $revid, $popts );
274 $result_array[
'title'] = $titleObj->getPrefixedText();
275 $result_array[
'pageid'] = $pageid ?: $pageObj->getId();
276 if ( $this->contentIsDeleted ) {
277 $result_array[
'textdeleted'] =
true;
279 if ( $this->contentIsSuppressed ) {
280 $result_array[
'textsuppressed'] =
true;
283 if ( isset(
$params[
'useskin'] ) ) {
284 $factory = MediaWikiServices::getInstance()->getSkinFactory();
291 if (
$skin || isset( $prop[
'headhtml'] ) || isset( $prop[
'categorieshtml'] ) ) {
315 $outputPage =
new OutputPage(
$context );
316 $outputPage->addParserOutputMetadata( $p_result );
318 $outputPage->addContentOverride( $titleObj, $this->
content );
324 $skin->setupSkinUserCss( $outputPage );
326 $outputPage->loadSkinModules(
$skin );
329 Hooks::run(
'ApiParseMakeOutputPage', [ $this, $outputPage ] );
332 if ( !is_null( $oldid ) ) {
333 $result_array[
'revid'] = intval( $oldid );
336 if (
$params[
'redirects'] && !is_null( $redirValues ) ) {
337 $result_array[
'redirects'] = $redirValues;
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'],
350 if ( !is_null(
$params[
'summary'] ) ||
351 ( !is_null(
$params[
'sectiontitle'] ) && $this->section ===
'new' )
357 if ( isset( $prop[
'langlinks'] ) ) {
359 $langlinks = $outputPage->getLanguageLinks();
361 $langlinks = $p_result->getLanguageLinks();
365 if (
$params[
'effectivelanglinks'] ) {
367 Hooks::run(
'LanguageLinks', [ $titleObj, &$langlinks, &$linkFlags ] );
373 if ( isset( $prop[
'categories'] ) ) {
376 if ( isset( $prop[
'categorieshtml'] ) ) {
377 $result_array[
'categorieshtml'] = $outputPage->getSkin()->getCategories();
380 if ( isset( $prop[
'links'] ) ) {
381 $result_array[
'links'] = $this->
formatLinks( $p_result->getLinks() );
383 if ( isset( $prop[
'templates'] ) ) {
384 $result_array[
'templates'] = $this->
formatLinks( $p_result->getTemplates() );
386 if ( isset( $prop[
'images'] ) ) {
387 $result_array[
'images'] = array_keys( $p_result->getImages() );
389 if ( isset( $prop[
'externallinks'] ) ) {
390 $result_array[
'externallinks'] = array_keys( $p_result->getExternalLinks() );
392 if ( isset( $prop[
'sections'] ) ) {
393 $result_array[
'sections'] = $p_result->getSections();
395 if ( isset( $prop[
'parsewarnings'] ) ) {
396 $result_array[
'parsewarnings'] = $p_result->getWarnings();
399 if ( isset( $prop[
'displaytitle'] ) ) {
400 $result_array[
'displaytitle'] = $p_result->getDisplayTitle() !==
false
401 ? $p_result->getDisplayTitle() : $titleObj->getPrefixedText();
404 if ( isset( $prop[
'headitems'] ) ) {
406 $result_array[
'headitems'] = $this->
formatHeadItems( $outputPage->getHeadItemsArray() );
408 $result_array[
'headitems'] = $this->
formatHeadItems( $p_result->getHeadItems() );
412 if ( isset( $prop[
'headhtml'] ) ) {
413 $result_array[
'headhtml'] = $outputPage->headElement(
$context->
getSkin() );
417 if ( isset( $prop[
'modules'] ) ) {
419 $result_array[
'modules'] = $outputPage->getModules();
420 $result_array[
'modulescripts'] = $outputPage->getModuleScripts();
421 $result_array[
'modulestyles'] = $outputPage->getModuleStyles();
423 $result_array[
'modules'] = array_values( array_unique( $p_result->getModules() ) );
424 $result_array[
'modulescripts'] = array_values( array_unique( $p_result->getModuleScripts() ) );
425 $result_array[
'modulestyles'] = array_values( array_unique( $p_result->getModuleStyles() ) );
429 if ( isset( $prop[
'jsconfigvars'] ) ) {
430 $jsconfigvars =
$skin ? $outputPage->getJsConfigVars() : $p_result->getJsConfigVars();
434 if ( isset( $prop[
'encodedjsconfigvars'] ) ) {
435 $jsconfigvars =
$skin ? $outputPage->getJsConfigVars() : $p_result->getJsConfigVars();
444 if ( isset( $prop[
'modules'] ) &&
445 !isset( $prop[
'jsconfigvars'] ) && !isset( $prop[
'encodedjsconfigvars'] ) ) {
446 $this->
addWarning(
'apiwarn-moduleswithoutvars' );
449 if ( isset( $prop[
'indicators'] ) ) {
451 $result_array[
'indicators'] = (
array)$outputPage->getIndicators();
453 $result_array[
'indicators'] = (
array)$p_result->getIndicators();
458 if ( isset( $prop[
'iwlinks'] ) ) {
459 $result_array[
'iwlinks'] = $this->
formatIWLinks( $p_result->getInterwikiLinks() );
462 if ( isset( $prop[
'wikitext'] ) ) {
463 $result_array[
'wikitext'] = $this->
content->serialize( $format );
465 if ( !is_null( $this->pstContent ) ) {
466 $result_array[
'psttext'] = $this->pstContent->serialize( $format );
470 if ( isset( $prop[
'properties'] ) ) {
471 $result_array[
'properties'] = (
array)$p_result->getProperties();
475 if ( isset( $prop[
'limitreportdata'] ) ) {
476 $result_array[
'limitreportdata'] =
479 if ( isset( $prop[
'limitreporthtml'] ) ) {
484 if ( isset( $prop[
'parsetree'] ) ||
$params[
'generatexml'] ) {
486 $this->
dieWithError(
'apierror-parsetree-notwikitext',
'notwikitext' );
490 $xml =
$wgParser->preprocessToDom( $this->
content->getNativeData() )->__toString();
491 $result_array[
'parsetree'] = $xml;
498 'categories' =>
'cl',
502 'externallinks' =>
'el',
507 'indicators' =>
'ind',
508 'modulescripts' =>
'm',
509 'modulestyles' =>
'm',
510 'properties' =>
'pp',
511 'limitreportdata' =>
'lr',
512 'parsewarnings' =>
'pw'
528 $popts->enableLimitReport( !
$params[
'disablepp'] && !
$params[
'disablelimitreport'] );
529 $popts->setIsPreview(
$params[
'preview'] ||
$params[
'sectionpreview'] );
530 $popts->setIsSectionPreview(
$params[
'sectionpreview'] );
531 if (
$params[
'disabletidy'] ) {
532 $popts->setTidy(
false );
534 if (
$params[
'wrapoutputclass'] !==
'' ) {
535 $popts->setWrapOutputClass(
$params[
'wrapoutputclass'] );
539 $suppressCache =
false;
541 [ $popts, $pageObj->
getTitle(),
$params, $this, &$reset, &$suppressCache ] );
544 $suppressCache = $suppressCache || !$popts->isSafeToCache();
546 return [ $popts, $reset, $suppressCache ];
559 WikiPage $page, $popts, $suppressCache, $pageId,
$rev, $getContent
561 $revId =
$rev ?
$rev->getId() :
null;
564 if ( $getContent || $this->section !==
false || $isDeleted ) {
568 $this->
dieWithError( [
'apierror-missingcontent-revid', $revId ] );
576 $this->contentIsDeleted = $isDeleted;
577 $this->contentIsSuppressed =
$rev &&
581 if ( $this->section !==
false ) {
584 $pageId ===
null ? $page->
getTitle()->getPrefixedText() : $this->
msg(
'pageid', $pageId )
586 return $this->
content->getParserOutput( $page->
getTitle(), $revId, $popts );
591 $pout = $this->
content->getParserOutput( $page->
getTitle(), $revId, $popts );
614 $this->
dieWithError( [
'apierror-nosuchsection-what', $this->section, $what ],
'nosuchsection' );
617 $this->
dieWithError( [
'apierror-sectionsnotsupported-what', $what ],
'nosuchsection' );
633 $summary = !is_null(
$params[
'summary'] ) ?
$params[
'summary'] :
'';
634 $sectionTitle = !is_null(
$params[
'sectiontitle'] ) ?
$params[
'sectiontitle'] :
'';
636 if ( $this->section ===
'new' && ( $sectionTitle ===
'' || $summary ===
'' ) ) {
637 if ( $sectionTitle !==
'' ) {
638 $summary =
$params[
'sectiontitle'];
640 if ( $summary !==
'' ) {
641 $summary =
wfMessage(
'newsectionsummary' )
642 ->rawParams(
$wgParser->stripSectionName( $summary ) )
643 ->inContentLanguage()->text();
653 $bits = explode(
':',
$link, 2 );
656 $entry[
'lang'] = $bits[0];
685 $db = $this->
getDB();
686 $res = $db->select( [
'page',
'page_props' ],
687 [
'page_title',
'pp_propname' ],
688 $lb->constructSet(
'page', $db ),
692 'LEFT JOIN', [
'pp_propname' =>
'hiddencat',
'pp_page = page_id' ]
696 foreach (
$res as $row ) {
697 $hiddencats[$row->page_title] = isset( $row->pp_propname );
700 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
702 foreach ( $links
as $link => $sortkey ) {
704 $entry[
'sortkey'] = $sortkey;
707 if ( !isset( $hiddencats[
$link] ) ) {
708 $entry[
'missing'] =
true;
713 $linkCache->addBadLinkObj(
$title );
714 if (
$title->isKnown() ) {
715 $entry[
'known'] =
true;
717 } elseif ( $hiddencats[
$link] ) {
718 $entry[
'hidden'] =
true;
728 foreach ( $links
as $ns => $nslinks ) {
729 foreach ( $nslinks
as $title => $id ) {
733 $entry[
'exists'] = $id != 0;
746 $entry[
'prefix'] = $prefix;
765 $entry[
'tag'] = $tag;
778 $entry[
'name'] =
$name;
779 if ( !is_array(
$value ) ) {
783 $entry = array_merge( $entry,
$value );
791 foreach ( $mapping
as $key =>
$name ) {
792 if ( isset( $array[$key] ) ) {
812 'redirects' =>
false,
818 'images|externallinks|sections|revid|displaytitle|iwlinks|' .
819 'properties|parsewarnings',
836 'encodedjsconfigvars',
851 'headitems' =>
'apiwarn-deprecation-parse-headitems',
854 'wrapoutputclass' =>
'mw-parser-output',
857 'effectivelanglinks' => [
869 'disablelimitreport' =>
false,
870 'disableeditsection' =>
false,
875 'disablestylededuplication' =>
false,
884 'sectionpreview' =>
false,
885 'disabletoc' =>
false,
900 'action=parse&page=Project:Sandbox'
901 =>
'apihelp-parse-example-page',
902 'action=parse&text={{Project:Sandbox}}&contentmodel=wikitext'
903 =>
'apihelp-parse-example-text',
904 'action=parse&text={{PAGENAME}}&title=Test'
905 =>
'apihelp-parse-example-texttitle',
906 'action=parse&summary=Some+[[link]]&prop='
907 =>
'apihelp-parse-example-summary',
912 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#parse';
static fetchLanguageName( $code, $inLanguage=self::AS_AUTONYMS, $include=self::ALL)
This is the main API class, used for both external and internal processing.
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
WebRequest clone which takes values from a provided array.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
getContext()
Get the base IContextSource object.
getParsedContent(WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent)
static getAllContentFormats()
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
per default it will return the text for text based content
Class representing a list of titles The execute() method checks them all for existence and adds them ...
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. 'LanguageGetMagic':DEPRECATED since 1.16! 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) '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 '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: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
const META_BC_SUBELEMENTS
Key for the 'BC subelements' metadata item.
getTitleOrPageId( $params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
getResult()
Get the result object.
this hook is for auditing only $req
Class representing a MediaWiki article and history.
makeParserOptions( $context)
Get parser options suitable for rendering the primary article wikitext.
getDB()
Gets a default replica DB connection object.
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
const CONTENT_MODEL_WIKITEXT
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
setArray( $array)
Set the link list to a given 2-d array First key is the namespace, second is the DB key,...
This class contains a list of pages that the client has requested.
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
This abstract class implements many basic API functions, and is the base of all API classes.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
An IContextSource implementation which will inherit context from another source but allow individual ...
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
getHelpUrls()
Return links to more detailed help pages about the module.
namespace and then decline to actually register it file or subcat img or subcat $title
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
static addMetadataToResultVars( $vars, $forceHash=true)
Add the correct metadata to an array of vars we want to export through the API.
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
static normalizeKey( $key)
Normalize a skin preference value to a form that can be loaded.
static getContentModels()
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getParserOutput(ParserOptions $parserOptions, $oldid=null, $forceParse=false)
Get a ParserOutput for the given ParserOptions and revision ID.
const META_SUBELEMENTS
Key for the 'subelements' metadata item.
formatLimitReportData( $limitReportData)
static getPreviewLimitReport(ParserOutput $output=null)
Get the Limit report for page previews.
getTitle()
Get the title object of the article.
Exception representing a failure to serialize or unserialize a content object.
getContent( $audience=Revision::FOR_PUBLIC, User $user=null)
Get the content of the current revision.
dieWithException( $exception, array $options=[])
Abort execution with an error derived from an exception.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
getLatest()
Get the page_latest field.
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
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))
formatSummary( $title, $params)
This mimicks the behavior of EditPage in formatting a summary.
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
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
Allows to change the fields on the form that will be generated $name
formatCategoryLinks( $links)
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
setIndexedTagNames(&$array, $mapping)
checkTitleUserPermissions(Title $title, $actions, $user=null)
Helper function for permission-denied errors.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
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...
Base interface for content objects.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
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
getExamplesMessages()
Returns usage examples for this module.
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
getModuleName()
Get the name of the module being executed by this instance.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
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
getSectionContent(Content $content, $what)
Extract the requested section from the given Content.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
getMain()
Get the main module.
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
static getAllowedSkins()
Fetch the list of user-selectable skins in regards to $wgSkipSkins.
formatHeadItems( $headItems)
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 "<
static setIndexedTagNameRecursive(array &$arr, $tag)
Set indexed tag name on $arr and all subarrays.
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
makeParserOptions(WikiPage $pageObj, array $params)
Constructs a ParserOptions object.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
bool $contentIsSuppressed
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
static newFromTitle( $title, IContextSource $context)
Create an Article object of the appropriate class for the given page.