List of all members.

Public Member Functions
	__construct ($logObj, $parent)
	__get ($name)
	__set ($name, $value)
	addListener ($address)
	addLogRule ($priority, $hostname, $module, $level, $fileName, $fileSize, $fileTime, $fileCount, $rotatePeriod, $type)
	getLogHost ()
	getLogLevel ()
	getLogObj ()
	getLogType ()
	getPath ()
	getSessionObj ()
	listListeners ()
	listRules ()
	removeListener ($address)
	removeRule ($priority)
	reset ()
	save ()
	setLogHost ($value)
	setLogLevel ($value)
	setLogType ($value)
	setPath ($value)
	start ()
	stop ()
	updateListener ($address)
	updateRule ($oldpriority, $priority=null, $hostname=null, $module=null, $level=null, $fileName=null, $fileSize=null, $fileTime=null, $fileCount=null, $rotatePeriod=null, $type=null)

---

Member Function Documentation

Log::__get

(

$

name

)

Get member.

member	description
logLevel	the log level for the Log service
logHost	the address of the host that offers log services
logType	the log type for the Log service
path	the path for log service

Log::__set	(	$	name,
		$	value
	)

Set member.

member	description
logLevel	the log level for the Log service
logHost	the address of the host that offers log services
logType	the log type for the Log service
path	the path for log service

Log::addListener

(

$

address

)

This function adds a listener to this service

Returns:

bool

Parameters:

$address

string the listener address (ex: 127.0.0.1:2001)

Log::addLogRule	(	$	priority,
		$	hostname,
		$	module,
		$	level,
		$	fileName,
		$	fileSize,
		$	fileTime,
		$	fileCount,
		$	rotatePeriod,
		$	type
	)

This function adds a log rule to the log service

Parameters:

	$priority	int the priority of the log rule
	$hostname	string the logging host address for this log rule. It will be used if the log type is remote
	$module	string The 'value' parameter can be "*" meaning every module or "pop3" for the pop3 module or "pop3 imap" for the POP3&IMAP modules
	$level	int the log level for this rule
	$fileName	string the file path for the logging file
	$fileSize	int the maximum file size for the log file
	$fileTime	int the maximum duration for the log file
	$fileCount	int the maximum number of old log files that will be kept
	$rotatePeriod	string the log rotate period. This will be override the log file file_time. Accepted values for the 'value' parameters are: "none", "day", "week" or "month"
	$type	string the type of the rule (choice: local|remote)

Returns:

bool

Log::listListeners

(

)

This function lists the listeners for this service

Returns:

array

Log::listRules

(

)

This method lists the log rules

Returns:

array

Log::removeListener

(

$

address

)

This function removes a listener from this service

Returns:

bool

Parameters:

$address

string the listener address (ex: 127.0.0.1:25)

Log::removeRule

(

$

priority

)

Removes a log rule

Parameters:

$priority

int the rule priority

Returns:

bool

Log::start

(

)

This function starts the Log service

Returns:

bool

Log::stop

(

)

This function stops the Log service

Returns:

bool

Log::updateListener

(

$

address

)

This function updates a listener from this service

Returns:

object UdpListener

Parameters:

$address

string the listener address (ex: 127.0.0.1:25)

Log::updateRule	(	$	oldpriority,
		$	priority = null,
		$	hostname = null,
		$	module = null,
		$	level = null,
		$	fileName = null,
		$	fileSize = null,
		$	fileTime = null,
		$	fileCount = null,
		$	rotatePeriod = null,
		$	type = null
	)

This function adds a log rule to the log service

Parameters:

	$oldpriority	int the priority of the log rule that you want to change
	$priority	int the priority of the log rule
	$hostname	string the logging host address for this log rule. It will be used if the log type is remote
	$module	string The 'value' parameter can be "*" meaning every module or "pop3" for the pop3 module or "pop3 imap" for the POP3&IMAPp modules
	$level	int the log level for this rule
	$fileName	string the file path for the logging file
	$fileSize	int the maximum file size for the log file
	$fileTime	int the maximum duration for the log file
	$fileCount	int the maximum number of old log files that will be kept
	$rotatePeriod	string the log rotate period. This will be override the log file file_time. Accepted values for the 'value' parameters are: "none", "day", "week" or "month"
	$type	string the type of the rule (choice: local|remote)

Returns:

bool