Kézikönyv:Varázsszavak

This page is a translated version of the page Manual:Magic words and the translation is 52% complete.
MediaWiki-kiterjesztések

A varázsszavak olyan változók, amelyekkel wikisztringeket rendelhetünk függvényekhez. A változók és az elemzőfüggvények is erre támaszkodnak. Minden, ehhez az azonosítóhoz rendelt szöveg helyén a függvény visszatérési értéke jelenik meg. A sztringek és az azonosító közti kapcsolatot a $magicWords változó tartalmazza, amely a $wgExtensionMessagesFiles[] segítségével betölthető fájlban található.

Az alapértelmezett varázsszavakat a CoreParserFunctions.php tartalmazza.

Hogyan működnek a varázsszavak

Ha a MediaWiki szöveget talál dupla kapcsos zárójelek közt ({{XXX ...}}), el kell döntenie, hogy az XXX változó, elemzőfüggvény vagy sablon. Ezt az alábbi kérdésekkel dönti el.

  1. Egy varázsszó azonosítója-e? A MediaWiki első lépésként a {{XXX...}} szövegben szereplő XXX-et a $magicWords tábla alapján megpróbálja varázsszóként értelmezni.
    • Ha nincsen hozzárendelt azonosító, akkor a szoftver az „XXX” karaktersort sablonként értelmezi.

  2. Változó-e? Ha egy varázsszóhoz tartozik a szöveg, a szoftver ellenőrzi, hogy vannak-e paraméterei.
    • Ha nincsenek paraméterek, a MediaWiki ellenőrzi, hogy az azonosító változóként van-e deklarálva. Ezt a MagicWord::getVariableIDs() segítségével teszi meg. Ezzel a módszerrel a szoftver egyrészt a változók nyers listáját nyeri ki (lásd: Help:Variables ), másrészt a MagicWordwgVariableIDs hookhoz csatolt összes függvény által biztosított egyedi változóazonosítók listáját.
      • Ha az azonosító változóként lett azonosítva, a MediaWiki meghívja az esemény nevéhez rendelt funkciókat (ParserGetVariableValueSwitch ), majd a varázsszó megtalálásakor annak értékét adja vissza.

  3. Elemzőfüggvény? Ha vannak paraméterek, vagy a varázsszó-azonosító nincs a változóazonosítók közt, a MediaWiki feltételezi, hogy a varázsszó elemzőfüggvény vagy sablon. Ha a varázsszó-azonosító szerepel a $wgParser->setFunctionHook($magicWordId, $renderingFunctionName) hívásával deklarált elemzőfüggvények listáján, elemzőfüggvényként kezeli, és a $renderingFunctionName hívásával jeleníti meg. Ellenkező esetben sablonként kezeli.
Megegyezés alapján:
  • A változók varázsszavai nagybetűsek, nagybetűérzékenyek, és nem tartalmaznak szóközöket.
  • Parserfunctions are prefixed with a hash sign ({{#), are case insensitive and do not include space characters.

Ez azonban konvenció, és történeti okokból nincs mindig alkalmazva.

  • A változókban nincsenek szóközök, de néhány más nyelvre fordított változónévben van.
  • A változók általában nagybetűsek és nagybetűérzékenyek, de néhány elemzőfüggvény is alkalmazza e konvenciót.
  • Some parser functions start with a hash sign, but some do not.

Where possible you should follow the conventions when defining or translating magic words. Magic words are higher in priority than templates, so any magic word defined, will block the usage of that defined name as a template.

Following the conventions avoids adding more and more potential collisions.

Varázsszavak definiálása

For magic words to do their magic we must define two things:

  • a mapping between wiki text and a magic word ID
  • a mapping between a magic word ID and some php function that interprets the magic word.

Mapping wiki text to magic word IDs

The variable $magicWords is used to associate each magic word ID with a language-dependent array that describes all the text strings that mapped to the magic word ID. Important: This only sets up the back end i18n mapping, you still have to write other code to make MediaWiki use the magic word for anything. Also, make sure that you initialize $magicWords as an empty array before adding language-specific values or you will get errors when trying to load the magic word and will need to rebuild your localization cache before it will work.

The first element of this array is an integer flag indicating whether or not the magic word is case sensitive. The remaining elements are a list of text that should be associated with the magic word ID. If the case sensitive flag is 0, any case variant of the names in the array will match. If the case sensitive flag is 1, only exact case matches will be associated with the magic word ID. Tehát a formátum $magicWords['en'] = [ 'InternalName' => [ 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ] ];

This association is created by $magicWords in a file registered using $wgExtensionMessagesFiles[] .

In the example below, a Spanish MediaWiki installation will associate the magic word ID 'MAG_CUSTOM' with "personalizado", "custom", "PERSONALIZADO", "CUSTOM" and all other case variants. In an English MediaWiki only "custom" in various case combinations will be mapped to 'MAG_CUSTOM':

File Example.i18n.magic.php:

<?php

$magicWords = [];

$magicWords['en'] = [
	'MAG_CUSTOM' => [ 0, 'custom' ],
];

$magicWords['es'] = [
	'MAG_CUSTOM' => [ 0, 'personalizado' ],
];

Az extension.json fájl részében:

"ExtensionMessagesFiles": {
	"ExampleMagic": "Example.i18n.magic.php"
}

Note that "ExampleMagic" is a different to the key you would use for a plain internationalization file (normally just the title of the extension, i.e. "Example"). "Magic" has been appended deliberately so one does not overwrite the other.

In inline PHP

You can associate magic words inline in PHP rather than through a i18n file. This is useful when defining hooks in LocalSettings.php but should not be done in extensions.

MediaWiki\MediaWikiServices::getInstance()->getContentLanguage()->mMagicExtensions['wikicodeToHtml'] = ['MAG_CUSTOM', 'custom'];

Associating a magic word ID with a PHP function

The mechanism for associating magic word IDs with rendering functions depends on whether the magic word will be used as a parser function or a variable. For more information, please see:

Localisation

See Help:Magic words#Localisation for help.

You can read more on definition and usage of magic words for localisation at Manual:Messages API, Manual:Language#Namespaces; Avoid {{SITENAME}} in messages.

Behavior switches (double underscore magic words)

Behavior switches are a special type of magic word. They can be recognized by their use of double underscores (rather than double braces). Példa: __NOTOC__

These magic words typically do not output any content, but instead change the behavior of a page and/or set a page property. These magic words are listed in MagicWordFactory::mDoubleUnderscoreIDs and also at Help:Magic words#Behavior switches. The effect of most standard behavior switches is defined in Parser::handleDoubleUnderscore(). If no specific effect is defined, the magic word will simply set a page property in the page_props table. This can also be checked later by testing if $parser->getOutput()->getPageProperty( 'MAGIC_WORD' ) is null or the empty string

Custom behavior switch

Itt egy egyedi __CUSTOM__ váltót meghatározó példakiterjesztés

custom/extension.json - This is minimal, a real extension would fill out more fields.

{
	"name": "Custom",
	"type": "parserhook",
	"AutoloadClasses": {
		"MyHooks": "MyHooks.php"
	},
	"Hooks": {
		"GetDoubleUnderscoreIDs": [
			"MyHooks::onGetDoubleUnderscoreIDs"
		],
		"ParserAfterParse": [
			"MyHooks::onParserAfterParse"
		]
	},
	"ExtensionMessagesFiles": {
		"CustomMagic": "custom.i18n.php"
	},
	"manifest_version": 1
}

custom/custom.i18n.php

<?php
$magicWords = [];
$magicWords['en'] = [
	'MAG_CUSTOM' => [ 0, '__CUSTOM__' ],
];

custom/MyHooks.php

<?php
class MyHooks {
	public static function onGetDoubleUnderscoreIDs( &$ids ) {
		$ids[] = 'MAG_CUSTOM';
	}

	public static function onParserAfterParse( Parser $parser, &$text, StripState $stripState ) {
		if ( $parser->getOutput()->getPageProperty( 'MAG_CUSTOM' ) !== null ) {
			// Do behavior switching here ...
			// e.g. If you wanted to add some JS, you would do $parser->getOutput()->addModules( 'moduleName' );
		}
	}
}

Lásd még