Manual:Extension registration/cs

Registrace rozšíření je mechanismus, který používá MediaWiki pro načítání rozšíření a vzhledů. Konfigurační data vložíte do souboru s názvem  nebo   do kořenového adresáře vašeho rozšíření nebo vzhledu a MediaWiki je použije k registraci rozšíření a vzhledů.



Migrace pro správce webu
Před MediaWiki 1.25 byla konfigurace pro rozšíření a vzhledy prováděna v souboru PHP pomocí názvu přípony nebo vzhledu, například  nebo.

To lze převést na:



Vlastní umístění
Toto je nutné provést před načtením jakýchkoli rozšíření nebo vzhledů z nestandardních umístění adresáře:


 * Pokud svá rozšíření uchováváte na jiném místě než, musíte přepsat nebo použít druhý parametr   k určení adresáře, ve kterém chcete rozšíření najít.
 * Pokud je jedno nebo více vašich rozšíření uloženo v dalších umístěních, použijte druhý parametr  k určení umístění souboru   pro každé z těchto rozšíření.




 * Pokud vaše vzhledy nejsou v, musíte přepsat špatně pojmenovaný , nebo použít druhý parametr , abyste určili adresář, ve kterém se má vzhled najít.
 * Pokud je jeden nebo více vašich vzhledů uloženo v dalších umístěních, použijte druhý parametr  k určení umístění souboru   pro každý z těchto vzhledů.





Migrace pro vývojáře rozšíření
Od MW 1.30 mohou být ID jmenného prostoru definovaná lokálně v  před načtením rozšíření přepsána definováním příslušné konstanty v. Zvažte například následující deklaraci jmenného prostoru v souboru :

To by ve výchozím nastavení způsobilo, že konstanta NS_FOO bude definována na hodnotu 1212. Toto však lze přepsat definováním příslušné konstanty v LocalSettings.php:

To by způsobilo, že jmenný prostor "Foo" bude registrován s ID 6688 namísto 1212. Při přepisování ID jmenného prostoru nezapomeňte, že všechny jmenné prostory talk musí mít lichá ID a ID jmenného prostoru talk musí být vždy ID jmenného prostoru subjektu plus jedna.


 * Viz také registrace na stránce rozšíření (nyní superschopnosti).

Skript  vám pomůže s migrací ze vstupních bodů PHP do souboru metadat JSON. Pokud vaše rozšíření podporuje starší verze MediaWiki, měli byste si ponechat vstupní bod PHP, dokud neukončíte podporu pro tyto starší verze.

Ukázky příkazových řádků:

Možná budete muset odinstalovat své rozšíření z, pokud se zobrazí chyby, že konstanty nebo funkce nelze předefinovat. Soubor vstupního bodu PHP (FooBar.php) byste měli nahradit něčím podobným, jako je následující, aby nedošlo k přerušení wiki během procesu upgradu.

Nebo vzhledů



Uchovávání dokumentace
Vstupní body PHP mají obvykle nějakou dokumentaci konfiguračních nastavení, která je užitečná a neměla by se ztratit. Bohužel JSON nepodporuje komentáře. Doporučuje se přenést konfigurační dokumentaci do souboru  v úložišti rozšíření. Konfiguraci byste také měli zdokumentovat na wiki na stránce Rozšíření:MyExtension. Část dokumentace je také možné zahrnout přímo do souboru. Registrace rozšíření ignoruje jakýkoli klíč v  začínající znakem ' ' ve struktuře nejvyšší úrovně, takže do těchto částí souboru JSON můžete vkládat komentáře. Například:

Verze 1 formátu  také umožňovala   v sekci , ale to již není doporučeno ani podporováno ve verzi 2. Místo toho by mělo být použito pole  konfigurační proměnné.

Toto by mělo být použito pouze pro krátké poznámky a komentáře.

Funkce
Pokud načítáte velký počet rozšíření, registrace rozšíření poskytne zvýšení výkonu, pokud máte nainstalováno APC (nebo APCu). Rozšíření načtená společně s  (s množným číslem -s) budou uložena do mezipaměti společně.

Atributy
Neustálý problémem byl v tom, jak něco "zaregistrovat" pro jiné rozšíření. Obvykle to znamenalo, že se nějaké rozšíření muselo načíst dřív než jiné. Například VisualEditor, který pracoval s proměnnou, do které mohly ostatní rozšíření přidávat své moduly. Nepočítal s tím, že by už mohla existovat, takže ji v kódu inicializoval takto:

