r42794 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r42793‎ | r42794 | r42795 >
Date:00:39, 30 October 2008
Author:demon
Status:old
Tags:
Comment:
Add some docs on these class constants
Modified paths:
  • /trunk/phase3/includes/api/ApiBase.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiBase.php
@@ -40,12 +40,12 @@
4141
4242 // These constants allow modules to specify exactly how to treat incomming parameters.
4343
44 - const PARAM_DFLT = 0;
45 - const PARAM_ISMULTI = 1;
46 - const PARAM_TYPE = 2;
47 - const PARAM_MAX = 3;
48 - const PARAM_MAX2 = 4;
49 - const PARAM_MIN = 5;
 44+ const PARAM_DFLT = 0; // Default value of the parameter
 45+ const PARAM_ISMULTI = 1; // Boolean, do we accept more than one item for this parameters (ie: titles)
 46+ const PARAM_TYPE = 2; // Can be either a string type (ie: 'integer') or an array of allowed values
 47+ const PARAM_MAX = 3; // Max value allowed for a parameter
 48+ const PARAM_MAX2 = 4; // Max value allowed for a parameter (similar to the upper limits below)
 49+ const PARAM_MIN = 5; // Lowest value allowed for a parameter
5050 const PARAM_ALLOW_DUPLICATES = 6;
5151
5252 const LIMIT_BIG1 = 500; // Fast query, std user limit

Follow-up revisions

RevisionCommit summaryAuthorDate
r42813API: Tweak r42794 (add docs for ApiBase class constants) a littlecatrope14:51, 30 October 2008

Status & tagging log