MediaWiki  1.29.2
ApiQueryAllUsers.php
Go to the documentation of this file.
1 <?php
33  public function __construct( ApiQuery $query, $moduleName ) {
34  parent::__construct( $query, $moduleName, 'au' );
35  }
36 
43  private function getCanonicalUserName( $name ) {
44  return strtr( $name, '_', ' ' );
45  }
46 
47  public function execute() {
48  $params = $this->extractRequestParams();
49  $activeUserDays = $this->getConfig()->get( 'ActiveUserDays' );
50 
51  $db = $this->getDB();
52 
53  $prop = $params['prop'];
54  if ( !is_null( $prop ) ) {
55  $prop = array_flip( $prop );
56  $fld_blockinfo = isset( $prop['blockinfo'] );
57  $fld_editcount = isset( $prop['editcount'] );
58  $fld_groups = isset( $prop['groups'] );
59  $fld_rights = isset( $prop['rights'] );
60  $fld_registration = isset( $prop['registration'] );
61  $fld_implicitgroups = isset( $prop['implicitgroups'] );
62  $fld_centralids = isset( $prop['centralids'] );
63  } else {
64  $fld_blockinfo = $fld_editcount = $fld_groups = $fld_registration =
65  $fld_rights = $fld_implicitgroups = $fld_centralids = false;
66  }
67 
68  $limit = $params['limit'];
69 
70  $this->addTables( 'user' );
71 
72  $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
73  $from = is_null( $params['from'] ) ? null : $this->getCanonicalUserName( $params['from'] );
74  $to = is_null( $params['to'] ) ? null : $this->getCanonicalUserName( $params['to'] );
75 
76  # MySQL can't figure out that 'user_name' and 'qcc_title' are the same
77  # despite the JOIN condition, so manually sort on the correct one.
78  $userFieldToSort = $params['activeusers'] ? 'qcc_title' : 'user_name';
79 
80  # Some of these subtable joins are going to give us duplicate rows, so
81  # calculate the maximum number of duplicates we might see.
82  $maxDuplicateRows = 1;
83 
84  $this->addWhereRange( $userFieldToSort, $dir, $from, $to );
85 
86  if ( !is_null( $params['prefix'] ) ) {
87  $this->addWhere( $userFieldToSort .
88  $db->buildLike( $this->getCanonicalUserName( $params['prefix'] ), $db->anyString() ) );
89  }
90 
91  if ( !is_null( $params['rights'] ) && count( $params['rights'] ) ) {
92  $groups = [];
93  foreach ( $params['rights'] as $r ) {
94  $groups = array_merge( $groups, User::getGroupsWithPermission( $r ) );
95  }
96 
97  // no group with the given right(s) exists, no need for a query
98  if ( !count( $groups ) ) {
99  $this->getResult()->addIndexedTagName( [ 'query', $this->getModuleName() ], '' );
100 
101  return;
102  }
103 
104  $groups = array_unique( $groups );
105 
106  if ( is_null( $params['group'] ) ) {
107  $params['group'] = $groups;
108  } else {
109  $params['group'] = array_unique( array_merge( $params['group'], $groups ) );
110  }
111  }
112 
113  $this->requireMaxOneParameter( $params, 'group', 'excludegroup' );
114 
115  if ( !is_null( $params['group'] ) && count( $params['group'] ) ) {
116  // Filter only users that belong to a given group. This might
117  // produce as many rows-per-user as there are groups being checked.
118  $this->addTables( 'user_groups', 'ug1' );
119  $this->addJoinConds( [
120  'ug1' => [
121  'INNER JOIN',
122  [
123  'ug1.ug_user=user_id',
124  'ug1.ug_group' => $params['group'],
125  'ug1.ug_expiry IS NULL OR ug1.ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
126  ]
127  ]
128  ] );
129  $maxDuplicateRows *= count( $params['group'] );
130  }
131 
132  if ( !is_null( $params['excludegroup'] ) && count( $params['excludegroup'] ) ) {
133  // Filter only users don't belong to a given group. This can only
134  // produce one row-per-user, because we only keep on "no match".
135  $this->addTables( 'user_groups', 'ug1' );
136 
137  if ( count( $params['excludegroup'] ) == 1 ) {
138  $exclude = [ 'ug1.ug_group' => $params['excludegroup'][0] ];
139  } else {
140  $exclude = [ $db->makeList(
141  [ 'ug1.ug_group' => $params['excludegroup'] ],
142  LIST_OR
143  ) ];
144  }
145  $this->addJoinConds( [ 'ug1' => [ 'LEFT OUTER JOIN',
146  array_merge( [
147  'ug1.ug_user=user_id',
148  'ug1.ug_expiry IS NULL OR ug1.ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
149  ], $exclude )
150  ] ] );
151  $this->addWhere( 'ug1.ug_user IS NULL' );
152  }
153 
154  if ( $params['witheditsonly'] ) {
155  $this->addWhere( 'user_editcount > 0' );
156  }
157 
158  $this->showHiddenUsersAddBlockInfo( $fld_blockinfo );
159 
160  if ( $fld_groups || $fld_rights ) {
161  $this->addFields( [ 'groups' =>
162  $db->buildGroupConcatField( '|', 'user_groups', 'ug_group', [
163  'ug_user=user_id',
164  'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
165  ] )
166  ] );
167  }
168 
169  if ( $params['activeusers'] ) {
170  $activeUserSeconds = $activeUserDays * 86400;
171 
172  // Filter query to only include users in the active users cache.
173  // There shouldn't be any duplicate rows in querycachetwo here.
174  $this->addTables( 'querycachetwo' );
175  $this->addJoinConds( [ 'querycachetwo' => [
176  'INNER JOIN', [
177  'qcc_type' => 'activeusers',
178  'qcc_namespace' => NS_USER,
179  'qcc_title=user_name',
180  ],
181  ] ] );
182 
183  // Actually count the actions using a subquery (T66505 and T66507)
184  $timestamp = $db->timestamp( wfTimestamp( TS_UNIX ) - $activeUserSeconds );
185  $this->addFields( [
186  'recentactions' => '(' . $db->selectSQLText(
187  'recentchanges',
188  'COUNT(*)',
189  [
190  'rc_user_text = user_name',
191  'rc_type != ' . $db->addQuotes( RC_EXTERNAL ), // no wikidata
192  'rc_log_type IS NULL OR rc_log_type != ' . $db->addQuotes( 'newusers' ),
193  'rc_timestamp >= ' . $db->addQuotes( $timestamp ),
194  ]
195  ) . ')'
196  ] );
197  }
198 
199  $sqlLimit = $limit + $maxDuplicateRows;
200  $this->addOption( 'LIMIT', $sqlLimit );
201 
202  $this->addFields( [
203  'user_name',
204  'user_id'
205  ] );
206  $this->addFieldsIf( 'user_editcount', $fld_editcount );
207  $this->addFieldsIf( 'user_registration', $fld_registration );
208 
209  $res = $this->select( __METHOD__ );
210  $count = 0;
211  $countDuplicates = 0;
212  $lastUser = false;
213  $result = $this->getResult();
214  foreach ( $res as $row ) {
215  $count++;
216 
217  if ( $lastUser === $row->user_name ) {
218  // Duplicate row due to one of the needed subtable joins.
219  // Ignore it, but count the number of them to sanely handle
220  // miscalculation of $maxDuplicateRows.
221  $countDuplicates++;
222  if ( $countDuplicates == $maxDuplicateRows ) {
223  ApiBase::dieDebug( __METHOD__, 'Saw more duplicate rows than expected' );
224  }
225  continue;
226  }
227 
228  $countDuplicates = 0;
229  $lastUser = $row->user_name;
230 
231  if ( $count > $limit ) {
232  // We've reached the one extra which shows that there are
233  // additional pages to be had. Stop here...
234  $this->setContinueEnumParameter( 'from', $row->user_name );
235  break;
236  }
237 
238  if ( $count == $sqlLimit ) {
239  // Should never hit this (either the $countDuplicates check or
240  // the $count > $limit check should hit first), but check it
241  // anyway just in case.
242  ApiBase::dieDebug( __METHOD__, 'Saw more duplicate rows than expected' );
243  }
244 
245  if ( $params['activeusers'] && $row->recentactions === 0 ) {
246  // activeusers cache was out of date
247  continue;
248  }
249 
250  $data = [
251  'userid' => (int)$row->user_id,
252  'name' => $row->user_name,
253  ];
254 
255  if ( $fld_centralids ) {
257  $this->getConfig(), User::newFromId( $row->user_id ), $params['attachedwiki']
258  );
259  }
260 
261  if ( $fld_blockinfo && !is_null( $row->ipb_by_text ) ) {
262  $data['blockid'] = (int)$row->ipb_id;
263  $data['blockedby'] = $row->ipb_by_text;
264  $data['blockedbyid'] = (int)$row->ipb_by;
265  $data['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
266  $data['blockreason'] = $row->ipb_reason;
267  $data['blockexpiry'] = $row->ipb_expiry;
268  }
269  if ( $row->ipb_deleted ) {
270  $data['hidden'] = true;
271  }
272  if ( $fld_editcount ) {
273  $data['editcount'] = intval( $row->user_editcount );
274  }
275  if ( $params['activeusers'] ) {
276  $data['recentactions'] = intval( $row->recentactions );
277  // @todo 'recenteditcount' is set for BC, remove in 1.25
278  $data['recenteditcount'] = $data['recentactions'];
279  }
280  if ( $fld_registration ) {
281  $data['registration'] = $row->user_registration ?
282  wfTimestamp( TS_ISO_8601, $row->user_registration ) : '';
283  }
284 
285  if ( $fld_implicitgroups || $fld_groups || $fld_rights ) {
286  $implicitGroups = User::newFromId( $row->user_id )->getAutomaticGroups();
287  if ( isset( $row->groups ) && $row->groups !== '' ) {
288  $groups = array_merge( $implicitGroups, explode( '|', $row->groups ) );
289  } else {
290  $groups = $implicitGroups;
291  }
292 
293  if ( $fld_groups ) {
294  $data['groups'] = $groups;
295  ApiResult::setIndexedTagName( $data['groups'], 'g' );
296  ApiResult::setArrayType( $data['groups'], 'array' );
297  }
298 
299  if ( $fld_implicitgroups ) {
300  $data['implicitgroups'] = $implicitGroups;
301  ApiResult::setIndexedTagName( $data['implicitgroups'], 'g' );
302  ApiResult::setArrayType( $data['implicitgroups'], 'array' );
303  }
304 
305  if ( $fld_rights ) {
306  $data['rights'] = User::getGroupPermissions( $groups );
307  ApiResult::setIndexedTagName( $data['rights'], 'r' );
308  ApiResult::setArrayType( $data['rights'], 'array' );
309  }
310  }
311 
312  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $data );
313  if ( !$fit ) {
314  $this->setContinueEnumParameter( 'from', $data['name'] );
315  break;
316  }
317  }
318 
319  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'u' );
320  }
321 
322  public function getCacheMode( $params ) {
323  return 'anon-public-user-private';
324  }
325 
326  public function getAllowedParams() {
327  $userGroups = User::getAllGroups();
328 
329  return [
330  'from' => null,
331  'to' => null,
332  'prefix' => null,
333  'dir' => [
334  ApiBase::PARAM_DFLT => 'ascending',
336  'ascending',
337  'descending'
338  ],
339  ],
340  'group' => [
341  ApiBase::PARAM_TYPE => $userGroups,
342  ApiBase::PARAM_ISMULTI => true,
343  ],
344  'excludegroup' => [
345  ApiBase::PARAM_TYPE => $userGroups,
346  ApiBase::PARAM_ISMULTI => true,
347  ],
348  'rights' => [
350  ApiBase::PARAM_ISMULTI => true,
351  ],
352  'prop' => [
353  ApiBase::PARAM_ISMULTI => true,
355  'blockinfo',
356  'groups',
357  'implicitgroups',
358  'rights',
359  'editcount',
360  'registration',
361  'centralids',
362  ],
364  ],
365  'limit' => [
366  ApiBase::PARAM_DFLT => 10,
367  ApiBase::PARAM_TYPE => 'limit',
368  ApiBase::PARAM_MIN => 1,
371  ],
372  'witheditsonly' => false,
373  'activeusers' => [
374  ApiBase::PARAM_DFLT => false,
376  'apihelp-query+allusers-param-activeusers',
377  $this->getConfig()->get( 'ActiveUserDays' )
378  ],
379  ],
380  'attachedwiki' => null,
381  ];
382  }
383 
384  protected function getExamplesMessages() {
385  return [
386  'action=query&list=allusers&aufrom=Y'
387  => 'apihelp-query+allusers-example-Y',
388  ];
389  }
390 
391  public function getHelpUrls() {
392  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allusers';
393  }
394 }
ContextSource\getConfig
getConfig()
Get the Config object.
Definition: ContextSource.php:68
ApiQueryBase\showHiddenUsersAddBlockInfo
showHiddenUsersAddBlockInfo( $showBlockInfo)
Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block in...
Definition: ApiQueryBase.php:447
if
if($IP===false)
Definition: cleanupArchiveUserText.php:4
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:579
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:198
RC_EXTERNAL
const RC_EXTERNAL
Definition: Defines.php:143
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
ApiQueryAllUsers\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryAllUsers.php:384
captcha-old.count
count
Definition: captcha-old.py:225
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:128
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1954
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1994
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:610
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:333
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:212
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
ApiQueryAllUsers\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryAllUsers.php:322
$query
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1572
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:103
ApiResult\setArrayType
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
LIST_OR
const LIST_OR
Definition: Defines.php:44
ApiQueryAllUsers\getCanonicalUserName
getCanonicalUserName( $name)
This function converts the user name to a canonical form which is stored in the database.
Definition: ApiQueryAllUsers.php:43
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:37
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:203
ApiQueryAllUsers\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryAllUsers.php:326
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:111
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:94
$limit
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1049
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:164
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:358
$dir
$dir
Definition: Autoload.php:8
ApiQueryBase\addWhereRange
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
Definition: ApiQueryBase.php:286
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:718
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
User\getGroupPermissions
static getGroupPermissions( $groups)
Get the permissions associated with a given list of groups.
Definition: User.php:4716
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:187
User\getAllGroups
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:4860
ApiBase\requireMaxOneParameter
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:792
User\getAllRights
static getAllRights()
Get a list of all available permissions.
Definition: User.php:4872
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:205
ApiQueryAllUsers
Query module to enumerate all registered users.
Definition: ApiQueryAllUsers.php:32
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:52
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
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:490
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
NS_USER
const NS_USER
Definition: Defines.php:64
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:100
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:233
ApiQueryUserInfo\getCentralUserInfo
static getCentralUserInfo(Config $config, User $user, $attachedWiki=null)
Get central user info.
Definition: ApiQueryUserInfo.php:95
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:535
ApiQueryAllUsers\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryAllUsers.php:47
ApiBase\PARAM_HELP_MSG_PER_VALUE
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:160
ApiQueryAllUsers\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryAllUsers.php:391
ApiQueryAllUsers\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryAllUsers.php:33
ApiBase\dieDebug
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:1962
User\getGroupsWithPermission
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
Definition: User.php:4743