file_logger Class Reference

Logger implementation that sends indented messages (depth option) to one file. More...

Inheritance diagram for file_logger:

Public Member Functions
	__construct ($level, $showdate=false, $showlevel=false, $fullpath=null)
	__sleep ()
	__wakeup ()
	calculate_checksum ()
	This function will return one unique and stable checksum for one instance of the class implementing it.
	close ()
	Close the logger resources (file handle) if still open.
	destroy ()
	Destroy (nullify) the chain of loggers references, also closing resources when needed.
	get_level ()
	get_next ()
	is_checksum_correct ($checksum)
	Given one checksum, returns if matches object's checksum (true) or no (false)
	process ($message, $level, $options=null)
	set_next ($next)

Protected Member Functions
	action ($message, $level, $options=null)
	get_datestr ()
	get_levelstr ($level)
	get_nexts ()
	get_prefix ($level, $options)
	is_circular_reference ($obj)

Protected Attributes
	$fhandle
	$fullpath
	$level
	$next
	$showdate
	$showlevel

Detailed Description

Logger implementation that sends indented messages (depth option) to one file.

TODO: Finish phpdocs

Member Function Documentation

action()

file_logger::action ( $message, $level, $options = null )

protected

Reimplemented from base_logger.

calculate_checksum()

base_logger::calculate_checksum ( )

inherited

This function will return one unique and stable checksum for one instance of the class implementing it.

It's each implementation responsibility to do it recursively if needed and use optional store (caching) of the checksum if necessary/possible

Implements checksumable.

close()

file_logger::close

(

)

Close the logger resources (file handle) if still open.

Since

Moodle 3.1

Reimplemented from base_logger.

destroy()

base_logger::destroy ( )

finalinherited

Destroy (nullify) the chain of loggers references, also closing resources when needed.

Since

Moodle 3.1

is_checksum_correct()

base_logger::is_checksum_correct ( $checksum )

inherited

Given one checksum, returns if matches object's checksum (true) or no (false)

Implements checksumable.

---

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

• backup/util/loggers/file_logger.class.php