Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Class: store_test  - X-Ref

Standard log store tests.

test_log_writing(bool $jsonformat)   X-Ref
Tests log writing.

param: bool $jsonformat True to test with JSON format

log_writing_provider()   X-Ref
Returns different JSON format settings so the test can be run with JSON format either on or
off.

return: bool[] Array of true/false

test_get_supported_reports()   X-Ref
Test logmanager::get_supported_reports returns all reports that require this store.


test_gc_enabled_as_expected()   X-Ref
Verify that gc disabling works


test_events_traversable()   X-Ref
Test sql_reader::get_events_select_iterator.

return: void

test_cleanup_task()   X-Ref
Test that the standard log cleanup works correctly.


test_decode_other($value)   X-Ref
Tests the decode_other function can cope with both JSON and PHP serialized format.

param: mixed $value Value to encode and decode

test_decode_other_with_wrongly_encoded_contents()   X-Ref
No description

decode_other_provider()   X-Ref
List of possible values for 'other' field.

I took these types from our logs based on the different first character of PHP serialized
data - my query found only these types. The normal case is an array.

return: array Array of parameters

test_backup_restore(bool $jsonformat)   X-Ref
Checks that backup and restore of log data works correctly.

param: bool $jsonformat True to test with JSON format

backup($course)   X-Ref
Backs a course up to temp directory.

param: \stdClass $course Course object to backup
return: string ID of backup

restore(string $backupid, $course, string $suffix)   X-Ref
Restores a course from temp directory.

param: string $backupid Backup id
param: \stdClass $course Original course object
param: string $suffix Suffix to add after original course shortname and fullname
return: int New course id

disable_gc()   X-Ref
Disable the garbage collector if it's enabled to ensure we don't adjust memory statistics.


tearDown()   X-Ref
Reset any garbage collector changes to the previous state at the end of the test.