View source for Manual:Writing maintenance scripts/uk

<languages />
{{Maintenance scripts}}

Це покроковий посібник із написання скрипта обслуговування на основі класу <code>Maintenance</code> (див. {{ll|Manual:Maintenance.php|Maintenance.php}}), який був представлений у MediaWiki 1.16, щоб полегшити написання сценаріїв обслуговування MediaWiki командного рядка.
__TOC__
<div lang="en" dir="ltr" class="mw-content-ltr">
== Boilerplate ==
</div>

<div class="mw-translate-fuzzy">
Створимо власний допоміжний скрипт <code>helloWorld.php</code>, який буде просто друкувати фразу «Hello, World». У цьому скрипті буде мінімум коду, а також заголовок-коментар із застереженням про авторське право (див. усі [[Special:MyLanguage/copyright headers|заголовки-ліцензії]]):
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The below example program will print "Hello, World!".
</div>

{{note|1=
The way to invoke maintenance scripts changed in 2023 with MediaWiki 1.40, with the new {{ll|Manual:run.php|run.php}} being used to launch all maintenance scripts, rather than directly calling them by filename (although the latter remains supported for now).
<span lang="en" dir="ltr" class="mw-content-ltr">This tutorial covers both methods, and notes where there are differences between the systems.</span>
}}

<div lang="en" dir="ltr" class="mw-content-ltr">
=== MediaWiki core ===
</div>

; Command
: <syntaxhighlight lang="shell">
$ ./maintenance/run HelloWorld
Hello, World!
</syntaxhighlight>

; Filename
: <code>maintenance/HelloWorld.php</code>

; Code
: <syntaxhighlight lang="php">
<?php

require_once __DIR__ . '/Maintenance.php';

/**
 * Brief oneline description of Hello world.
 *
 * @since 1.17
 * @ingroup Maintenance
 */
class HelloWorld extends Maintenance {
	public function execute() {
		$this->output( "Hello, World!\n" );
	}
}

$maintClass = HelloWorld::class;
require_once RUN_MAINTENANCE_IF_MAIN;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== MediaWiki extension ===
</div>
; Command
: <syntaxhighlight lang="shell">
$ ./maintenance/run MyExtension:HelloWorld
Hello, World!
</syntaxhighlight>

; Filename
: <code>extensions/MyExtension/maintenance/HelloWorld.php</code>
; Code
: <syntaxhighlight lang="php">
<?php

namespace MediaWiki\Extension\MyExtension\Maintenance;

use Maintenance;

$IP = getenv( 'MW_INSTALL_PATH' );
if ( $IP === false ) {
	$IP = __DIR__ . '/../../..';
}
require_once "$IP/maintenance/Maintenance.php";

/**
 * Brief oneline description of Hello world.
 */
class HelloWorld extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->requireExtension( 'Extension' );
	}

	public function execute() {
		$this->output( "Hello, World!\n" );
	}
}

$maintClass = HelloWorld::class;
require_once RUN_MAINTENANCE_IF_MAIN;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Boilerplate explained ==
</div>

<syntaxhighlight lang="php">
require_once __DIR__ . "/Maintenance.php";
</syntaxhighlight>

<div class="mw-translate-fuzzy">
Оскільки це допоміжний скрипт, то ми підключаємо файл <code>Maintenance.php</code>. Він подбає за автозавантаження класів тощо. Найкраще слід використовувати повний шлях до файлу $3.
</div>

<syntaxhighlight lang="php">
class HelloWorld extends Maintenance {
}
</syntaxhighlight>

<div class="mw-translate-fuzzy">
: Розширюємо клас Maintenance, а потім з
</div>

<syntaxhighlight lang="php">
$maintClass = HelloWorld::class;
require_once RUN_MAINTENANCE_IF_MAIN;
</syntaxhighlight>

<div class="mw-translate-fuzzy">
Вказуємо, що при запуску файлу має Maintenance клас <code>HelloWorld</code> і лише тоді, якщо скрипт запущено з командного рядка (а не з браузера).
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Internally, <code>RUN_MAINTENANCE_IF_MAIN</code> loads another file {{file doclink|doMaintenance}} which autoloads MediaWiki classes and configuration, and then runs our <code>execute()</code> method.
</div>

<syntaxhighlight lang="php">
	public function execute() {
	}
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
The <code>execute()</code> 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.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div> 

<div lang="en" dir="ltr" class="mw-content-ltr">
== Help command ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
One of the built-in features that all maintenance scripts enjoy is a <code>--help</code> option. The above example boilerplate would produce the following help page:
</div>

<pre>
$ 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")
…
</pre>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Adding a description ==
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">"But what is this maintenance script for?"</span>
<span lang="en" dir="ltr" class="mw-content-ltr">I can hear you asking.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
We can put a description at the top of the "<code>--help</code>" output by using the <code>addDescription</code> method in our constructor:
</div>

<syntaxhighlight lang="php">
	public function __construct() {
		parent::__construct();

		$this->addDescription( 'Say hello.' );
	}
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
The output now gives us the description:
</div>

<pre>
$ php helloWorld.php --help

Say hello.

Usage: php helloWorld.php [--help]
…
</pre>

<span id="Option_and_argument_parsing"></span>
== Розбір параметрів і аргументів ==

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

Щоб передавати параметри скриптові, слід додати конструктор і в ньому викликати метод <code>addOption()</code>. Крім того, треба внести зміни до функції <code>execute()</code>.
<span lang="en" dir="ltr" class="mw-content-ltr"><code>addOption()</code>'s parameters are <syntaxhighlight lang="php" inline>$name, $description, $required = false, $withArg = false, $shortName = false</syntaxhighlight>, so:</span>

<syntaxhighlight lang="php">
	public function __construct() {
		parent::__construct();

		$this->addDescription( 'Say hello.' );
		$this->addOption( 'name', 'Who to say Hello to', false, true );
	}

	public function execute() {
		$name = $this->getOption( 'name', 'World' );
		$this->output( "Hello, $name!" );
	}
</syntaxhighlight>

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

<pre style="overflow:auto">
$ 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
</pre>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Extensions ==
</div>
{{MW version|version=1.28|comment=and after|gerrit change=301709}}
<div lang="en" dir="ltr" class="mw-content-ltr">
If your maintenance script is for an extension, then you should add a requirement that the extension is installed:
</div>

<syntaxhighlight lang="php">
	public function __construct() {
		parent::__construct();
		$this->addOption( 'name', 'Who to say Hello to' );

		$this->requireExtension( 'FooBar' );
	}
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">This provides a helfpul error message when the extension is not enabled.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Be aware that no code may be executed other than through the <code>execute()</code> method.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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).</span>

== Profiling ==

Maintenance scripts support a <code>--profiler</code> option, which can be used to track code execution during a page action and report back the percentage of total code execution that was spent in any specific function.
See {{ll|Manual:Profiling}}.

<div lang="en" dir="ltr" class="mw-content-ltr">
== Writing tests ==
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">It's recommended to write tests for your maintenance scripts, like with any other class.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">See the [[Special:MyLanguage/Manual:PHP unit testing/Writing unit tests#Maintenance scripts|Maintenance scripts]] guide for help and examples.</span>

[[Category:Maintenance scripts{{#translation:}}| ]]
[[Category:MediaWiki development{{#translation:}}]]
[[Category:Tutorials{{#translation:}}|Maintenance]]