Public Method Details |
pxdb_event_dispatcher |
public void pxdb_event_dispatcher()
|
|
|
Returns |
void |
|
&singleton |
public object [unknown] &singleton()
|
|
|
Returns |
object [unknown] |
|
mapTrigger |
public void mapTrigger(object listener $listener, string $trigger)
|
|
|
Parameter |
|
object listener |
$listener |
|
|
object |
|
|
|
Returns |
void |
|
notify |
public void notify(string $trigger, array $parameters)
|
|
|
Parameter |
|
string |
$trigger |
|
|
name, expected by listeners |
|
|
array |
$parameters |
|
|
to pass to listeners on notification |
|
Returns |
void |
|
suppressNotification |
public void suppressNotification(string $trigger, int $id)
|
|
particular records/objects. This is user session specific and allows developers of event listeners to work on Syntax objects and suppress triggers on those objects. This is one way to prevent infinite loops but also allows more control of when notifications are processed.
|
Parameter |
|
string |
$trigger |
|
|
- name of trigger to suppress |
|
|
int |
$id |
|
|
- record id for object to suppress triggers |
|
Returns |
void |
|
unsuppressNotification |
public void unsuppressNotification(string $trigger, int $id)
|
|
back on. You must call this after working with your object or you could suppress notifications on that record for the rest of the user session.
|
Parameter |
|
string |
$trigger |
|
|
- name of trigger to unsuppress |
|
|
int |
$id |
|
|
- record id for object to unsuppress triggers |
|
Returns |
void |
|
resetSuppressNotification |
public void resetSuppressNotification(string $trigger, int $id)
|
|
suppress (stored in the PHP session) return the system back to it's previous state. On the other hand unsuppressNotification() leaves evidence that the trigger has been suppressed which can be detected by calling the wasNotificationSuppressed() method.
|
Parameter |
|
string |
$trigger |
|
|
- name of trigger to unsuppress and reset |
|
|
int |
$id |
|
|
- record id for object to unsuppress and reset triggers |
|
Returns |
void |
|
isNotificationSuppressed |
public void isNotificationSuppressed(string $trigger, int $id)
|
|
been suppressed.
|
Parameter |
|
string |
$trigger |
|
|
- name of trigger to test |
|
|
int |
$id |
|
|
- record id for object to test |
|
Returns |
void |
|
wasNotificationSuppressed |
public void wasNotificationSuppressed(string $trigger, int $id)
|
|
is currently active was suppressed at some point during the user session.
|
Parameter |
|
string |
$trigger |
|
|
- name of trigger to test |
|
|
int |
$id |
|
|
- record id for object to test |
|
Returns |
void |
|