Takže pokud si do ní nějaké rozšíření přidalo svůj záznam před načtením VisualEditoru, byl zahozen. Některá rozšíření závisela na konkrétním pořadí načítání, jiná to obcházela pomocí. Registrace rozšíření řeší tento problém pomocí "atributů". V rozšíření Math by jeho  mělo něco jako:

Počínaje verzí 2 musí být atributy definovány v samostatné sekci.

musí být objekt s názvem rozšíření jako klíčem a objektem párů atribut/hodnota jako hodnotou. Pamatujte, že klíč v podobjektu nesmí obsahovat název rozšíření!

Když chce VisualEditor získat přístup k tomuto atributu, použije:



Požadavky (závislosti)
Registrace rozšíření má sekci  (vyžaduje), která funguje podobně jako sekce   Composeru. Umožňuje vývojáři rozšíření specifikovat několik požadavků na rozšíření, jako je konkrétní verze MediaWiki (nebo vyšší/menší než) nebo jiné rozšíření/vzhled. Chcete-li například přidat závislost na verzi MediaWiki, která je větší než 1.26.0, můžete do  přidat následující kód:

Klíč objektu  je název závislosti (před MediaWiki 1.29.0 byla podporována pouze  ), hodnota je platné omezení verze (formát je podle volby autora).

V MediaWiki 1.29.0 a vyšší můžete také přidat závislosti na vzhledech a dalších rozšířeních, jako jsou:

V MediaWiki 1.33.0 (?!??) a výše můžete také přidat závislosti na PHP, jako je:



Zkontrolujte, zda je rozšíření načteno, aniž by bylo ve skutečnosti vyžadováno
Mnoho rozšíření může poskytovat funkce, které fungují pouze v případě, že je načteno i jiné rozšíření, aniž by tuto funkci skutečně potřebovali pro fungování základní funkce rozšíření. Jako příklad: Pokud je načteno rozšíření B, může rozšíření A poskytovat skutečný WYSIWYG editor, jinak bude používat jednoduchou textovou oblast. Rozšíření A může těžit z rozšíření B (pokud je načteno), ale ke správnému fungování nevyžaduje, aby bylo načteno. Za tímto účelem obvykle zkontrolujete, zda je rozšíření načteno, spíše než jej přidáte jako tvrdou závislost.

Pro implementaci standardizovaného způsobu kontroly, zda je rozšíření načteno nebo ne (bez nutnosti práce navíc v rozšíření, která je v jiném rozšíření měkkou závislostí), lze použít registraci rozšíření. Implementuje metodu, která vrací jednoduchý boolean, pokud je rozšíření načteno nebo ne (aby to fungovalo, musí být rozšíření načteno s registrací rozšíření). Příklad:

Od MediaWiki 1.32 je také možné zkontrolovat, zda je rozšíření načteno a zda splňuje dané omezení verze:

Pokud byste chtěli zkontrolovat, zda je v dřívějších verzích MediaWiki načtena konkrétní verze rozšíření, lze podobné informace extrahovat pomocí metody, která vrací informace o kreditu pro všechna načtená rozšíření. Příklad:

Alternativně, pokud rozšíření B definuje speciální konstantu určenou pro tento účel během načítání, je možné zkontrolovat, zda je definována:

Křehčím způsobem, kterému je třeba se vyhnout, je zkontrolovat, zda specifická třída rozšíření B existuje nebo ne, např. pomocí tohoto kódu:

To může přestat fungovat, pokud přípona existuje v systému souborů, ale není načtena, např. pokud byl pro automatické načítání použit composer. Pokud byla třída přejmenována nebo přestane existovat (např. protože není balíček public), dojde také k přerušení.

Obecně je upřednostňováno sdílení kódu prostřednictvím komponent pro composer namísto rozšíření. Pokud třídy rozšíření potřebují pouze existovat, ale rozšíření nemusí být konfigurováno ani načteno, pro to, co chcete dělat, je to silný indikátor toho, že by tento kód měl být rozdělen na komponentu composer, na kterou byste se měli spolehnout. namísto.



Configs (Vaše nastavení rozšíření/vzhledů)
Ve výchozím nastavení  předpokládá, že vaše konfigurační nastavení začíná předponou "wg".

