tool_log

Files
file	backup_tool_log_logstore_subplugin.class.php
	Backup support for tool_log logstore subplugins.
file	buffered_writer.php
	Helper trait buffered_writer.
file	events.php
	Event observer.
file	helper.php
	Privacy helper.
file	install.php
	Logging support.
file	logstore.php
	Subplugin info class.
file	logstore_provider.php
	Logstore provider interface.
file	logstore_userlist_provider.php
	Logstore userlist provider interface.
file	manager.php
	Log store manager.
file	moodle_database_export_and_delete.php
	Moodle database: export and delete.
file	observer.php
	Event observer.
file	provider.php
	Data provider.
file	reader.php
	Reader helper trait.
file	restore_tool_log_logstore_subplugin.class.php
	Restore support for tool_log logstore subplugins.
file	setting_managestores.php
	Store management setting.
file	settings.php
	Logging settings.
file	store.php
	Helper trait store.
file	store.php
	Log store interface.
file	upgrade.php
	Logging support.
file	version.php
	Default log manager.
file	writer.php
	Log store writer interface.

Namespaces
namespace	tool_log\helper
namespace	tool_log\local\privacy
namespace	tool_log\log
namespace	tool_log\plugininfo
namespace	tool_log\privacy

Classes
class	backup_tool_log_logstore_subplugin
	Parent class of all the logstore subplugin implementations. More...
class	restore_tool_log_logstore_subplugin
	Parent class of all the logstore subplugin implementations. More...
class	tool_log\local\privacy\helper
	Privacy helper class. More...
interface	tool_log\local\privacy\logstore_provider
	Logstore provider interface. More...
interface	tool_log\local\privacy\logstore_userlist_provider
	Logstore userlist provider interface. More...
class	tool_log\log\manager
class	tool_log\log\observer
interface	tool_log\log\store
interface	tool_log\log\writer
class	tool_log\plugininfo\logstore
	Plugin info class for logging store plugins. More...
class	tool_log\privacy\provider
	Data provider class. More...
class	tool_log_setting_managestores

Functions
	tool_log\helper::dispose ()
	Push any remaining events to the database. More...
	tool_log\helper::flush ()
	Flush event buffer.
	tool_log\helper::get_config ($name, $default=null)
	Get a config value for the store. More...
	tool_log\helper::helper_setup (\tool_log\log\manager $manager)
	Setup store specific variables. More...
	tool_log\helper::insert_event_entries ($evententries)
	Bulk write a given array of events to the backend. More...
	tool_log\helper::is_event_ignored (\core\event\base $event)
	Should the event be ignored (== not logged)? More...
	tool_log\helper::write (\core\event\base $event)
	Write event in the store with buffering. More...
	xmldb_tool_log_install ()
	Install the plugin.
	xmldb_tool_log_upgrade ($oldversion)
	Upgrade the plugin. More...

Variables
array	tool_log\helper::$buffersize
	$buffer buffer size of events.
string	tool_log\helper::$component
	$component Frankenstyle store name.
int	tool_log\helper::$count = 0
	$count Counter.
bool	tool_log\helper::$jsonformat = false
	If true, writes JSON instead of PHP serialized data for 'other' field.
	$observers
	$plugin = 2020060900
string	tool_log\helper::$store
	$store name of the store.
trait	tool_log\helper::buffered_writer
	Helper trait buffered_writer. More...
$plugin	component = 'tool_log'
trait	tool_log\helper::store
	Helper trait store. More...
$plugin	version = 2020061500

Detailed Description

Function Documentation

dispose()

tool_log\helper\dispose

(

)

Push any remaining events to the database.

Insert_events() must be defined. override in stores if the store doesn't support buffering.

get_config()

tool_log::helper::get_config (   $name,   $default = null  )

abstractprotected

Get a config value for the store.

Api to get plugin config.

Parameters

string	$name	Config name
mixed	$default	default value

Return values

mixed

config value if set, else the default value.

Parameters

string	$name	name of the config.
null | mixed	$default	default value to return.

Return values

mixed|null

return config value.

helper_setup()

tool_log\helper\helper_setup ( \tool_log\log\manager  $manager )

protected

Setup store specific variables.

Parameters

tool_log::log::manager

$manager

manager instance.

insert_event_entries()

tool_log\helper\insert_event_entries (   $evententries )

abstractprotected

Bulk write a given array of events to the backend.

Stores must implement this.

Parameters

array

$evententries

raw event data

is_event_ignored()

tool_log\helper\is_event_ignored ( \core\event\base  $event )

abstractprotected

Should the event be ignored (== not logged)?

Parameters

core::event::base

$event

Return values

bool

write()

tool_log\helper\write

(

\core\event\base

$event

)

Write event in the store with buffering.

Method insert_event_entries() must be defined.

Parameters

core::event::base

$event

Return values

void

xmldb_tool_log_upgrade()

xmldb_tool_log_upgrade

(

$oldversion

)

Upgrade the plugin.

Parameters

int

$oldversion

Return values

bool	always true

Variable Documentation

$observers

$observers

Initial value:

= array(
    array(
        'eventname' => '*',
        'callback'  => '\tool_log\log\observer::store',
        'internal'  => false, 
        'priority'  => 1000,
    ),
)

buffered_writer

trait tool_log::helper\buffered_writer

Initial value:

{
 
    
    protected array $buffer = array()

Helper trait buffered_writer.

Adds buffer support for the store.

Copyright

2014 onwards Ankit Agarwal

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

store

trait tool_log::helper\store

Initial value:

{
 
    
    protected tool_log\log\manager $manager

Helper trait store.

Adds some helper methods for stores.

Copyright

2014 onwards Ankit Agarwal

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later