MediaWiki  master
ApiQueryBase.php
Go to the documentation of this file.
1 <?php
25 
33 abstract class ApiQueryBase extends ApiBase {
34 
36 
42  public function __construct( ApiQuery $queryModule, $moduleName, $paramPrefix = '' ) {
43  parent::__construct( $queryModule->getMain(), $moduleName, $paramPrefix );
44  $this->mQueryModule = $queryModule;
45  $this->mDb = null;
46  $this->resetQueryParams();
47  }
48 
49  /************************************************************************/
65  public function getCacheMode( $params ) {
66  return 'private';
67  }
68 
78  public function requestExtraData( $pageSet ) {
79  }
80 
83  /************************************************************************/
92  public function getQuery() {
93  return $this->mQueryModule;
94  }
95 
97  public function getParent() {
98  return $this->getQuery();
99  }
100 
105  protected function getDB() {
106  if ( is_null( $this->mDb ) ) {
107  $this->mDb = $this->getQuery()->getDB();
108  }
109 
110  return $this->mDb;
111  }
112 
121  public function selectNamedDB( $name, $db, $groups ) {
122  $this->mDb = $this->getQuery()->getNamedDB( $name, $db, $groups );
123  return $this->mDb;
124  }
125 
130  protected function getPageSet() {
131  return $this->getQuery()->getPageSet();
132  }
133 
136  /************************************************************************/
144  protected function resetQueryParams() {
145  $this->tables = [];
146  $this->where = [];
147  $this->fields = [];
148  $this->options = [];
149  $this->join_conds = [];
150  }
151 
158  protected function addTables( $tables, $alias = null ) {
159  if ( is_array( $tables ) ) {
160  if ( $alias !== null ) {
161  ApiBase::dieDebug( __METHOD__, 'Multiple table aliases not supported' );
162  }
163  $this->tables = array_merge( $this->tables, $tables );
164  } elseif ( $alias !== null ) {
165  $this->tables[$alias] = $tables;
166  } else {
167  $this->tables[] = $tables;
168  }
169  }
170 
179  protected function addJoinConds( $join_conds ) {
180  if ( !is_array( $join_conds ) ) {
181  ApiBase::dieDebug( __METHOD__, 'Join conditions have to be arrays' );
182  }
183  $this->join_conds = array_merge( $this->join_conds, $join_conds );
184  }
185 
190  protected function addFields( $value ) {
191  if ( is_array( $value ) ) {
192  $this->fields = array_merge( $this->fields, $value );
193  } else {
194  $this->fields[] = $value;
195  }
196  }
197 
204  protected function addFieldsIf( $value, $condition ) {
205  if ( $condition ) {
206  $this->addFields( $value );
207 
208  return true;
209  }
210 
211  return false;
212  }
213 
225  protected function addWhere( $value ) {
226  if ( is_array( $value ) ) {
227  // Sanity check: don't insert empty arrays,
228  // Database::makeList() chokes on them
229  if ( count( $value ) ) {
230  $this->where = array_merge( $this->where, $value );
231  }
232  } else {
233  $this->where[] = $value;
234  }
235  }
236 
243  protected function addWhereIf( $value, $condition ) {
244  if ( $condition ) {
245  $this->addWhere( $value );
246 
247  return true;
248  }
249 
250  return false;
251  }
252 
258  protected function addWhereFld( $field, $value ) {
259  if ( $value !== null && !( is_array( $value ) && !$value ) ) {
260  $this->where[$field] = $value;
261  }
262  }
263 
272  protected function addWhereIDsFld( $table, $field, $ids ) {
273  // Use count() to its full documented capabilities to simultaneously
274  // test for null, empty array or empty countable object
275  if ( count( $ids ) ) {
276  $ids = $this->filterIDs( [ [ $table, $field ] ], $ids );
277 
278  if ( $ids === [] ) {
279  // Return nothing, no IDs are valid
280  $this->where[] = '0 = 1';
281  } else {
282  $this->where[$field] = $ids;
283  }
284  }
285  return count( $ids );
286  }
287 
300  protected function addWhereRange( $field, $dir, $start, $end, $sort = true ) {
301  $isDirNewer = ( $dir === 'newer' );
302  $after = ( $isDirNewer ? '>=' : '<=' );
303  $before = ( $isDirNewer ? '<=' : '>=' );
304  $db = $this->getDB();
305 
306  if ( !is_null( $start ) ) {
307  $this->addWhere( $field . $after . $db->addQuotes( $start ) );
308  }
309 
310  if ( !is_null( $end ) ) {
311  $this->addWhere( $field . $before . $db->addQuotes( $end ) );
312  }
313 
314  if ( $sort ) {
315  $order = $field . ( $isDirNewer ? '' : ' DESC' );
316  // Append ORDER BY
317  $optionOrderBy = isset( $this->options['ORDER BY'] )
318  ? (array)$this->options['ORDER BY']
319  : [];
320  $optionOrderBy[] = $order;
321  $this->addOption( 'ORDER BY', $optionOrderBy );
322  }
323  }
324 
335  protected function addTimestampWhereRange( $field, $dir, $start, $end, $sort = true ) {
336  $db = $this->getDB();
337  $this->addWhereRange( $field, $dir,
338  $db->timestampOrNull( $start ), $db->timestampOrNull( $end ), $sort );
339  }
340 
347  protected function addOption( $name, $value = null ) {
348  if ( is_null( $value ) ) {
349  $this->options[] = $name;
350  } else {
351  $this->options[$name] = $value;
352  }
353  }
354 
372  protected function select( $method, $extraQuery = [], array &$hookData = null ) {
373  $tables = array_merge(
374  $this->tables,
375  isset( $extraQuery['tables'] ) ? (array)$extraQuery['tables'] : []
376  );
377  $fields = array_merge(
378  $this->fields,
379  isset( $extraQuery['fields'] ) ? (array)$extraQuery['fields'] : []
380  );
381  $where = array_merge(
382  $this->where,
383  isset( $extraQuery['where'] ) ? (array)$extraQuery['where'] : []
384  );
385  $options = array_merge(
386  $this->options,
387  isset( $extraQuery['options'] ) ? (array)$extraQuery['options'] : []
388  );
389  $join_conds = array_merge(
390  $this->join_conds,
391  isset( $extraQuery['join_conds'] ) ? (array)$extraQuery['join_conds'] : []
392  );
393 
394  if ( $hookData !== null ) {
395  Hooks::run( 'ApiQueryBaseBeforeQuery',
396  [ $this, &$tables, &$fields, &$where, &$options, &$join_conds, &$hookData ]
397  );
398  }
399 
400  $res = $this->getDB()->select( $tables, $fields, $where, $method, $options, $join_conds );
401 
402  if ( $hookData !== null ) {
403  Hooks::run( 'ApiQueryBaseAfterQuery', [ $this, $res, &$hookData ] );
404  }
405 
406  return $res;
407  }
408 
422  protected function processRow( $row, array &$data, array &$hookData ) {
423  return Hooks::run( 'ApiQueryBaseProcessRow', [ $this, $row, &$data, &$hookData ] );
424  }
425 
432  public function prepareUrlQuerySearchString( $query = null, $protocol = null ) {
433  wfDeprecated( __METHOD__, '1.33' );
434  $db = $this->getDB();
435  if ( $query !== null && $query !== '' ) {
436  if ( is_null( $protocol ) ) {
437  $protocol = 'http://';
438  }
439 
440  $likeQuery = LinkFilter::makeLikeArray( $query, $protocol );
441  if ( !$likeQuery ) {
442  $this->dieWithError( 'apierror-badquery' );
443  }
444 
445  $likeQuery = LinkFilter::keepOneWildcard( $likeQuery );
446 
447  return 'el_index ' . $db->buildLike( $likeQuery );
448  } elseif ( !is_null( $protocol ) ) {
449  return 'el_index ' . $db->buildLike( "$protocol", $db->anyString() );
450  }
451 
452  return null;
453  }
454 
462  public function showHiddenUsersAddBlockInfo( $showBlockInfo ) {
463  $db = $this->getDB();
464 
465  $tables = [ 'ipblocks' ];
466  $fields = [ 'ipb_deleted' ];
467  $joinConds = [
468  'blk' => [ 'LEFT JOIN', [
469  'ipb_user=user_id',
470  'ipb_expiry > ' . $db->addQuotes( $db->timestamp() ),
471  ] ],
472  ];
473 
474  if ( $showBlockInfo ) {
475  $actorQuery = ActorMigration::newMigration()->getJoin( 'ipb_by' );
476  $commentQuery = CommentStore::getStore()->getJoin( 'ipb_reason' );
477  $tables += $actorQuery['tables'] + $commentQuery['tables'];
478  $joinConds += $actorQuery['joins'] + $commentQuery['joins'];
479  $fields = array_merge( $fields, [
480  'ipb_id',
481  'ipb_expiry',
482  'ipb_timestamp'
483  ], $actorQuery['fields'], $commentQuery['fields'] );
484  }
485 
486  $this->addTables( [ 'blk' => $tables ] );
487  $this->addFields( $fields );
488  $this->addJoinConds( $joinConds );
489 
490  // Don't show hidden names
491  if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
492  $this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' );
493  }
494  }
495 
498  /************************************************************************/
510  public static function addTitleInfo( &$arr, $title, $prefix = '' ) {
511  $arr[$prefix . 'ns'] = (int)$title->getNamespace();
512  $arr[$prefix . 'title'] = $title->getPrefixedText();
513  }
514 
521  protected function addPageSubItems( $pageId, $data ) {
522  $result = $this->getResult();
524 
525  return $result->addValue( [ 'query', 'pages', (int)$pageId ],
526  $this->getModuleName(),
527  $data );
528  }
529 
538  protected function addPageSubItem( $pageId, $item, $elemname = null ) {
539  if ( is_null( $elemname ) ) {
540  $elemname = $this->getModulePrefix();
541  }
542  $result = $this->getResult();
543  $fit = $result->addValue( [ 'query', 'pages', $pageId,
544  $this->getModuleName() ], null, $item );
545  if ( !$fit ) {
546  return false;
547  }
548  $result->addIndexedTagName( [ 'query', 'pages', $pageId,
549  $this->getModuleName() ], $elemname );
550 
551  return true;
552  }
553 
559  protected function setContinueEnumParameter( $paramName, $paramValue ) {
560  $this->getContinuationManager()->addContinueParam( $this, $paramName, $paramValue );
561  }
562 
573  public function titlePartToKey( $titlePart, $namespace = NS_MAIN ) {
574  $t = Title::makeTitleSafe( $namespace, $titlePart . 'x' );
575  if ( !$t || $t->hasFragment() ) {
576  // Invalid title (e.g. bad chars) or contained a '#'.
577  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
578  }
579  if ( $namespace != $t->getNamespace() || $t->isExternal() ) {
580  // This can happen in two cases. First, if you call titlePartToKey with a title part
581  // that looks like a namespace, but with $defaultNamespace = NS_MAIN. It would be very
582  // difficult to handle such a case. Such cases cannot exist and are therefore treated
583  // as invalid user input. The second case is when somebody specifies a title interwiki
584  // prefix.
585  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
586  }
587 
588  return substr( $t->getDBkey(), 0, -1 );
589  }
590 
599  public function prefixedTitlePartToKey( $titlePart, $defaultNamespace = NS_MAIN ) {
600  $t = Title::newFromText( $titlePart . 'x', $defaultNamespace );
601  if ( !$t || $t->hasFragment() || $t->isExternal() ) {
602  // Invalid title (e.g. bad chars) or contained a '#'.
603  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
604  }
605 
606  return [ $t->getNamespace(), substr( $t->getDBkey(), 0, -1 ) ];
607  }
608 
613  public function validateSha1Hash( $hash ) {
614  return (bool)preg_match( '/^[a-f0-9]{40}$/', $hash );
615  }
616 
621  public function validateSha1Base36Hash( $hash ) {
622  return (bool)preg_match( '/^[a-z0-9]{31}$/', $hash );
623  }
624 
630  public function userCanSeeRevDel() {
631  return $this->getUser()->isAllowedAny(
632  'deletedhistory',
633  'deletedtext',
634  'suppressrevision',
635  'viewsuppressed'
636  );
637  }
638 
640 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
getDB()
Get the Query database connection (read-only)
static makeLikeArray( $filterEntry, $protocol='http://')
Make an array to be used for calls to Database::buildLike(), which will match the specified string...
Definition: LinkFilter.php:312
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
null for the local 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:1585
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
getResult()
Get the result object.
Definition: ApiBase.php:633
const NS_MAIN
Definition: Defines.php:64
showHiddenUsersAddBlockInfo( $showBlockInfo)
Filters hidden users (where the user doesn&#39;t have the right to view them) Also adds relevant block in...
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
prefixedTitlePartToKey( $titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a namespace constant and dbkey.
validateSha1Base36Hash( $hash)
getMain()
Get the main module.
Definition: ApiBase.php:529
In both all secondary updates will be triggered handle like object that caches derived data representing a and can trigger updates of cached copies of that e g in the links tables
Definition: pageupdater.txt:78
This is a base class for all Query modules.
$sort
$value
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1991
getPageSet()
Get the PageSet object to work on.
requestExtraData( $pageSet)
Override this method to request extra fields from the pageSet using $pageSet->requestField(&#39;fieldName...
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
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 '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. '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 '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 since 1.28! 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:1980
prepareUrlQuerySearchString( $query=null, $protocol=null)
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
static newMigration()
Static constructor.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
$res
Definition: database.txt:21
getContinuationManager()
Get the continuation manager.
Definition: ApiBase.php:673
addPageSubItems( $pageId, $data)
Add a sub-element under the page element with the given page ID.
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:513
addFields( $value)
Add a set of fields to select to the internal array.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
This is the main query class.
Definition: ApiQuery.php:36
static keepOneWildcard( $arr)
Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder...
Definition: LinkFilter.php:385
selectNamedDB( $name, $db, $groups)
Selects the query database connection with the given name.
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:617
getQuery()
Get the main Query module.
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
__construct(ApiQuery $queryModule, $moduleName, $paramPrefix='')
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
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
static getStore()
filterIDs( $fields, array $ids)
Filter out-of-range values from a list of positive integer IDs.
Definition: ApiBase.php:1862
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:521
addWhere( $value)
Add a set of WHERE clauses to the internal array.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2218
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:38
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
validateSha1Hash( $hash)
addWhereIDsFld( $table, $field, $ids)
Like addWhereFld for an integer list of IDs.
resetQueryParams()
Blank the internal arrays with query parameters.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319
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...
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.