MediaWiki  1.29.1
ApiQueryBlocks.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'bk' );
36  }
37 
38  public function execute() {
39  $db = $this->getDB();
40  $params = $this->extractRequestParams();
41  $this->requireMaxOneParameter( $params, 'users', 'ip' );
42 
43  $prop = array_flip( $params['prop'] );
44  $fld_id = isset( $prop['id'] );
45  $fld_user = isset( $prop['user'] );
46  $fld_userid = isset( $prop['userid'] );
47  $fld_by = isset( $prop['by'] );
48  $fld_byid = isset( $prop['byid'] );
49  $fld_timestamp = isset( $prop['timestamp'] );
50  $fld_expiry = isset( $prop['expiry'] );
51  $fld_reason = isset( $prop['reason'] );
52  $fld_range = isset( $prop['range'] );
53  $fld_flags = isset( $prop['flags'] );
54 
55  $result = $this->getResult();
56 
57  $this->addTables( 'ipblocks' );
58  $this->addFields( [ 'ipb_auto', 'ipb_id', 'ipb_timestamp' ] );
59 
60  $this->addFieldsIf( [ 'ipb_address', 'ipb_user' ], $fld_user || $fld_userid );
61  $this->addFieldsIf( 'ipb_by_text', $fld_by );
62  $this->addFieldsIf( 'ipb_by', $fld_byid );
63  $this->addFieldsIf( 'ipb_expiry', $fld_expiry );
64  $this->addFieldsIf( 'ipb_reason', $fld_reason );
65  $this->addFieldsIf( [ 'ipb_range_start', 'ipb_range_end' ], $fld_range );
66  $this->addFieldsIf( [ 'ipb_anon_only', 'ipb_create_account', 'ipb_enable_autoblock',
67  'ipb_block_email', 'ipb_deleted', 'ipb_allow_usertalk' ],
68  $fld_flags );
69 
70  $this->addOption( 'LIMIT', $params['limit'] + 1 );
72  'ipb_timestamp',
73  $params['dir'],
74  $params['start'],
75  $params['end']
76  );
77  // Include in ORDER BY for uniqueness
78  $this->addWhereRange( 'ipb_id', $params['dir'], null, null );
79 
80  if ( !is_null( $params['continue'] ) ) {
81  $cont = explode( '|', $params['continue'] );
82  $this->dieContinueUsageIf( count( $cont ) != 2 );
83  $op = ( $params['dir'] == 'newer' ? '>' : '<' );
84  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
85  $continueId = (int)$cont[1];
86  $this->dieContinueUsageIf( $continueId != $cont[1] );
87  $this->addWhere( "ipb_timestamp $op $continueTimestamp OR " .
88  "(ipb_timestamp = $continueTimestamp AND " .
89  "ipb_id $op= $continueId)"
90  );
91  }
92 
93  if ( isset( $params['ids'] ) ) {
94  $this->addWhereFld( 'ipb_id', $params['ids'] );
95  }
96  if ( isset( $params['users'] ) ) {
97  $usernames = [];
98  foreach ( (array)$params['users'] as $u ) {
99  $usernames[] = $this->prepareUsername( $u );
100  }
101  $this->addWhereFld( 'ipb_address', $usernames );
102  $this->addWhereFld( 'ipb_auto', 0 );
103  }
104  if ( isset( $params['ip'] ) ) {
105  $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
106  if ( IP::isIPv4( $params['ip'] ) ) {
107  $type = 'IPv4';
108  $cidrLimit = $blockCIDRLimit['IPv4'];
109  $prefixLen = 0;
110  } elseif ( IP::isIPv6( $params['ip'] ) ) {
111  $type = 'IPv6';
112  $cidrLimit = $blockCIDRLimit['IPv6'];
113  $prefixLen = 3; // IP::toHex output is prefixed with "v6-"
114  } else {
115  $this->dieWithError( 'apierror-badip', 'param_ip' );
116  }
117 
118  # Check range validity, if it's a CIDR
119  list( $ip, $range ) = IP::parseCIDR( $params['ip'] );
120  if ( $ip !== false && $range !== false && $range < $cidrLimit ) {
121  $this->dieWithError( [ 'apierror-cidrtoobroad', $type, $cidrLimit ] );
122  }
123 
124  # Let IP::parseRange handle calculating $upper, instead of duplicating the logic here.
125  list( $lower, $upper ) = IP::parseRange( $params['ip'] );
126 
127  # Extract the common prefix to any rangeblock affecting this IP/CIDR
128  $prefix = substr( $lower, 0, $prefixLen + floor( $cidrLimit / 4 ) );
129 
130  # Fairly hard to make a malicious SQL statement out of hex characters,
131  # but it is good practice to add quotes
132  $lower = $db->addQuotes( $lower );
133  $upper = $db->addQuotes( $upper );
134 
135  $this->addWhere( [
136  'ipb_range_start' . $db->buildLike( $prefix, $db->anyString() ),
137  'ipb_range_start <= ' . $lower,
138  'ipb_range_end >= ' . $upper,
139  'ipb_auto' => 0
140  ] );
141  }
142 
143  if ( !is_null( $params['show'] ) ) {
144  $show = array_flip( $params['show'] );
145 
146  /* Check for conflicting parameters. */
147  if ( ( isset( $show['account'] ) && isset( $show['!account'] ) )
148  || ( isset( $show['ip'] ) && isset( $show['!ip'] ) )
149  || ( isset( $show['range'] ) && isset( $show['!range'] ) )
150  || ( isset( $show['temp'] ) && isset( $show['!temp'] ) )
151  ) {
152  $this->dieWithError( 'apierror-show' );
153  }
154 
155  $this->addWhereIf( 'ipb_user = 0', isset( $show['!account'] ) );
156  $this->addWhereIf( 'ipb_user != 0', isset( $show['account'] ) );
157  $this->addWhereIf( 'ipb_user != 0 OR ipb_range_end > ipb_range_start', isset( $show['!ip'] ) );
158  $this->addWhereIf( 'ipb_user = 0 AND ipb_range_end = ipb_range_start', isset( $show['ip'] ) );
159  $this->addWhereIf( 'ipb_expiry = ' .
160  $db->addQuotes( $db->getInfinity() ), isset( $show['!temp'] ) );
161  $this->addWhereIf( 'ipb_expiry != ' .
162  $db->addQuotes( $db->getInfinity() ), isset( $show['temp'] ) );
163  $this->addWhereIf( 'ipb_range_end = ipb_range_start', isset( $show['!range'] ) );
164  $this->addWhereIf( 'ipb_range_end > ipb_range_start', isset( $show['range'] ) );
165  }
166 
167  if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
168  $this->addWhereFld( 'ipb_deleted', 0 );
169  }
170 
171  # Filter out expired rows
172  $this->addWhere( 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() ) );
173 
174  $res = $this->select( __METHOD__ );
175 
176  $count = 0;
177  foreach ( $res as $row ) {
178  if ( ++$count > $params['limit'] ) {
179  // We've had enough
180  $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
181  break;
182  }
183  $block = [
184  ApiResult::META_TYPE => 'assoc',
185  ];
186  if ( $fld_id ) {
187  $block['id'] = (int)$row->ipb_id;
188  }
189  if ( $fld_user && !$row->ipb_auto ) {
190  $block['user'] = $row->ipb_address;
191  }
192  if ( $fld_userid && !$row->ipb_auto ) {
193  $block['userid'] = (int)$row->ipb_user;
194  }
195  if ( $fld_by ) {
196  $block['by'] = $row->ipb_by_text;
197  }
198  if ( $fld_byid ) {
199  $block['byid'] = (int)$row->ipb_by;
200  }
201  if ( $fld_timestamp ) {
202  $block['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
203  }
204  if ( $fld_expiry ) {
205  $block['expiry'] = ApiResult::formatExpiry( $row->ipb_expiry );
206  }
207  if ( $fld_reason ) {
208  $block['reason'] = $row->ipb_reason;
209  }
210  if ( $fld_range && !$row->ipb_auto ) {
211  $block['rangestart'] = IP::formatHex( $row->ipb_range_start );
212  $block['rangeend'] = IP::formatHex( $row->ipb_range_end );
213  }
214  if ( $fld_flags ) {
215  // For clarity, these flags use the same names as their action=block counterparts
216  $block['automatic'] = (bool)$row->ipb_auto;
217  $block['anononly'] = (bool)$row->ipb_anon_only;
218  $block['nocreate'] = (bool)$row->ipb_create_account;
219  $block['autoblock'] = (bool)$row->ipb_enable_autoblock;
220  $block['noemail'] = (bool)$row->ipb_block_email;
221  $block['hidden'] = (bool)$row->ipb_deleted;
222  $block['allowusertalk'] = (bool)$row->ipb_allow_usertalk;
223  }
224  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $block );
225  if ( !$fit ) {
226  $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
227  break;
228  }
229  }
230  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'block' );
231  }
232 
233  protected function prepareUsername( $user ) {
234  if ( !$user ) {
235  $encParamName = $this->encodeParamName( 'users' );
236  $this->dieWithError( [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $user ) ],
237  "baduser_{$encParamName}"
238  );
239  }
240  $name = User::isIP( $user )
241  ? $user
242  : User::getCanonicalName( $user, 'valid' );
243  if ( $name === false ) {
244  $encParamName = $this->encodeParamName( 'users' );
245  $this->dieWithError( [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $user ) ],
246  "baduser_{$encParamName}"
247  );
248  }
249  return $name;
250  }
251 
252  public function getAllowedParams() {
253  $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
254 
255  return [
256  'start' => [
257  ApiBase::PARAM_TYPE => 'timestamp'
258  ],
259  'end' => [
260  ApiBase::PARAM_TYPE => 'timestamp',
261  ],
262  'dir' => [
264  'newer',
265  'older'
266  ],
267  ApiBase::PARAM_DFLT => 'older',
268  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
269  ],
270  'ids' => [
271  ApiBase::PARAM_TYPE => 'integer',
273  ],
274  'users' => [
275  ApiBase::PARAM_TYPE => 'user',
277  ],
278  'ip' => [
280  'apihelp-query+blocks-param-ip',
281  $blockCIDRLimit['IPv4'],
282  $blockCIDRLimit['IPv6'],
283  ],
284  ],
285  'limit' => [
286  ApiBase::PARAM_DFLT => 10,
287  ApiBase::PARAM_TYPE => 'limit',
288  ApiBase::PARAM_MIN => 1,
291  ],
292  'prop' => [
293  ApiBase::PARAM_DFLT => 'id|user|by|timestamp|expiry|reason|flags',
295  'id',
296  'user',
297  'userid',
298  'by',
299  'byid',
300  'timestamp',
301  'expiry',
302  'reason',
303  'range',
304  'flags'
305  ],
306  ApiBase::PARAM_ISMULTI => true,
308  ],
309  'show' => [
311  'account',
312  '!account',
313  'temp',
314  '!temp',
315  'ip',
316  '!ip',
317  'range',
318  '!range',
319  ],
321  ],
322  'continue' => [
323  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
324  ],
325  ];
326  }
327 
328  protected function getExamplesMessages() {
329  return [
330  'action=query&list=blocks'
331  => 'apihelp-query+blocks-example-simple',
332  'action=query&list=blocks&bkusers=Alice|Bob'
333  => 'apihelp-query+blocks-example-users',
334  ];
335  }
336 
337  public function getHelpUrls() {
338  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Blocks';
339  }
340 }
ContextSource\getConfig
getConfig()
Get the Config object.
Definition: ContextSource.php:68
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:198
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
captcha-old.count
count
Definition: captcha-old.py:225
ApiResult\META_TYPE
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1796
ApiQueryBase\addTimestampWhereRange
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
Definition: ApiQueryBase.php:321
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:128
ApiQueryBlocks\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryBlocks.php:252
$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
$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:246
ApiQueryBlocks\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryBlocks.php:328
$params
$params
Definition: styleTest.css.php:40
IP\isIPv6
static isIPv6( $ip)
Given a string, determine if it as valid IP in IPv6 only.
Definition: IP.php:90
$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
$type
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2536
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
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
ApiQueryBlocks\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryBlocks.php:337
ApiQueryBlocks
Query module to enumerate all user blocks.
Definition: ApiQueryBlocks.php:32
$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
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
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
ApiQueryBlocks\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryBlocks.php:34
User\isIP
static isIP( $name)
Does the string match an anonymous IP address?
Definition: User.php:819
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
ApiQueryBlocks\prepareUsername
prepareUsername( $user)
Definition: ApiQueryBlocks.php:233
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
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
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1950
ApiBase\encodeParamName
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:699
IP\parseRange
static parseRange( $range)
Given a string range in a number of formats, return the start and end of the range in hexadecimal.
Definition: IP.php:501
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1657
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:266
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
ApiQueryBlocks\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryBlocks.php:38
IP\isIPv4
static isIPv4( $ip)
Given a string, determine if it as valid IP in IPv4 only.
Definition: IP.php:101
IP\parseCIDR
static parseCIDR( $range)
Convert a network specification in CIDR notation to an integer network and a number of bits.
Definition: IP.php:458
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:205
User\getCanonicalName
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid.
Definition: User.php:1076
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
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:100
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1956
ApiResult\formatExpiry
static formatExpiry( $expiry, $infinity='infinity')
Format an expiry timestamp for API output.
Definition: ApiResult.php:1207
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:233
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:535
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
ApiQueryBase\addWhereIf
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
Definition: ApiQueryBase.php:251
array
the array() calling protocol came about after MediaWiki 1.4rc1.
IP\formatHex
static formatHex( $hex)
Convert an IPv4 or IPv6 hexadecimal representation back to readable format.
Definition: IP.php:320