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.
/lib/classes/log/ -> sql_reader.php (source)

[Source view]

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

Log iterator reader interface.

Copyright: 2015 David Monllao
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 100 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

sql_reader:: (5 methods):
  get_events_select()
  get_events_select_count()
  get_events_select_exists()
  get_events_select_iterator()
  get_log_event()


Interface: sql_reader  - X-Ref

Log iterator reader interface.

Replaces sql_select_reader adding functions
to return iterators.

get_events_select($selectwhere, array $params, $sort, $limitfrom, $limitnum)   X-Ref
Fetch records using given criteria.

param: string $selectwhere
param: array $params
param: string $sort
param: int $limitfrom
param: int $limitnum
return: \core\event\base[]

get_events_select_count($selectwhere, array $params)   X-Ref
Return number of events matching given criteria.

param: string $selectwhere
param: array $params
return: int

get_events_select_exists(string $selectwhere, array $params)   X-Ref
Get whether events are present for the given select clause.

param: string $selectwhere select conditions.
param: array $params params.
return: bool Whether events available for the given conditions

get_events_select_iterator($selectwhere, array $params, $sort, $limitfrom, $limitnum)   X-Ref
Fetch records using the given criteria returning an traversable list of events.

Note that the returned object is Traversable, not Iterator, as we are returning
EmptyIterator if we know there are no events, and EmptyIterator does not implement
Countable {@link https://bugs.php.net/bug.php?id=60577} so valid() should be checked
in any case instead of a count().

Also note that the traversable object contains a recordset and it is very important
that you close it after using it.

param: string $selectwhere
param: array $params
param: string $sort
param: int $limitfrom
param: int $limitnum
return: \Traversable|\core\event\base[] Returns an iterator containing \core\event\base objects.

get_log_event($data)   X-Ref
Returns an event from the log data.

param: stdClass $data Log data
return: \core\event\base