logstore_standard\log\store Class Reference

Inheritance diagram for logstore_standard\log\store:

Public Member Functions
	__construct (\tool_log\log\manager $manager)
	dispose ()
	Notify store no more events are going to be written/read from it.
	get_description ()
	Longer description of the log data source.
	get_events_select ($selectwhere, array $params, $sort, $limitfrom, $limitnum)
	Fetch records using given criteria.
	get_events_select_count ($selectwhere, array $params)
	Get number of events present for the given select clause.
	get_events_select_exists (string $selectwhere, array $params)
	Get whether events are present for the given select clause.
	get_events_select_iterator ($selectwhere, array $params, $sort, $limitfrom, $limitnum)
	Fetch records using given criteria returning a Traversable object.
	get_internal_log_table_name ()
	Returns name of the table or database view that holds the log data in standardised format.
	get_log_event ($data)
	Returns an event from the log data.
	get_name ()
	Localised name of the reader.
	is_logging ()
	Are the new events appearing in the reader?
	write (\core\event\base $event)
	Write one event to the store.

Protected Member Functions
	insert_event_entries ($evententries)
	Finally store the events into the database.
	is_event_ignored (\core\event\base $event)
	Should the event be ignored (== not logged)?

Protected Attributes
string	$logguests
	$logguests true if logging guest access

Member Function Documentation

dispose()

tool_log\log\store::dispose ( )

inherited

Notify store no more events are going to be written/read from it.

Return values

void

Implemented in logstore_database\log\store.

get_description()

core\log\reader::get_description ( )

inherited

Longer description of the log data source.

Return values

string

get_events_select()

logstore_standard\log\store::get_events_select	(		$selectwhere,
		array	$params,
			$sort,
			$limitfrom,
			$limitnum )

Fetch records using given criteria.

Parameters

string	$selectwhere
array	$params
string	$sort
int	$limitfrom
int	$limitnum

Return values

core::event::base[]

Implements core\log\sql_reader.

get_events_select_count()

logstore_standard\log\store::get_events_select_count	(		$selectwhere,
		array	$params )

Get number of events present for the given select clause.

Parameters

string	$selectwhere	select conditions.
array	$params	params.

Return values

int	Number of events available for the given conditions

Implements core\log\sql_reader.

get_events_select_exists()

logstore_standard\log\store::get_events_select_exists	(	string	$selectwhere,
		array	$params )

Get whether events are present for the given select clause.

Parameters

string	$selectwhere	select conditions.
array	$params	params.

Return values

bool	Whether events available for the given conditions

Implements core\log\sql_reader.

get_events_select_iterator()

logstore_standard\log\store::get_events_select_iterator	(		$selectwhere,
		array	$params,
			$sort,
			$limitfrom,
			$limitnum )

Fetch records using given criteria returning a Traversable object.

Note that the traversable object contains a moodle_recordset, so remember that is important that you call close() once you finish using it.

Parameters

string	$selectwhere
array	$params
string	$sort
int	$limitfrom
int	$limitnum

Return values

core::dml::recordset_walk|core::event::base[]

Implements core\log\sql_reader.

get_internal_log_table_name()

logstore_standard\log\store::get_internal_log_table_name

(

)

Returns name of the table or database view that holds the log data in standardised format.

Note: this table must be used for reading only, it is strongly recommended to use this in complex reports only.

Return values

string

Implements core\log\sql_internal_table_reader.

get_log_event()

logstore_standard\log\store::get_log_event

(

$data

)

Returns an event from the log data.

Parameters

stdClass

$data

Log data

Return values

core\event\base

Implements core\log\sql_reader.

get_name()

core\log\reader::get_name ( )

inherited

Localised name of the reader.

To be used in selection for in reports.

Return values

string

insert_event_entries()

logstore_standard\log\store::insert_event_entries ( $evententries )

protected

Finally store the events into the database.

Parameters

array

$evententries

raw event data

is_event_ignored()

logstore_standard\log\store::is_event_ignored ( \core\event\base $event )

protected

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

Parameters

core\event\base

$event

Return values

bool

is_logging()

logstore_standard\log\store::is_logging

(

)

Are the new events appearing in the reader?

Return values

bool	true means new log events are being added, false means no new data will be added

Implements core\log\reader.

write()

tool_log\log\writer::write ( \core\event\base $event )

inherited

Write one event to the store.

Parameters

core\event\base

$event

Return values

void

---

The documentation for this class was generated from the following file:

• admin/tool/log/store/standard/classes/log/store.php