Manual:Parser functions/ru

Функции парсера, добавленные в MediaWiki 1.7, - тип расширения, которое близко интегрируется с парсером. Фразу "функции парсера" не следует путать с $ext-parser, которое является коллекцияей простых парсинговых функций. (см. $hlp-parser) Фразу "функция парсера" не следует путать с, которая представляет собой набор простых функций парсера. (Смотрите для этого.)

Описание
В то время как теги расширений обрабатывают необработанный текст и возвращают HTML в браузер, функции парсера могут 'взаимодействовать' с другими вики-элементами на странице. Например, вывод функций парсера может использоваться как шаблонный параметр или в конструкторе ссылок.

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

Для получения дополнительной информации см. по. В этой документации указано:


 * Callback-функция должна иметь вид:
 * Или с :
 * Или с :

The first variant of the call passes all arguments as plain text. The second passes all arguments as an array of s, except for the first, which is currently text, though this may change in the future. These represent the unexpanded wikitext. The  parameter can be used to expand these arguments as needed. This is commonly used for conditional processing so that only the "true" case is evaluated with an if- or switch-like parser function. The frame object can also climb up the document tree to get information about the caller and has functions to determine and manage call depth, time-to-live, and whether the result of the parser function is volatile.

Создание функции синтаксического анализатора немного сложнее, чем создание нового тега, поскольку имя функции должно быть magic word, ключевым словом, поддерживающим псевдонимы и локализацию.



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

Запись переходит в extension.json, а код-в src/ExampleExtensionHooks.php соответственно:

Другой файл, ExampleExtension.i18n.php, в каталоге расширений (Не в подкаталоге src/) должен содержать:

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



производит:


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

Within LocalSettings.php
Magic words and their handling parser functions can be defined entirely in LocalSettings.php.



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

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

Затем положить это в ваш  файл

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

Это оказывает значительное негативное влияние на производительность, поэтому используйте его только в случае необходимости.



Интерфейс парсера


Контролирование вывода парсера
Чтобы викитекст, возвращаемые функцией парсер быть полностью разбираемый (в том числе расширение шаблонов), установите параметр, false при возвращении:

It seems the default value for  changed from false to true, at least in some situations, sometime around version 1.12.

И наоборот, чтобы ваш парсер функция возвращает HTML, который остается непроанализированным, а не обратно викитекст, используйте это:

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

При выборе имени без хэш-префикса обратите внимание, что трансклюзия страницы с именем, начинающимся с этого имени функции, за которым следует двоеточие, более невозможна. В частности, избегайте имен функций, равных имени пространства имен. В том случае, если interwiki transclusion включен, также избегайте имен функций, равных префиксу interwiki.



Хук setFunctionHook
Дополнительные сведения об интерфейсе синтаксического анализатора смотрите в документации по setFunctionHook в разделе includes/Parser.РНР. Вот (возможно, датированная) копия этих комментариев:

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

Параметры:


 * 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:


 * forceRawInterwiki
 * Force interwiki transclusion to be done in raw mode, not rendered.


 * found
 * The text returned is valid, stop processing the template. This is on by default.


 * isChildObj
 * The text is a DOM node needing expansion in a child frame.


 * isHTML
 * The returned text is HTML, armour it against wikitext transformation. But see discussion


 * isLocalObj
 * The text is a DOM node needing expansion in the current frame.


 * noparse
 * Unsafe HTML tags should not be stripped, etc.


 * nowiki
 * Wiki markup in the return value should be escaped.


 * preprocessFlags
 * Use these flags when parsing the returned text. This only applies when noparse is.


 * text
 * The text returned from the function. If isChildObj or isLocalObj are specified, this should be a DOM node instead.


 * title
 * The Title object where the text came from.

Expensive parser functions
Some parser functions represent a significant use of a wiki's resources and should be marked as "expensive". The number of expensive parser functions on any given page is limited by the setting. What counts as expensive is left up to the function itself, but typically, anything that is likely to cause a delay that extends beyond simple processing of data should be considered. This includes things like database reads and writes, launching a shell script synchronously, or file manipulation. On the other hand, not all such functions should necessarily be tagged. Semantic MediaWiki, for example, only marks a percentage of its database reads as expensive. This is due to the fact that on certain data-intensive pages, it could easily overflow the normal expensive parser function limits. In cases like this, the potential for noticeably slower performance that doesn't get flagged as expensive is a trade-off to having the functionality that SMW offers.

To mark your parser function as expensive, from within the body of the function's code, use. The return value will be if the expensive function limit has been reached or exceeded.



Параметры
Функции синтаксического анализатора не поддерживают именованные параметры, как это делают шаблоны и расширения тегов, но иногда полезно подделать их. Пользователи часто привыкли использовать вертикальные полосы ( | ) для разделения аргументов, поэтому приятно иметь возможность делать это и в контексте функции синтаксического анализатора. Вот простой пример того, как это сделать:



См. также

 * Расширение ParserFunctions - хорошо известный сборник функций парсера.
 * - an (incomplete) list of parser functions provided by core and extensions
 * Библиотека PHP Parser Hooks, которая предоставляет объектно-ориентированный интерфейс для декларативных крючков парсера
 * Расширение ParserFunctions - хорошо известный сборник функций парсера.
 * - an (incomplete) list of parser functions provided by core and extensions
 * Библиотека PHP Parser Hooks, которая предоставляет объектно-ориентированный интерфейс для декларативных крючков парсера
 * Расширение ParserFunctions - хорошо известный сборник функций парсера.
 * - an (incomplete) list of parser functions provided by core and extensions
 * Библиотека PHP Parser Hooks, которая предоставляет объектно-ориентированный интерфейс для декларативных крючков парсера
 * Библиотека PHP Parser Hooks, которая предоставляет объектно-ориентированный интерфейс для декларативных крючков парсера