List of all members.

Public Member Functions
	__construct ($filtersObj, $parent)
	__get ($varName)
	__set ($varName, $varValue)
	addActiveFilter ($priority, $name, $type)
	addIntegratedFilter ($name, $type, $command)
	addScriptFilter ($name, $file)
	addSocketFilter ($name, $address, $protocol_file)
	getFiltersObj ()
	getSessionObj ()
	inherit ()
	isInherited ()
	listActiveFilters ()
	listIntegratedFilters ()
	listScriptFilters ()
	listSocketFilters ()
	removeActiveFilter ($priority)
	removeIntegratedFilter ($name)
	removeScriptFilter ($name)
	removeSocketFilter ($name)
	save ()
	updateActiveFilter ($priority)
	updateIntegratedFilter ($name)
	updateScriptFilter ($name)
	updateSocketFilter ($name)

---

Member Function Documentation

Filters::__get

(

$

varName

)

Get member.

member	description
logType	log type
logLevel	log level
logHost	log host

Filters::__set	(	$	varName,
		$	varValue
	)

Set member.

member	description
logType	log type
logLevel	log level
logHost	log host

Filters::addActiveFilter	(	$	priority,
		$	name,
		$	type
	)

this method adds an active filter

Returns:

bool

Parameters:

	$priority	int the priority of the filter
	$name	string the name of the filter as defined in the socket/script object sets
	$type	string type of the filter (to which object set belongs) (type: socket/script)

Filters::addIntegratedFilter	(	$	name,
		$	type,
		$	command
	)

this method adds an integrated filter

Returns:

bool

Parameters:

	$name	string the name of the filter
	$type	string integrated filter type
	$command	string integrated filter command

Filters::addScriptFilter	(	$	name,
		$	file
	)

this method adds a script filter

Returns:

bool

Parameters:

	$name	string the name of the filter
	$file	string the path to the file where the script is located

Filters::addSocketFilter	(	$	name,
		$	address,
		$	protocol_file
	)

this method adds a socket filter

Returns:

bool

Parameters:

	$name	string the name of the filter
	$address	string the address of the filter, used to communicate with the filter
	$protocol_file	string the path to the ASFL file that describes the communication protocol

Filters::inherit

(

)

set filters to be inherited from a selected source

Returns:

bool

Filters::isInherited

(

)

checks if the filters are inherited

Returns:

int (1 if the value is inherited, 0 if not, or -1 if this does not apply to the current filters object)

Filters::listActiveFilters

(

)

returns an array with all the active filters

Returns:

array

Filters::listIntegratedFilters

(

)

returns an array with all the integrated filters (only avaible on server context)

Returns:

array

Filters::listScriptFilters

(

)

returns an array with all the script filters

Returns:

array

Filters::listSocketFilters

(

)

returns an array with all the socket filters

Returns:

array

Filters::removeActiveFilter

(

$

priority

)

this method removes an active filter

Returns:

bool

Parameters:

$priority

int the priority of the filter

Filters::removeIntegratedFilter

(

$

name

)

this method removes an integrated filter

Returns:

bool

Parameters:

$name

string the name of the filter

Filters::removeScriptFilter

(

$

name

)

this method removes a script filter

Returns:

bool

Parameters:

$name

string the name of the filter

Filters::removeSocketFilter

(

$

name

)

this method removes a script filter

Returns:

bool

Parameters:

$name

string the name of the filter

Filters::save

(

)

this method must be called if one of the members has been changed

Returns:

bool

Filters::updateActiveFilter

(

$

priority

)

this method returns an object of ActiveFilters type for the selected filter

Returns:

object ActiveFilters

Parameters:

$priority

int the priority of the filter

Filters::updateIntegratedFilter

(

$

name

)

this method returns an object of IntegratedFilters type for the selected filter

Returns:

object IntegratedFilters

Parameters:

$name

string the name of the filter

Filters::updateScriptFilter

(

$

name

)

this method returns an object of ScriptFilters type for the selected filter

Returns:

object ScriptFilters

Parameters:

$name

string the name of the filter

Filters::updateSocketFilter

(

$

name

)

this method returns an object of SocketFilters type for the selected filter

Returns:

object SocketFilters

Parameters:

$name

string the name of the filter