Function Hook_task_privacy_purge->handle_for_table
Definitions
sources/hooks/systems/tasks/privacy_purge.php
- Run the task hook.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $hook_ob | object | No | No | required parameter | N/A | N/A | Privacy object |
| $table_name | string | No | No | required parameter | N/A | N/A | Table name |
| $table_details | array | No | No | required parameter | N/A | N/A | Table details |
| $table_action | integer | No | No | required parameter | N/A | N/A | A PRIVACY_METHOD_* constant |
| $username | ID_TEXT | No | No | required parameter | N/A | N/A | Username to search for (blank: none) |
| $ip_addresses | array | No | No | required parameter | N/A | N/A | List of IP addresses to search for |
| $member_id | ?MEMBER | No | No | required parameter | N/A | N/A | Member ID to search for (null: none) |
| $email_address | string | No | No | required parameter | N/A | N/A | E-mail address to search for (blank: none) |
| $others | array | No | No | required parameter | N/A | N/A | List of other strings to search for, via additional-anonymise-fields |
Preview
Code (PHP)
/**
* Run the task hook.
*
* @param object $hook_ob Privacy object
* @param string $table_name Table name
* @param array $table_details Table details
* @param integer $table_action A PRIVACY_METHOD_* constant
* @param ID_TEXT $username Username to search for (blank: none)
* @param array $ip_addresses List of IP addresses to search for
* @param ?MEMBER $member_id Member ID to search for (null: none)
* @param string $email_address E-mail address to search for (blank: none)
* @param array $others List of other strings to search for, via additional-anonymise-fields
*/
protected function handle_for_table(object $hook_ob, string $table_name, array $table_details, int $table_action, string $username, array $ip_addresses, ?int $member_id, string $email_address, array $others)
* Run the task hook.
*
* @param object $hook_ob Privacy object
* @param string $table_name Table name
* @param array $table_details Table details
* @param integer $table_action A PRIVACY_METHOD_* constant
* @param ID_TEXT $username Username to search for (blank: none)
* @param array $ip_addresses List of IP addresses to search for
* @param ?MEMBER $member_id Member ID to search for (null: none)
* @param string $email_address E-mail address to search for (blank: none)
* @param array $others List of other strings to search for, via additional-anonymise-fields
*/
protected function handle_for_table(object $hook_ob, string $table_name, array $table_details, int $table_action, string $username, array $ip_addresses, ?int $member_id, string $email_address, array $others)
