MediaWiki  REL1_31
ApiQueryBlocks.php
Go to the documentation of this file.
1 <?php
29 
30  public function __construct( ApiQuery $query, $moduleName ) {
31  parent::__construct( $query, $moduleName, 'bk' );
32  }
33 
34  public function execute() {
35  $db = $this->getDB();
36  $commentStore = CommentStore::getStore();
37  $params = $this->extractRequestParams();
38  $this->requireMaxOneParameter( $params, 'users', 'ip' );
39 
40  $prop = array_flip( $params['prop'] );
41  $fld_id = isset( $prop['id'] );
42  $fld_user = isset( $prop['user'] );
43  $fld_userid = isset( $prop['userid'] );
44  $fld_by = isset( $prop['by'] );
45  $fld_byid = isset( $prop['byid'] );
46  $fld_timestamp = isset( $prop['timestamp'] );
47  $fld_expiry = isset( $prop['expiry'] );
48  $fld_reason = isset( $prop['reason'] );
49  $fld_range = isset( $prop['range'] );
50  $fld_flags = isset( $prop['flags'] );
51 
52  $result = $this->getResult();
53 
54  $this->addTables( 'ipblocks' );
55  $this->addFields( [ 'ipb_auto', 'ipb_id', 'ipb_timestamp' ] );
56 
57  $this->addFieldsIf( [ 'ipb_address', 'ipb_user' ], $fld_user || $fld_userid );
58  if ( $fld_by || $fld_byid ) {
59  $actorQuery = ActorMigration::newMigration()->getJoin( 'ipb_by' );
60  $this->addTables( $actorQuery['tables'] );
61  $this->addFields( $actorQuery['fields'] );
62  $this->addJoinConds( $actorQuery['joins'] );
63  }
64  $this->addFieldsIf( 'ipb_expiry', $fld_expiry );
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  if ( $fld_reason ) {
71  $commentQuery = $commentStore->getJoin( 'ipb_reason' );
72  $this->addTables( $commentQuery['tables'] );
73  $this->addFields( $commentQuery['fields'] );
74  $this->addJoinConds( $commentQuery['joins'] );
75  }
76 
77  $this->addOption( 'LIMIT', $params['limit'] + 1 );
79  'ipb_timestamp',
80  $params['dir'],
81  $params['start'],
82  $params['end']
83  );
84  // Include in ORDER BY for uniqueness
85  $this->addWhereRange( 'ipb_id', $params['dir'], null, null );
86 
87  if ( !is_null( $params['continue'] ) ) {
88  $cont = explode( '|', $params['continue'] );
89  $this->dieContinueUsageIf( count( $cont ) != 2 );
90  $op = ( $params['dir'] == 'newer' ? '>' : '<' );
91  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
92  $continueId = (int)$cont[1];
93  $this->dieContinueUsageIf( $continueId != $cont[1] );
94  $this->addWhere( "ipb_timestamp $op $continueTimestamp OR " .
95  "(ipb_timestamp = $continueTimestamp AND " .
96  "ipb_id $op= $continueId)"
97  );
98  }
99 
100  if ( isset( $params['ids'] ) ) {
101  $this->addWhereFld( 'ipb_id', $params['ids'] );
102  }
103  if ( isset( $params['users'] ) ) {
104  $usernames = [];
105  foreach ( (array)$params['users'] as $u ) {
106  $usernames[] = $this->prepareUsername( $u );
107  }
108  $this->addWhereFld( 'ipb_address', $usernames );
109  $this->addWhereFld( 'ipb_auto', 0 );
110  }
111  if ( isset( $params['ip'] ) ) {
112  $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
113  if ( IP::isIPv4( $params['ip'] ) ) {
114  $type = 'IPv4';
115  $cidrLimit = $blockCIDRLimit['IPv4'];
116  $prefixLen = 0;
117  } elseif ( IP::isIPv6( $params['ip'] ) ) {
118  $type = 'IPv6';
119  $cidrLimit = $blockCIDRLimit['IPv6'];
120  $prefixLen = 3; // IP::toHex output is prefixed with "v6-"
121  } else {
122  $this->dieWithError( 'apierror-badip', 'param_ip' );
123  }
124 
125  # Check range validity, if it's a CIDR
126  list( $ip, $range ) = IP::parseCIDR( $params['ip'] );
127  if ( $ip !== false && $range !== false && $range < $cidrLimit ) {
128  $this->dieWithError( [ 'apierror-cidrtoobroad', $type, $cidrLimit ] );
129  }
130 
131  # Let IP::parseRange handle calculating $upper, instead of duplicating the logic here.
132  list( $lower, $upper ) = IP::parseRange( $params['ip'] );
133 
134  # Extract the common prefix to any rangeblock affecting this IP/CIDR
135  $prefix = substr( $lower, 0, $prefixLen + floor( $cidrLimit / 4 ) );
136 
137  # Fairly hard to make a malicious SQL statement out of hex characters,
138  # but it is good practice to add quotes
139  $lower = $db->addQuotes( $lower );
140  $upper = $db->addQuotes( $upper );
141 
142  $this->addWhere( [
143  'ipb_range_start' . $db->buildLike( $prefix, $db->anyString() ),
144  'ipb_range_start <= ' . $lower,
145  'ipb_range_end >= ' . $upper,
146  'ipb_auto' => 0
147  ] );
148  }
149 
150  if ( !is_null( $params['show'] ) ) {
151  $show = array_flip( $params['show'] );
152 
153  /* Check for conflicting parameters. */
154  if ( ( isset( $show['account'] ) && isset( $show['!account'] ) )
155  || ( isset( $show['ip'] ) && isset( $show['!ip'] ) )
156  || ( isset( $show['range'] ) && isset( $show['!range'] ) )
157  || ( isset( $show['temp'] ) && isset( $show['!temp'] ) )
158  ) {
159  $this->dieWithError( 'apierror-show' );
160  }
161 
162  $this->addWhereIf( 'ipb_user = 0', isset( $show['!account'] ) );
163  $this->addWhereIf( 'ipb_user != 0', isset( $show['account'] ) );
164  $this->addWhereIf( 'ipb_user != 0 OR ipb_range_end > ipb_range_start', isset( $show['!ip'] ) );
165  $this->addWhereIf( 'ipb_user = 0 AND ipb_range_end = ipb_range_start', isset( $show['ip'] ) );
166  $this->addWhereIf( 'ipb_expiry = ' .
167  $db->addQuotes( $db->getInfinity() ), isset( $show['!temp'] ) );
168  $this->addWhereIf( 'ipb_expiry != ' .
169  $db->addQuotes( $db->getInfinity() ), isset( $show['temp'] ) );
170  $this->addWhereIf( 'ipb_range_end = ipb_range_start', isset( $show['!range'] ) );
171  $this->addWhereIf( 'ipb_range_end > ipb_range_start', isset( $show['range'] ) );
172  }
173 
174  if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
175  $this->addWhereFld( 'ipb_deleted', 0 );
176  }
177 
178  # Filter out expired rows
179  $this->addWhere( 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() ) );
180 
181  $res = $this->select( __METHOD__ );
182 
183  $count = 0;
184  foreach ( $res as $row ) {
185  if ( ++$count > $params['limit'] ) {
186  // We've had enough
187  $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
188  break;
189  }
190  $block = [
191  ApiResult::META_TYPE => 'assoc',
192  ];
193  if ( $fld_id ) {
194  $block['id'] = (int)$row->ipb_id;
195  }
196  if ( $fld_user && !$row->ipb_auto ) {
197  $block['user'] = $row->ipb_address;
198  }
199  if ( $fld_userid && !$row->ipb_auto ) {
200  $block['userid'] = (int)$row->ipb_user;
201  }
202  if ( $fld_by ) {
203  $block['by'] = $row->ipb_by_text;
204  }
205  if ( $fld_byid ) {
206  $block['byid'] = (int)$row->ipb_by;
207  }
208  if ( $fld_timestamp ) {
209  $block['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
210  }
211  if ( $fld_expiry ) {
212  $block['expiry'] = ApiResult::formatExpiry( $row->ipb_expiry );
213  }
214  if ( $fld_reason ) {
215  $block['reason'] = $commentStore->getComment( 'ipb_reason', $row )->text;
216  }
217  if ( $fld_range && !$row->ipb_auto ) {
218  $block['rangestart'] = IP::formatHex( $row->ipb_range_start );
219  $block['rangeend'] = IP::formatHex( $row->ipb_range_end );
220  }
221  if ( $fld_flags ) {
222  // For clarity, these flags use the same names as their action=block counterparts
223  $block['automatic'] = (bool)$row->ipb_auto;
224  $block['anononly'] = (bool)$row->ipb_anon_only;
225  $block['nocreate'] = (bool)$row->ipb_create_account;
226  $block['autoblock'] = (bool)$row->ipb_enable_autoblock;
227  $block['noemail'] = (bool)$row->ipb_block_email;
228  $block['hidden'] = (bool)$row->ipb_deleted;
229  $block['allowusertalk'] = (bool)$row->ipb_allow_usertalk;
230  }
231  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $block );
232  if ( !$fit ) {
233  $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
234  break;
235  }
236  }
237  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'block' );
238  }
239 
240  protected function prepareUsername( $user ) {
241  if ( !$user ) {
242  $encParamName = $this->encodeParamName( 'users' );
243  $this->dieWithError( [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $user ) ],
244  "baduser_{$encParamName}"
245  );
246  }
247  $name = User::isIP( $user )
248  ? $user
249  : User::getCanonicalName( $user, 'valid' );
250  if ( $name === false ) {
251  $encParamName = $this->encodeParamName( 'users' );
252  $this->dieWithError( [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $user ) ],
253  "baduser_{$encParamName}"
254  );
255  }
256  return $name;
257  }
258 
259  public function getAllowedParams() {
260  $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
261 
262  return [
263  'start' => [
264  ApiBase::PARAM_TYPE => 'timestamp'
265  ],
266  'end' => [
267  ApiBase::PARAM_TYPE => 'timestamp',
268  ],
269  'dir' => [
271  'newer',
272  'older'
273  ],
274  ApiBase::PARAM_DFLT => 'older',
275  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
276  ],
277  'ids' => [
278  ApiBase::PARAM_TYPE => 'integer',
280  ],
281  'users' => [
282  ApiBase::PARAM_TYPE => 'user',
284  ],
285  'ip' => [
287  'apihelp-query+blocks-param-ip',
288  $blockCIDRLimit['IPv4'],
289  $blockCIDRLimit['IPv6'],
290  ],
291  ],
292  'limit' => [
293  ApiBase::PARAM_DFLT => 10,
294  ApiBase::PARAM_TYPE => 'limit',
295  ApiBase::PARAM_MIN => 1,
298  ],
299  'prop' => [
300  ApiBase::PARAM_DFLT => 'id|user|by|timestamp|expiry|reason|flags',
302  'id',
303  'user',
304  'userid',
305  'by',
306  'byid',
307  'timestamp',
308  'expiry',
309  'reason',
310  'range',
311  'flags'
312  ],
313  ApiBase::PARAM_ISMULTI => true,
315  ],
316  'show' => [
318  'account',
319  '!account',
320  'temp',
321  '!temp',
322  'ip',
323  '!ip',
324  'range',
325  '!range',
326  ],
328  ],
329  'continue' => [
330  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
331  ],
332  ];
333  }
334 
335  protected function getExamplesMessages() {
336  return [
337  'action=query&list=blocks'
338  => 'apihelp-query+blocks-example-simple',
339  'action=query&list=blocks&bkusers=Alice|Bob'
340  => 'apihelp-query+blocks-example-users',
341  ];
342  }
343 
344  public function getHelpUrls() {
345  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Blocks';
346  }
347 }
$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:247
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:192
ApiQuery
This is the main query class.
Definition: ApiQuery.php:36
array
the array() calling protocol came about after MediaWiki 1.4rc1.
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:1895
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:313
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
ApiQueryBlocks\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryBlocks.php:259
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
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:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
ApiQueryBlocks\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryBlocks.php:335
$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:88
$res
$res
Definition: database.txt:21
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:325
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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:1993
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:89
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:2006
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:206
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:37
ApiQueryBlocks\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryBlocks.php:344
ApiQueryBlocks
Query module to enumerate all user blocks.
Definition: ApiQueryBlocks.php:28
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:33
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:234
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
ApiQueryBlocks\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryBlocks.php:30
User\isIP
static isIP( $name)
Does the string match an anonymous IP address?
Definition: User.php:943
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:158
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:350
ApiQueryBlocks\prepareUsername
prepareUsername( $user)
Definition: ApiQueryBlocks.php:240
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:278
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2066
ApiBase\encodeParamName
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:730
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:513
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:181
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:260
ApiBase\requireMaxOneParameter
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:823
ApiQueryBlocks\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryBlocks.php:34
IP\isIPv4
static isIPv4( $ip)
Given a string, determine if it as valid IP in IPv4 only.
Definition: IP.php:99
IP\parseCIDR
static parseCIDR( $range)
Convert a network specification in CIDR notation to an integer network and a number of bits.
Definition: IP.php:470
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:236
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:1210
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
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:22
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:96
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:227
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:531
$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:1620
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:157
CommentStore\getStore
static getStore()
Definition: CommentStore.php:130
ApiQueryBase\addWhereIf
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
Definition: ApiQueryBase.php:245
$type
$type
Definition: testCompression.php:48
IP\formatHex
static formatHex( $hex)
Convert an IPv4 or IPv6 hexadecimal representation back to readable format.
Definition: IP.php:332