Manual:Parser functions/ru

Parser functions, added in MediaWiki 1.7, are a type of extension that integrate closely with the parser. The phrase "parser function" should not be confused with Extension:ParserFunctions, which is a collection of simple parser functions. (See Help:Extension:ParserFunctions for those.)

Описания
Whereas a Tag extension is expected to take unprocessed text and return HTML to the browser, a parser function can 'interact' with other wiki elements in the page. For example, the output of a parser function could be used as a template parameter or in the construction of a link.

Типичный синтаксис парсера функции:

Для большей информации смотрите the documentation для. Эта документация гласит:
 * Callback-функция должна иметь вид:
 * Или с :  "
 * Или с :  "

Creating a parser function is slightly more complicated than creating a new tag because the function name must be a magic word, a keyword that supports aliases and localization.

Простой пример
Ниже приведен пример расширения, которое создает функция парсера.

Этот файл должен называться ExampleExtension.php если имя имеет расширение ExampleExtension:

Другой файл, ExampleExtension.i18n.php, должен содержать

С включенным расширением,



производит:


 * param1 is hello and param2 is hi and param3 is hey

Это magicWords массива является обязательным. Если он опущен, функция парсера просто не будет работать; в будут отображены так, как будто расширение не установлено.

Стандартные функции
Для больше функций, может потребоваться разделение функций-ловушек для a_body.php или .hooks.php файл и сделать их статическими функциями класса. Затем вы можете загрузить класс с и вызов статической функции в крючки; например:

Положи это в свой  файл: Затем положить это в ваш  файл
 * Смотри: Создание обработчика событий для других стилей.

Кэширования
Как и в случае расширения тега, $parser->disableCache Может использоваться для отключения кэша для динамического расширения.

Контролирование вывода парсера
Чтобы викитекст, возвращаемые функцией парсер быть полностью разбираемый (в том числе расширение шаблонов), установите параметр noparse, false при возвращении: It seems the default value for noparse changed from false to true, at least in some situations, sometime around version 1.12.

И наоборот, чтобы ваш парсер функция возвращает HTML, который остается непроанализированным, а не обратно викитекст, используйте это: Однако, This is a test. будут выпускать что-то вроде этого:

This is

param1-Привет и param2-hi и param3-эй, это тест.

Это происходит из-за жесткого кода "\n\n", предваряющая вывод HTML парсера функций. Чтобы избежать этого и убедиться, что HTML-код отображается встроенный в окружающий текст, вы можете использовать это:

Именование
По умолчанию, MW добавляет хэш-символа (знака, "#") перед названием каждой функции парсера. Чтобы подавить это дополнение (и получить синтаксический анализатор функционирует без "#" префикс), включать "SFH_NO_HASH" константа в необязательные флаги аргумент setFunctionHook, как описано ниже.

When choosing a name without a hash prefix, note that transclusion of a page with a name starting with that function name followed by a colon is no longer possible. In particular, avoid function names equal to a namespace name. In the case that interwiki transclusion is enabled, also avoid function names equal to an interwiki prefix.

The setFunctionHook hook
For more details of the interface into the parser, see the documentation for setFunctionHook in includes/Parser.php. Here's a (possibly dated) copy of those comments:

function setFunctionHook( $id, $callback, $flags = 0 ) Parameters:


 * string $id - The magic word ID
 * mixed $callback - The callback function (and object) to use
 * integer $flags - Optional, set it to the SFH_NO_HASH constant to call the function without "#".

Return value: The old callback function for this name, if any

Create a function, e.g.,. The callback function should have the form:

The callback may either return the text result of the function, or an array with the text in element 0, and a number of flags in the other elements. The names of the flags are specified in the keys. Valid flags are:


 * found : The text returned is valid, stop processing the template. This is on by default.
 * nowiki : Wiki markup in the return value should be escaped
 * noparse : Unsafe HTML tags should not be stripped, etc.
 * noargs : Don't replace triple-brace arguments in the return value
 * isHTML : The returned text is HTML, armour it against wikitext transformation

Named parameters
Parser functions do not support named parameters the way templates and tag extensions do, but it is occasionally useful to fake it. Users are often accustomed to using vertical bars ( | ) to separate arguments, so it's nice to be able to do that in the parser function context, too. Here's a simple example of how to accomplish this.

Your callback function typically looks like this: To fake named parameters, simply omit all the arguments after, and pair it with. Here is an example: