Manual: Parser.php

Ficheiro do MediaWiki: Parser.php
Localização:	includes/parser/ (includes/Parser/ na versão 1.46 ou superior)
Código fonte:	master • 1.44.2 • 1.43.5 • 1.39.15
Classes:	MediaWiki\Parser\Parser

Descrição

Este ficheiro contém a classe Parser, que contém o método parse, que converte o texto wiki em html.

Obter o Parser

Em muitos contextos, como quando cria uma função do analisador ou página especial, deveria ter acesso a uma instância de Parser.

Como criar uma nova instância Parser

Se não tem acesso, pode criar uma nova instância utilizando ParserFactory e chamando o seu método create. O construtor de ParserFactory utiliza vários argumentos. Para criar um ParserFactory com as opções predefinidas, utilize MediaWikiServices::getInstance()->getParserFactory().

One-liner para obter uma nova instância de Parser:

$localParser = MediaWikiServices::getInstance()->getParserFactory()->create();

Esta nova instância ainda não está pronta para utilização. O próximo passo é definir ParserOptions.

How to get the main Parser instance

One-liner for getting the main Parser instance, though unsafe when the caller is not in a top-level context:

$localParser = MediaWikiServices::getInstance()->getParser();

O ciclo de analisar

1. Call helper function Parser::internalParse(), which in turns calls
   1. Parser::replaceVariables, which replaces magic variables, templates, and template arguments with the appropriate text.
      1. It calls Parser::preprocessToDom, which preprocesses some wikitext and returns the document tree.
      2. Next it creates a PPFrame object and calls its expand() method to do the actual template magic.
   2. Sanitizer::removeHTMLtags(), which cleans up HTML, removes dangerous tags and attributes, and removes HTML comments.
   3. Parser::handleTables, which handles and renders the wikitext for tables.
   4. Parser::handleDoubleUnderscore, which removes valid double-underscore items, like __NOTOC__, and records them in array $Parser->mDoubleUnderscores.
   5. Parser::handleHeadings, which parses and renders section headers.
   6. Parser::handleInternalLinks, which processes internal links ([[ ]]) and stores them in $Parser->mLinkHolders (a LinkHolderArray object),
   7. Parser::handleAllQuotes, which replaces single quotes with HTML markup (‎<i>, ‎<b>, etc).
   8. Parser::handleExternalLinks, which replaces and renders external links.
   9. Parser::handleMagicLinks, which replaces special strings like "ISBN xxx" and "RFC xxx" with magic external links.
   10. Parser::handleHeadings, qual:
       • auto numbers headings if that options is enabled,
       • adds an [edit] link to sections for users who have enabled the option and can edit the page,
       • adds a Table of contents on the top for users who have enabled the option, and
       • auto-anchors headings.
2. Next, parse() calls Parser::doBlockLevels, which renders lists from lines starting with ':', '*', '#', etc.
3. Parser::replaceLinkHolders is called, which calls LinkHolderArray::replace on $Parser->mLinkHolders to replace link placeholders with actual links, in the buffer Placeholders created in Skin::makeLinkObj()
4. Next, the text is language converted (when applicable) using the convert method of the appropriate Language object.
5. Parser::replaceTransparentTags used to be called, which replaced transparent tags with values which are provided by the callback functions in $Parser->mTransparentTagHooks. Transparent tag hooks are like regular XML-style tag hooks, except they operate late in the transformation sequence, on HTML instead of wikitext.
6. Sanitizer::normalizeCharReferences is called, which ensures that any entities and character references are legal for XML and XHTML specifically.
7. If HTML tidy is enabled, MWTidy::tidy is called to do the tidying.
8. Finally the rendered HTML result of the parse process is stored in the ParserOutput object $Parser->mOutput, which is returned to the caller of Parser::parse.

Hooks

Os seguintes hooks são disponibilizados em vários estágios do ciclo de análise:

Versão	Hook	Descrição
1.5.0	ParserAfterTidy	Used to add some final processing to the fully-rendered page output.
1.6.0	ParserBeforeInternalParse
1.6.0	ParserClearState	Called at the end of Parser::clearState().
1.6.0	ParserGetVariableValueSwitch	Assigns a value to a user defined variable.
1.6.0	ParserGetVariableValueTs	Used to change the value of the time for the {{LOCAL...}} magic word.
1.6.0	ParserTestParser	Called when creating a new instance of Parser for parser tests.
1.10.0	InternalParseBeforeLinks	Used to process the expanded wiki code after <nowiki>, HTML-comments, and templates have been treated.
1.10.1	BeforeParserFetchTemplateAndtitle	Allows an extension to specify a version of a page to get for inclusion in a template.
1.10.1	BeforeParserrenderImageGallery	Allows an extension to modify an image gallery before it is rendered.
1.12.0	ParserFirstCallInit	Called when the parser initialises for the first time.
1.12.0	ParserMakeImageParams	Alter the parameters used to generate an image before it is generated.
1.18.0	BeforeParserFetchFileAndTitle	Before an image is rendered by Parser.
1.19.0	ParserSectionCreate	Called each time the parser creates a document section from wikitext.
1.22.0	ParserLimitReportFormat	Replacement for deprecated ParserLimitReport
1.22.0	ParserLimitReportPrepare	Replacement for deprecated ParserLimitReport
1.36.0	BeforeParserFetchTemplateRevisionRecord	Replacement for deprecated BeforeParserFetchTemplateAndtitle

Assessores

• getCustomDefaultSort () Assessor para $mDefaultSort. Ao contrário de getDefaultSort(), este irá devolver false se não for definido nenhum.
• getDefaultSort () Assessor para $mDefaultSort. Utilizará a string vazia se não for definido nenhum.
• getOptions () Obter o objeto ParserOptions .
• getOutput () Obter o objeto ParserOutput .
• getPreprocessor () Obter o objeto Preprocessor .
• Relacionado com Manual:Revision .
  • getRevisionId () Get the ID of the revision we are parsing.
  • getRevisionTimestamp () Get the timestamp associated with the current revision, adjusted for the default server-local timestamp.
  • getRevisionUser () Get the name of the user that edited the last revision.
• getTags () Assessor.
• getTargetLanguage () Obter a linguagem de destino para o conteúdo que está a ser analisado.
• getTitle () Assessor para o objeto Title .
• getUser () Get a User object either from $this->mUser, if set, or from the ParserOptions object otherwise.

Definir

• Parser::setFunctionHook() Crie uma função do analisador , por exemplo, {{#expr: 1 + 1}} ou {{sum:1|2|3}}. The callback function can have the form: function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }.
• Parser::setHook() Create an HTML-style tag , e.g. ‎<yourtag>special text‎</yourtag>. The callback should have the following form: function myParserHook( $text, $params, $parser, $frame ) { ...}

Propriedades dinâmicas

Do not add class properties to the Parser that have not been declared by the Parser. Exceptions aside, dynamic properties are deprecated in PHP 8.2 and they may not sit well with the shift to parallellised envisaged for Parsoid . If you are write an extension and need to store custom data in the Parser, see extension data for one possible way out.

Consultar também

• Manual: Código – Visão geral dos principais ficheiros e diretorias no código fonte do MediaWiki
• Manual:ParserOptions.php
• Manual:PPFrame.php - Interface de quadro de expansão

Hiperligações externas

• O MediaWiki parser, revelado

Mudanças

• This class is namespaced (MediaWiki\Parser\Parser) since MW 1.42.