Manual:Writing maintenance scripts/cs

Tato příručka krok za krokem popisuje, jak psát údržbářské skripty, které se spouštějí na straně serveru na příkazovém řádku. Jsou založené na třídě  (viz ), která je implementovaná od MediaWiki verze 1.16

Ukázkový skript
Projdeme si skript údržby, který jednoduše vypíše "Hello, World". Tento skript obsahuje minimální množství kódu potřebného ke spuštění a hlavičku s uvedením autorských práv, která by neměla nikdy chybět (jaké lze použít hlavičky článek viz hlavičky autorských práv):

The below example program will print "Hello, World!":

$ php helloWorld.php Hello, World!

Boilerplate explained

 * Zahrne soubor . V něm je definována třída , která obsahuje metody pro analýzu předaných argumentů, čtení dat z konzole, pro zajištění přístupu do databáze atd. Je žádoucí ve skriptu byla k $3 uvedena plná, nikoliv relativní, cesta.


 * Naše třída je pouze rozšířením třídy Maintenance


 * které řekne třídě Maintenance, aby spouštěla skript přes naši třídu, jen když poběží na příkazovém řádku.

Po zavolání interní proměnné  se načte další soubor, který načte konfiguraci a na jejím základě pak automaticky i další třídy MediaWiki.


 * A pak zavolá námi definovanou funkci, a náš skript dokončí svou práci.

When our program is run from the command-line, the core maintenance framework will take care of initialising MediaWiki core and configuration etc, and then it will invoke this method.

Help command
One of the built-in features that all maintenance scripts enjoy is a  option. The above example boilerplate would produce the following help page:

$ php helloWorld.php --help

Usage: php helloWorld.php […]

Generic maintenance parameters: --help (-h): Display this help message --quiet (-q): Whether to suppress non-error output --conf: Location of LocalSettings.php, if not default --wiki: For specifying the wiki ID   --server: The protocol and server name to use in URL --profiler: Profiler output format (usually "text") …



Přidáváme popis
„Na co je ale dobrý tenhle údržbářský skript?” Už slyším, jak se ptáte.

Proto můžeme pomocí metody  do našeho konstruktoru přidat popis, který se zobrazí hned na začátku výstupu při použití parametru " ":

Takže teď už bude vracet náš popis:

$ php helloWorld.php --help

Say hello.

Usage: php helloWorld.php [--help] …



Volby a zpracování jejich hodnot
Pozdravit celičký svět je nepochybně správné a dobré, ale my chceme, aby ten skript uměl pozdravit i konkrétního jednotlivce.

Abyste přidali další volbu příkazového řádku, přidejte do třídy  konstruktor, co zavolá ze třídy   metodu , která zaaktualizuje metodu  , aby zahrnula i vaši novou volbu. Parametry metody  jsou , takže:

V tuto chvíli se po spuštění výstup skriptu  bude měnit, podle toho jakou předáte hodnotu argumentu:

 $ php helloWorld.php Hello, World! $ php helloWorld.php --name=Mark Hello, Mark! $ php helloWorld.php --help

Say hello.

Usage: php helloWorld.php […] … Script specific parameters: --name: Who to say Hello to

Rozšíření
Pokud váš údržbářský skript vyžaduje funkce, které nabízí nějaké rozšíření, měli byste přidat také požadavek, aby bylo nejprve tohle rozšíření nainstalováno:

Pokud požadované rozšíření ještě není na dané wiki k dispozici (což se na wiki farmách občas stane). Vrátí skript pěkné chybové hlášení. For example, during local development a particular extension might not yet be enabled in LocalSettings.php, or when operating a wiki farm an extension might be enabled on a subset of wikis.

Pamatujte prosím na to, že se třídami co jsou definované v tomto rozšíření nebudete moct pracovat, dokud se nezavolá funkce. Pokud tedy vytvoříte instanci třídy dříve, např. v konstruktoru, bude výsledkem to že vaše třída neošetří správným způsobem výjimky.



Psaní testů
Je doporučeno abyste pro vaše údržbářské skripty psali i testy, tak jako u každé jiné třídy. Nápovědu a ukázkové příklady, jak se to dělá najdete na stránce Jak psát testy pro údržbářské skripty.