Moodle  2.2.1
http://www.collinsharper.com
base_logger Class Reference
Inheritance diagram for base_logger:
Collaboration diagram for base_logger:

Public Member Functions

 __construct ($level, $showdate=false, $showlevel=false)
 set_next ($next)
 get_next ()
 get_level ()
 calculate_checksum ()
 is_checksum_correct ($checksum)
 process ($message, $level, $options=null)

Protected Member Functions

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

Protected Attributes

 $level
 $showdate
 $showlevel
 $next

Detailed Description

Base abstract class for all the loggers to be used in backup/restore

Any message passed will be processed by all the loggers in the defined chain (note some implementations may be not strictly "loggers" but classes performing other sort of tasks (avoiding browser/php timeouts, painters...). One simple 1-way basic chain of commands/responsibility pattern.

TODO: Finish phpdocs

Definition at line 35 of file base_logger.class.php.


Constructor & Destructor Documentation

__construct ( level,
showdate = false,
showlevel = false 
)

Definition at line 42 of file base_logger.class.php.


Member Function Documentation

action ( message,
level,
options = null 
) [abstract, protected]

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.

Definition at line 76 of file base_logger.class.php.

Here is the caller graph for this function:

get_datestr ( ) [protected]

Definition at line 123 of file base_logger.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_level ( )

Definition at line 70 of file base_logger.class.php.

get_levelstr ( level) [protected]

Reimplemented in mock_base_logger1.

Definition at line 127 of file base_logger.class.php.

Here is the caller graph for this function:

get_next ( )

Definition at line 66 of file base_logger.class.php.

get_nexts ( ) [protected]

Definition at line 114 of file base_logger.class.php.

get_prefix ( level,
options 
) [protected]

Definition at line 146 of file base_logger.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

is_checksum_correct ( checksum)

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

Implements checksumable.

Definition at line 83 of file base_logger.class.php.

Here is the call graph for this function:

is_circular_reference ( obj) [protected]

Definition at line 105 of file base_logger.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

process ( message,
level,
options = null 
) [final]

Definition at line 91 of file base_logger.class.php.

Here is the call graph for this function:

set_next ( next) [final]

Definition at line 50 of file base_logger.class.php.

Here is the call graph for this function:


Field Documentation

$level [protected]

Definition at line 37 of file base_logger.class.php.

$next [protected]

Definition at line 40 of file base_logger.class.php.

$showdate [protected]

Definition at line 38 of file base_logger.class.php.

$showlevel [protected]

Definition at line 39 of file base_logger.class.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations