Krai Framework Homepage - Framework API - Krai/Log/Krai_Log

Child Class	Description
Krai_Log_Logger_Local	Local file logger
Krai_Log_Logger_Console	Console (Web page) logger
Krai_Log_Logger_Syslog	Logs to the system log
Krai_Log_Logger_Email	Logs to email

[ Top ]

Property Summary

boolean	$instance_is_open	Whether or not the instance is open for logging
mixed	$messages	Messages
boolean	$needs_reset	Whether or not to reset stuff
mixed	$parent_logger_instance	Instance of parent logger
mixed	$queue_mode	Queue mode
mixed	$thresh	Threshold
mixed	$type	Log type

[ Top ]

Method Summary

Krai_Log_Logger	__construct()	Constructor
boolean	Close()	Close the logging instance
void	DisableQueueMode()	Turn off queuing
void	EnableQueueMode()	Turn on queuing
void	Entry()	Log a message
boolean	FlushMsg()	Flush a message from the log queue
void	FlushQueue()	Flush the log queue
string	GetType()	Get the type of the instance
boolean	Open()	Open the log instance
void	QueueMsg()	Add a message to the queue
void	Reset()	Reset things
void	SetErrorConditionThresh()	Set If error condition thresh, then what to log
void	SetErrorConditionTriggerThresh()	Set error condition threshold
void	SetMaxQueueSize()	Set the queue size
void	SetThresh()	Set threshold for what to log
void	WriteLog()	Write a message to the syslog

[ Top ]

Properties

boolean $instance_is_open [line 51]

Whether or not the instance is open for logging

API Tags:

Access:

protected

[ Top ]

mixed $messages [line 33]

Messages

API Tags:

Access:

protected

[ Top ]

boolean $needs_reset [line 39]

Whether or not to reset stuff

API Tags:

Access:

protected

[ Top ]

mixed $parent_logger_instance [line 45]

Instance of parent logger

API Tags:

Access:

protected

[ Top ]

mixed $queue_mode [line 57]

Queue mode

API Tags:

Access:

protected

[ Top ]

mixed $thresh [line 69]

Threshold

API Tags:

Access:

protected

[ Top ]

mixed $type [line 63]

Log type

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 77]

Krai_Log_Logger __construct(

&$parent_logger_instance, string
$parent_application, mixed
$parent_logger_instance 
)

Constructor

Parameters:

mixed	$parent_logger_instance:
string	$parent_application:
	&$parent_logger_instance:

API Tags:

Access:

public

Redefined in descendants as:

Krai_Log_Logger_Local::__construct() : Constructor
Krai_Log_Logger_Console::__construct() : Constructor - give the instance references to its parent etc
Krai_Log_Logger_Syslog::__construct() : Constructor
Krai_Log_Logger_Email::__construct() : Constructor

[ Top ]

Close [line 296]

boolean Close(
)

Close the logging instance

API Tags:

Access:

public

[ Top ]

DisableQueueMode [line 182]

void DisableQueueMode(
)

Turn off queuing

API Tags:

Access:

public

[ Top ]

EnableQueueMode [line 173]

void EnableQueueMode(
)

Turn on queuing

API Tags:

Access:

public

Redefined in descendants as:

Krai_Log_Logger_Console::EnableQueueMode() : Turn on queueing
Krai_Log_Logger_Syslog::EnableQueueMode() : Turn on queuing

[ Top ]

Entry [line 265]

void Entry(
boolean
$force, string
$category, integer
$severity, string
$msg 
)

Log a message

Parameters:

boolean	$force:
string	$category:
integer	$severity:
string	$msg:

API Tags:

Access:

public

[ Top ]

FlushMsg [line 228]

boolean FlushMsg(
)

Flush a message from the log queue

API Tags:

Access:

public

[ Top ]

FlushQueue [line 283]

void FlushQueue(
)

Flush the log queue

API Tags:

Access:

public

[ Top ]

GetType [line 121]

string GetType(
)

Get the type of the instance

API Tags:

Access:

public

[ Top ]

Open [line 97]

boolean Open(
)

Open the log instance

API Tags:

Access:

public

[ Top ]

QueueMsg [line 204]

void QueueMsg(

$queue_entry 
)

Add a message to the queue

Parameters:

array

$queue_entry:

API Tags:

Access:

public

[ Top ]

Reset [line 192]

void Reset(
)

Reset things

API Tags:

Access:

public

[ Top ]

SetErrorConditionThresh [line 153]

void SetErrorConditionThresh(
integer
$thresh 
)

Set If error condition thresh, then what to log

Parameters:

integer

$thresh:

API Tags:

Access:

public

[ Top ]

SetErrorConditionTriggerThresh [line 142]

void SetErrorConditionTriggerThresh(
integer
$thresh 
)

Set error condition threshold

Parameters:

integer

$thresh:

API Tags:

Access:

public

[ Top ]

SetMaxQueueSize [line 131]

void SetMaxQueueSize(
integer
$size 
)

Set the queue size

Parameters:

integer

$size:

API Tags:

Access:

public

[ Top ]

SetThresh [line 164]

void SetThresh(
integer
$threshold 
)

Set threshold for what to log

Parameters:

integer

$threshold:

API Tags:

Access:

public

[ Top ]

WriteLog [line 317]

void WriteLog(
string
$msg 
)

Write a message to the syslog

Parameters:

string

$msg:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 25 Jul 2008 15:19:30 -0400 by phpDocumentor 1.4.2