Pokud tomu tak není, můžete předponu přepsat pomocí speciálního klíče:

To by použilo předponu "eg" a nastavilo globální proměnnou na hodnotu true.

Počínaje zveřejněním verze 2 poskytuje konfigurační sekce registrace rozšíření mnohem více funkcí a umožňuje vám popsat možnosti konfigurace mnohem podrobněji. Namísto jediného klíče -> úložiště hodnot pro možnosti konfigurace můžete také přidat následující informace.

Obecná struktura  se mírně mění na následující, více objektově orientovanou verzi:

Hodnota
Hodnota konfigurace se přesunula na toto místo. Toto je jediný požadovaný klíč pro konfigurační objekt.

Cesta
Booleovská hodnota klíče  identifikuje, zda má být hodnota konfigurační volby interpretována jako cesta souborového systému vzhledem ke kořenu adresáře rozšíření. Pokud je například hodnota konfigurace  a   je pravdivá, skutečná hodnota bude.

Popis
Klíč  pro možnost konfigurace může obsahovat nelokalizovaný řetězec, který lze použít k vysvětlení možnosti konfigurace dalším vývojářům nebo uživatelům (správcům systému) vašeho rozšíření. It may also be used as tooltip text on the parameters section of the extension infobox on the MediaWiki.org extension description page. Hodnota klíče popisu obvykle není vystavena frontendu wiki, ale podívejte se do přehledu, kde najdete další informace, jak by se tato funkce mohla v budoucnu používat!

Existuje také možnost přidat klíč zprávy interního lokalizačního systému MediaWiki jako popis, který bude v budoucnu použit k odhalení popisu v rozhraní instalace MediaWiki.



veřejné / soukromé
Tato volba je booleovská, jejíž výchozí hodnota je false, což znamená, že konfigurační volba a hodnota jsou označeny jako "private". Tato hodnota se momentálně nikde nepoužívá, podívejte se do přehledu, kde se o této možnosti dozvíte více.

Výhled
Výše uvedené změny jsou také přípravnými kroky pro vylepšenou správu konfigurace v MediaWiki. Výše uvedené změny nám umožňují např. odhalit možnosti konfigurace rozšíření v uživatelském rozhraní MediaWiki. K tomu je zapotřebí zpráva s lokalizovaným popisem ( a  ) a indikace, zda má být konfigurační volba  veřejná nebo ne.



Automatické zjišťování testů jednotek
MediaWiki umožňuje libovolné rozšíření pro registraci testů phpunit. Bez registrace rozšíření byste museli zaregistrovat obslužný program pro háček, který by vypadal asi takto:

(jak je popsáno v příručce). Tento kód však vypadá stejně pro mnoho rozšíření, takže byste to mohli nazvat zbytečnou duplikací kódu. Pokud vaše rozšíření používá registraci rozšíření a vaše testy phpunit jsou umístěny v podadresáři  vašeho rozšíření, wraper phpunit MediaWiki automaticky objeví testy jednotek pomocí registrace rozšíření. Proto již nemusíte háček registrovat a nemusíte specifikovat, že vaše testy jednotek jsou uloženy ve výchozím adresáři.



Přizpůsobení registrace

 * See Manual:Extension.json/Schema.



Také composer.json
Pokud má rozšíření nebo vzhled knihovny závislosti, může je mít také soubor, viz. Použijte pole, aby MediaWiki používala automatické načítání Composer, když je to vhodné.

Některá pole metadat se překrývají mezi  a   (diskutované v ), včetně:
 * a
 * a



Správce kódu


Související stránky

 * Hlášení chyb v projektu MediaWiki-Configuration.
 * Staré verze Manual:Developing extensions#Setup (před květnem 2015) a popisují starý přístup deklarování informací o rozšíření v kódu PHP a proměnných
 * je schéma pro  (a skin.json).
 * RfC o implementaci registrace rozšíření
 * Zeď superschopností pro registraci rozšíření! — přehled rozšíření, která je ještě třeba převést.
 * — Sledovací karta pro převod všech rozšíření a vzhledů na Gitu pro použití registrace rozšíření.
 * RfC o implementaci registrace rozšíření
 * Zeď superschopností pro registraci rozšíření! — přehled rozšíření, která je ještě třeba převést.
 * — Sledovací karta pro převod všech rozšíření a vzhledů na Gitu pro použití registrace rozšíření.