Detector Class

This class handles the email Detector data. In normal use you won't ever deal with this class. It is documented here for the intrepid.

Important: All of these functions are available through the detector object returned by the Peeker Detector Set class. Notated here as: $detector

Function Reference

peeker_detector($dm=NULL, $dma=NULL, $cm=NULL, $cma=NULL, &$detector_set_parent=NULL)

Constructor

$detector->peeker_detector();

set_detector($method)

Send the name of a function that returns TRUE or FALSE.

$detector->set_detector('ttrue');

get_detector()

Get the detector function name as string.

$detector->get_detector();

set_detector_arguments(&$array)

Send the arguments that the detector function needs.

$detector->set_detector_arguments();

get_detector_arguments()

Get the detector arguments.

$detector->get_detector_arguments();

set_callback($method)

Set the callback function to be called if the detector is TRUE.

$detector->set_callback();

get_callback()

Get the callback function name as string.

$detector->get_callback();

set_callback_arguments(&$array)

Send the arguments that the callback function needs.

$detector->set_callback_arguments();

get_callback_arguments()

Get the callback arguments.

$detector->get_callback_arguments();

check(&$obj)

Returns the result of the registered detector function.

$detector->check()

trigger(&$obj)

Calls the registered callback function.

$detector->trigger()

set_active($bool)

Toggle the active state for the detector object. Turns off both check() and trigger() functions - if inactive both functions return NULL.

$detector->set_active()