handleEvent Method

This method is called by Plesk once per business logic event. It contains event parameters that can be used by extensions.

Input arguments

$objectType

Data type: string.

Specifies the type of the affected object.

For details on allowed values for this argument, refer to the Object Types and Actions section.

 

$objectId

Data type: integer.

Specifies ID of the affected object. 0 if not applicable (singleton object like 'client_limit_size').

 

$action

Data type: string.

Specifies the action caused the event. Each action has the following presentation: <$objectId>_<postfix>.

Allowed postfixes: create | update | delete | start | stop | restart | reached | added | removed | login | logout | change | install | reconfigure | upgrade | expired

 

$oldValues

Data type: associative array.

Contains object parameters that are updated after the event happened. The array contains one entry per changed parameter. The entry key is the action log parameter name, and the entry value is the old value of the parameter.

Example:

array(
    'ip_address' => '192.0.2.12',
    'ip_mask' => '255.255.255.0',
    'interface' => 'eth0'
    'ip_type' => 'shared'
)

 

$newValues

Data type: associative array.

Contains object parameters that are updated after the event happened (one entry per changed parameter). The set of keys in this array will be exactly the same as for $oldValues. The entry key is the action log parameter name, and the entry value is the new value of the parameter.

For details on what array items are available for a combination of an action and objects affected by the action, refer to the Old and New Values Combinations section. For details on the meaning of a specific key, refer to the Old and New Values Description section.

Notes:
1. Some parameters appear in both arrays for informational purposes even if unchanged.
2. All parameters values are stored as strings. For instance, the value of a boolean parameter is the true or false string.

Return values

None.

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.