Руководство:Функции парсера

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

Описание

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

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

{{ #functionname: param1 | param2 | param3 }}

Для получения дополнительной информации см. Документацию по Parser::setFunctionHook ( $id, $callback, $flags = 0 ). В этой документации указано:

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

function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }

Или с SFH_OBJECT_ARGS:

function myParserFunction( $parser, $frame, $args ) { ... }"

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.

Простой пример

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

The registration goes into extension.json and the code into src/ExampleExtensionHooks.php respectively:

{
	"name": "ExampleExtension",
	"author": "Me",
	"version": "1.0.0",
	"url": "https://www.mediawiki.org/wiki/Extension:ExampleExtension",
	"descriptionmsg": "exampleextension-desc",
	"license-name": "GPL-2.0-or-later",
	"type": "parserhook",
	"MessagesDirs": {
		"ExampleExtension": [
			"i18n"
		]
	},
	"AutoloadClasses": {
		"ExampleExtensionHooks": "src/ExampleExtensionHooks.php"
	},
	"ExtensionMessagesFiles": {
		"ExampleExtensionMagic": "ExampleExtension.i18n.php"
	},
	"Hooks": {
		"ParserFirstCallInit": "ExampleExtensionHooks::onParserFirstCallInit"
	},
	"manifest_version": 1
}

<?php
class ExampleExtensionHooks {
   // Register any render callbacks with the parser
   public static function onParserFirstCallInit( Parser $parser ) {

      // Create a function hook associating the "example" magic word with renderExample()
      $parser->setFunctionHook( 'example', [ self::class, 'renderExample' ] );
   }

   // Render the output of {{#example:}}.
   public static function renderExample( Parser $parser, $param1 = '', $param2 = '', $param3 = '' ) {

      // The input parameters are wikitext with templates expanded.
      // The output should be wikitext too.
      $output = "param1 is $param1 and param2 is $param2 and param3 is $param3";

      return $output;
   }
}

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

<?php
/**
 * @license GPL-2.0-or-later
 * @author Your Name (YourUserName)
 */

$magicWords = [];

/** English
 * @author Your Name (YourUserName)
 */
$magicWords['en'] = [
   'example' => [ 0, 'example' ],
];

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

• {{#example: hello | hi | hey}}

производит:

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

Это magicWords массива является обязательным. Если он опущен, функция парсера просто не будет работать; в {{#example: hello | hi}} будут отображены так, как будто расширение не установлено.

Стандартные функции

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

Положи это в свой extension.json файл:

"Hooks": {
	"ParserFirstCallInit": "ExampleExtensionHooks::onParserFirstCallInit"
},
"AutoloadClasses": {
	"ExampleExtensionHooks": "src/ExampleExtensionHooks.php"
}

• Смотри: Создание обработчика событий для других стилей.

Затем положить это в ваш src/ExampleExtensionHooks.php файл

class ExampleExtensionHooks {
      public static function onParserFirstCallInit( Parser $parser ) {
           $parser->setFunctionHook( 'example', [ self::class, 'renderExample' ] );
      }
}

Кэширование

Как и в случае расширения тега, $parser->disableCache() Может использоваться для отключения кэша для динамического расширения. This has a significant negative impact on performance, so only use when necessary.

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

Контролирование вывода парсера

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

return [ $output, '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, который остается непроанализированным, а не обратно викитекст, используйте это:

return [ $output, 'noparse' => true, 'isHTML' => true ];

Однако, This is {{#example:hello | hi | hey }} a test. будут выпускать что-то вроде этого:

This is

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

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

return $parser->insertStripItem( $output, $parser->mStripState );

Именование

По умолчанию, 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 [1] 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., {{#sum:1|2|3}}. The callback function should have the form:

function myParserFunction( $parser, $arg1, $arg2, $arg3 ) { ... }

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:

function ExampleExtensionRenderParserFunction( &$parser ) {
	// Suppose the user invoked the parser function like so:
	// {{#myparserfunction: foo=bar | apple=orange | banana }}

	$options = extractOptions( array_slice( func_get_args(), 1 ) );

	// Now you've got an array that looks like this:
	// [foo] => 'bar'
	// [apple] => 'orange'
	// [banana] => true
	// Continue writing your code...
}

/**
 * Converts an array of values in form [0] => "name=value"
 * into a real associative array in form [name] => value
 * If no = is provided, true is assumed like this: [name] => true
 *
 * @param array string $options
 * @return array $results
 */
function extractOptions( array $options ) {
	$results = [];
	foreach ( $options as $option ) {
		$pair = array_map( 'trim', explode( '=', $option, 2 ) );
		if ( count( $pair ) === 2 ) {
			$results[ $pair[0] ] = $pair[1];
		}
		if ( count( $pair ) === 1 ) {
			$results[ $pair[0] ] = true;
		}
	}
	return $results;
}

См. также

• Manual:Hooks/ParserFirstCallInit
• Manual:Расширения
• Руководство:Теги расширений
• Руководство:Волшебные слова
• Manual:Parser.php
• Extensions FAQ
• Справка:Расширение:ParserFunctions
• The ParserFunctions extension is a well-known collection of parser functions.
• The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks