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.
/admin/tool/log/classes/helper/ -> reader.php (source)

[Source view]

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

Reader helper trait.

Copyright: 2014 onwards Ankit Agarwal
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 105 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 4 functions

  get_name()
  get_description()
  decode_other()
  tweak_sort_by_id()

Functions
Functions that are not part of a class:

get_name()   X-Ref
Default get name api.

return: string name of the store.

get_description()   X-Ref
Default get description method.

return: string description of the store.

decode_other(?string $other)   X-Ref
Function decodes the other field into an array using either PHP serialisation or JSON.

Note that this does not rely on the config setting, it supports both formats, so you can
use it for data before/after making a change to the config setting.

The return value is usually an array but it can also be null or a boolean or something.

return: mixed Decoded value
param: string $other Other value

tweak_sort_by_id($sort)   X-Ref
Adds ID column to $sort to make sure events from one request
within 1 second are returned in the same order.

return: string sort string
param: string $sort