Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/classes/log/ -> sql_reader.php (source)

[Source view]

Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 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: 90 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

sql_reader:: (4 methods):
  get_events_select()
  get_events_select_count()
  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.

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

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

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

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.

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

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

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