UserOptionsUpdateJob.php 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. * Job that updates a user's preferences
  25. *
  26. * The following job parameters are required:
  27. * - userId: the user ID
  28. * - options: a map of (option => value)
  29. *
  30. * @since 1.33
  31. */
  32. class UserOptionsUpdateJob extends Job implements GenericParameterJob {
  33. public function __construct( array $params ) {
  34. parent::__construct( 'userOptionsUpdate', $params );
  35. $this->removeDuplicates = true;
  36. }
  37. public function run() {
  38. if ( !$this->params['options'] ) {
  39. return true; // nothing to do
  40. }
  41. $user = User::newFromId( $this->params['userId'] );
  42. $user->load( $user::READ_EXCLUSIVE );
  43. if ( !$user->getId() ) {
  44. return true;
  45. }
  46. foreach ( $this->params['options'] as $name => $value ) {
  47. $user->setOption( $name, $value );
  48. }
  49. $user->saveSettings();
  50. return true;
  51. }
  52. }