includes/jobqueue/jobs/UserOptionsUpdateJob.php

   1 <?php
   2 /**
   3  * Job that updates a user's preferences.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup JobQueue
  22  */
  23
  24 /**
  25  * Job that updates a user's preferences
  26  *
  27  * The following job parameters are required:
  28  *   - userId: the user ID
  29  *   - options: a map of (option => value)
  30  *
  31  * @since 1.33
  32  */
  33 class UserOptionsUpdateJob extends Job implements GenericParameterJob {
  34         public function __construct( array $params ) {
  35                 parent::__construct( 'userOptionsUpdate', $params );
  36                 $this->removeDuplicates = true;
  37         }
  38
  39         public function run() {
  40                 if ( !$this->params['options'] ) {
  41                         return true; // nothing to do
  42                 }
  43
  44                 $user = User::newFromId( $this->params['userId'] );
  45                 $user->load( $user::READ_EXCLUSIVE );
  46                 if ( !$user->getId() ) {
  47                         return true;
  48                 }
  49
  50                 foreach ( $this->params['options'] as $name => $value ) {
  51                         $user->setOption( $name, $value );
  52                 }
  53
  54                 $user->saveSettings();
  55
  56                 return true;
  57         }
  58 }