maintenance/addChangeTag.php

   1 <?php
   2
   3 /**
   4  * Adds a change tag to the wiki.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Maintenance
  23  */
  24
  25 use MediaWiki\Permissions\UltimateAuthority;
  26 use MediaWiki\User\User;
  27
  28 // @codeCoverageIgnoreStart
  29 require_once __DIR__ . '/Maintenance.php';
  30 // @codeCoverageIgnoreEnd
  31
  32 /**
  33  * Adds a change tag to the wiki
  34  *
  35  * @ingroup Maintenance
  36  * @since 1.32
  37  */
  38 class AddChangeTag extends Maintenance {
  39
  40         public function __construct() {
  41                 parent::__construct();
  42                 $this->addDescription( 'Adds a change tag to the wiki.' );
  43
  44                 $this->addOption( 'tag', 'Tag to add', true, true );
  45                 $this->addOption( 'reason', 'Reason for adding the tag', true, true );
  46         }
  47
  48         public function execute() {
  49                 $user = User::newSystemUser( User::MAINTENANCE_SCRIPT_USER, [ 'steal' => true ] );
  50
  51                 $tag = $this->getOption( 'tag' );
  52
  53                 $status = ChangeTags::createTagWithChecks(
  54                         $tag,
  55                         $this->getOption( 'reason' ),
  56                         new UltimateAuthority( $user )
  57                 );
  58
  59                 if ( !$status->isGood() ) {
  60                         $this->fatalError( $status );
  61                 }
  62
  63                 $this->output( "$tag was created.\n" );
  64         }
  65 }
  66
  67 // @codeCoverageIgnoreStart
  68 $maintClass = AddChangeTag::class;
  69 require_once RUN_MAINTENANCE_IF_MAIN;
  70 // @codeCoverageIgnoreEnd