Manual:Writing maintenance scripts/uk

Це покроковий посібник із написання скрипта обслуговування на основі класу  (див. ), який був представлений у MediaWiki 1.16, щоб полегшити написання сценаріїв обслуговування MediaWiki командного рядка.

Boilerplate
Створимо власний допоміжний скрипт, який буде просто друкувати фразу «Hello, World». У цьому скрипті буде мінімум коду, а також заголовок-коментар із застереженням про авторське право (див. усі заголовки-ліцензії):

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

$ php helloWorld.php Hello, World!

Boilerplate explained
Оскільки це допоміжний скрипт, то ми підключаємо файл. Він подбає за автозавантаження класів тощо. Найкраще слід використовувати повний шлях до файлу $3.


 * Розширюємо клас Maintenance, а потім з

Вказуємо, що при запуску файлу має Maintenance клас  і лише тоді, якщо скрипт запущено з командного рядка (а не з браузера).

Internally,  loads another file  which autoloads MediaWiki classes and configuration, and then

The  method is the entrypoint for maintenance scripts, and is where the main logic of your script will be. Avoid running any code from the constructor.

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") …

Adding a description
"But what is this maintenance script for?" I can hear you asking.

We can put a description at the top of the " " output by using the  method in our constructor:

The output now gives us the description:

$ php helloWorld.php --help

Say hello.

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



Розбір параметрів і аргументів
Привітання усім одразу — це добре, але ми також хочемо надсилати привіт і окремим користувачам.

Щоб передавати параметри скриптові, слід додати конструктор і в ньому викликати метод. Крім того, треба внести зміни до функції. 's parameters are, so:

На цей раз, коли виконується, вихід із скриптів змін  залежно від аргументу, якщо:

 $ 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

Extensions
If your maintenance script is for an extension, then you should add a requirement that the extension is installed:

This provides a helfpul error message when the extension is not enabled. 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.

Be aware that no code may be executed other than through the  method. Attempts to call MediaWiki core services, classes, or functions, or calling your own extension code prior to this, will cause errors or is unreliable and unsupported (e.g. ouside the class declaration, or in the constructor).

Writing tests
It's recommended to write tests for your maintenance scripts, like with any other class. See the Maintenance scripts guide for help and examples.