MediaWiki  1.30.0
SpecialResetTokens.php
Go to the documentation of this file.
1 <?php
31  private $tokensList;
32 
33  public function __construct() {
34  parent::__construct( 'ResetTokens' );
35  }
36 
37  public function doesWrites() {
38  return true;
39  }
40 
47  protected function getTokensList() {
48  if ( !isset( $this->tokensList ) ) {
49  $tokens = [
50  [ 'preference' => 'watchlisttoken', 'label-message' => 'resettokens-watchlist-token' ],
51  ];
52  Hooks::run( 'SpecialResetTokensTokens', [ &$tokens ] );
53 
54  $hiddenPrefs = $this->getConfig()->get( 'HiddenPrefs' );
55  $tokens = array_filter( $tokens, function ( $tok ) use ( $hiddenPrefs ) {
56  return !in_array( $tok['preference'], $hiddenPrefs );
57  } );
58 
59  $this->tokensList = $tokens;
60  }
61 
62  return $this->tokensList;
63  }
64 
65  public function execute( $par ) {
66  // This is a preferences page, so no user JS for y'all.
67  $this->getOutput()->disallowUserJs();
68  $this->requireLogin();
69 
71 
72  $this->getOutput()->addReturnTo( SpecialPage::getTitleFor( 'Preferences' ) );
73  }
74 
75  public function onSuccess() {
76  $this->getOutput()->wrapWikiMsg(
77  "<div class='successbox'>\n$1\n</div>",
78  'resettokens-done'
79  );
80  }
81 
87  protected function getFormFields() {
88  $user = $this->getUser();
89  $tokens = $this->getTokensList();
90 
91  if ( $tokens ) {
92  $tokensForForm = [];
93  foreach ( $tokens as $tok ) {
94  $label = $this->msg( 'resettokens-token-label' )
95  ->rawParams( $this->msg( $tok['label-message'] )->parse() )
96  ->params( $user->getTokenFromOption( $tok['preference'] ) )
97  ->escaped();
98  $tokensForForm[$label] = $tok['preference'];
99  }
100 
101  $desc = [
102  'label-message' => 'resettokens-tokens',
103  'type' => 'multiselect',
104  'options' => $tokensForForm,
105  ];
106  } else {
107  $desc = [
108  'label-message' => 'resettokens-no-tokens',
109  'type' => 'info',
110  ];
111  }
112 
113  return [
114  'tokens' => $desc,
115  ];
116  }
117 
123  protected function alterForm( HTMLForm $form ) {
124  if ( $this->getTokensList() ) {
125  $form->setSubmitTextMsg( 'resettokens-resetbutton' );
126  } else {
127  $form->suppressDefaultSubmit();
128  }
129  }
130 
131  protected function getDisplayFormat() {
132  return 'ooui';
133  }
134 
135  public function onSubmit( array $formData ) {
136  if ( $formData['tokens'] ) {
137  $user = $this->getUser();
138  foreach ( $formData['tokens'] as $tokenPref ) {
139  $user->resetTokenFromOption( $tokenPref );
140  }
141  $user->saveSettings();
142 
143  return true;
144  }
145 
146  return false;
147  }
148 
149  protected function getGroupName() {
150  return 'users';
151  }
152 
153  public function isListed() {
154  return (bool)$this->getTokensList();
155  }
156 }
SpecialResetTokens\__construct
__construct()
Definition: SpecialResetTokens.php:33
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:244
SpecialResetTokens\getDisplayFormat
getDisplayFormat()
Get display format for the form.
Definition: SpecialResetTokens.php:131
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
HTMLForm\suppressDefaultSubmit
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1449
SpecialResetTokens\getTokensList
getTokensList()
Returns the token information list for this page after running the hook and filtering out disabled pr...
Definition: SpecialResetTokens.php:47
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
SpecialResetTokens\$tokensList
$tokensList
Definition: SpecialResetTokens.php:31
FormSpecialPage
Special page which uses an HTMLForm to handle processing.
Definition: FormSpecialPage.php:31
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
SpecialResetTokens\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialResetTokens.php:37
SpecialResetTokens\getFormFields
getFormFields()
Display appropriate message if there's nothing to do.
Definition: SpecialResetTokens.php:87
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:714
SpecialResetTokens\execute
execute( $par)
Basic SpecialPage workflow: get a form, send it to the user; get some data back,.
Definition: SpecialResetTokens.php:65
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:685
SpecialPage\requireLogin
requireLogin( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
If the user is not logged in, throws UserNotLoggedIn error.
Definition: SpecialPage.php:336
execute
$batch execute()
SpecialResetTokens\onSuccess
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
Definition: SpecialResetTokens.php:75
FormSpecialPage\$par
string $par
The sub-page of the special page.
Definition: FormSpecialPage.php:36
$tokens
$tokens
Definition: mwdoc-filter.php:47
SpecialResetTokens\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialResetTokens.php:149
SpecialResetTokens\alterForm
alterForm(HTMLForm $form)
Suppress the submit button if there's nothing to do; provide additional message on it otherwise.
Definition: SpecialResetTokens.php:123
SpecialResetTokens\isListed
isListed()
Whether this special page is listed in Special:SpecialPages.
Definition: SpecialResetTokens.php:153
HTMLForm\setSubmitTextMsg
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1365
SpecialResetTokens
Let users reset tokens like the watchlist token.
Definition: SpecialResetTokens.php:30
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
SpecialResetTokens\onSubmit
onSubmit(array $formData)
Process the form on POST submission.
Definition: SpecialResetTokens.php:135
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
array
the array() calling protocol came about after MediaWiki 1.4rc1.
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:128