Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
output_text_logger Class Reference

Logger implementation that sends text messages to output. More...

Inheritance diagram for output_text_logger:
base_logger checksumable

Public Member Functions

 calculate_checksum ()
 This function will return one unique and stable checksum for one instance of the class implementing it. More...
 
 close ()
 Close any resource the logger may have open. More...
 
 destroy ()
 Destroy (nullify) the chain of loggers references, also closing resources when needed. More...
 
 get_level ()
 
 get_next ()
 
 is_checksum_correct ($checksum)
 Given one checksum, returns if matches object's checksum (true) or no (false) More...
 
 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

 $level
 
 $next
 
 $showdate
 
 $showlevel
 

Detailed Description

Logger implementation that sends text messages to output.

TODO: Finish phpdocs

Member Function Documentation

◆ action()

output_text_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()

base_logger::close ( )
inherited

Close any resource the logger may have open.

Since
Moodle 3.1

Reimplemented in file_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: