Merge "Add passing ''italic'''s case to 'Unclosed and unmatched quotes' test"
[lhc/web/wiklou.git] / maintenance / createAndPromote.php
index 566885c..3f328f9 100644 (file)
@@ -1,7 +1,6 @@
 <?php
-
 /**
- * Maintenance script to create an account and grant it administrator rights
+ * Creates an account and grant it administrator rights.
  *
  * 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
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  * @author Rob Church <robchur@gmail.com>
  */
 
-require_once( "Maintenance.php" );
+require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script to create an account and grant it administrator rights.
+ *
+ * @ingroup Maintenance
+ */
 class CreateAndPromote extends Maintenance {
 
        public function __construct() {
                parent::__construct();
-               $this->mDescription = "Create a new user account with administrator rights";
+               $this->mDescription = "Create a new user account";
+               $this->addOption( "sysop", "Grant the account sysop rights" );
                $this->addOption( "bureaucrat", "Grant the account bureaucrat rights" );
-               $this->addArgs( array( "username", "password" ) );
+               $this->addArg( "username", "Username of new user" );
+               $this->addArg( "password", "Password to set" );
        }
 
        public function execute() {
-               $username = $this->getArg(0);
-               $password = $this->getArg(1);
-               
+               $username = $this->getArg( 0 );
+               $password = $this->getArg( 1 );
+
                $this->output( wfWikiID() . ": Creating and promoting User:{$username}..." );
-               
+
                $user = User::newFromName( $username );
-               if( !is_object( $user ) ) {
-                       $this->error( "invalid username.\n", true );
-               } elseif( 0 != $user->idForName() ) {
-                       $this->error( "account exists.\n", true );
+               if ( !is_object( $user ) ) {
+                       $this->error( "invalid username.", true );
+               } elseif ( 0 != $user->idForName() ) {
+                       $this->error( "account exists.", true );
                }
 
                # Try to set the password
                try {
                        $user->setPassword( $password );
-               } catch( PasswordError $pwe ) {
+               } catch ( PasswordError $pwe ) {
                        $this->error( $pwe->getText(), true );
                }
 
                # Insert the account into the database
                $user->addToDatabase();
                $user->saveSettings();
-       
+
                # Promote user
-               $user->addGroup( 'sysop' );
-               if( $this->hasOption( 'bureaucrat' ) )
+               if ( $this->hasOption( 'sysop' ) ) {
+                       $user->addGroup( 'sysop' );
+               }
+               if ( $this->hasOption( 'bureaucrat' ) ) {
                        $user->addGroup( 'bureaucrat' );
-       
+               }
+
                # Increment site_stats.ss_users
                $ssu = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
                $ssu->doUpdate();
-       
+
                $this->output( "done.\n" );
        }
 }
 
 $maintClass = "CreateAndPromote";
-require_once( DO_MAINTENANCE );
\ No newline at end of file
+require_once( RUN_MAINTENANCE_IF_MAIN );