wiki.techinc.nl/maintenance/addChangeTag.php
Bartosz Dziewoński 4108bbe1af Maintenance: Print errors from StatusValue objects in a consistent way
Allow Maintenance::error() and Maintenance::fatalError() to take
StatusValue objects. They now print each error message from the
status on a separate line, in English, ignoring on-wiki message
overrides, as wikitext but after parser function expansion.

Thoughts on the previously commonly used methods:

- $status->getMessage( false, false, 'en' )->text()
  Almost the same as the new output, but it allows on-wiki message
  overrides, and if there is more than one error, it prefixes each
  line with a '*' (like a wikitext list).

- $status->getMessage( false, false, 'en' )->plain()
- $status->getWikiText( false, false, 'en' )
  As above, but these forms do not expand parser functions
  such as {{GENDER:}}.

- print_r( $status->getErrorsArray(), true )
- print_r( $status->getErrors(), true )
  These forms output the message keys instead of the message text,
  which is not very human-readable.

The error messages are now always printed using error() rather
than output(), which means they go to STDERR rather than STDOUT
and they're printed even with the --quiet flag.

Change-Id: I5b8e7c7ed2a896a1029f58857a478d3f1b4b0589
2024-06-12 00:07:02 +02:00

66 lines
1.8 KiB
PHP

<?php
/**
* Adds a change tag to the wiki.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
*/
use MediaWiki\Permissions\UltimateAuthority;
use MediaWiki\User\User;
require_once __DIR__ . '/Maintenance.php';
/**
* Adds a change tag to the wiki
*
* @ingroup Maintenance
* @since 1.32
*/
class AddChangeTag extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( 'Adds a change tag to the wiki.' );
$this->addOption( 'tag', 'Tag to add', true, true );
$this->addOption( 'reason', 'Reason for adding the tag', true, true );
}
public function execute() {
$user = User::newSystemUser( User::MAINTENANCE_SCRIPT_USER, [ 'steal' => true ] );
$tag = $this->getOption( 'tag' );
$status = ChangeTags::createTagWithChecks(
$tag,
$this->getOption( 'reason' ),
new UltimateAuthority( $user )
);
if ( !$status->isGood() ) {
$this->fatalError( $status );
}
$this->output( "$tag was created.\n" );
}
}
$maintClass = AddChangeTag::class;
require_once RUN_MAINTENANCE_IF_MAIN;