Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/search/classes/ -> skip_future_documents_iterator.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

Iterator for skipping search recordset documents that are in the future.

Copyright: 2017 The Open University
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 108 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

skip_future_documents_iterator:: (6 methods):
  __construct()
  current()
  next()
  key()
  valid()
  rewind()


Class: skip_future_documents_iterator  - X-Ref

Iterator for skipping search recordset documents that are in the future.

This iterator stops iterating if it receives a document that was modified later than the
specified cut-off time (usually current time).

This iterator assumes that its parent iterator returns documents in modified order (which is
required to be the case for search indexing). This means we will stop retrieving data from the
recordset

__construct(\Iterator $parent, $cutoff = 0)   X-Ref
Constructor.

param: \Iterator $parent Parent iterator, must return search documents in modified order
param: int $cutoff Cut-off time, default is current time

current()   X-Ref
No description

next()   X-Ref
No description

key()   X-Ref
No description

valid()   X-Ref
No description

rewind()   X-Ref
No description