Function Hook_task_privacy_download->run

Definitions

sources/hooks/systems/tasks/privacy_download.php

  • Run the task hook.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$table_actions array No No required parameter N/A N/A Map between table names and PRIVACY_METHOD_* constants
$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

Returns

  • A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Run the task hook.
 *
 * @param  array $table_actions Map between table names and PRIVACY_METHOD_* constants
 * @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
 * @return ?array A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
 */
public function run(array $table_actions, string $username, array $ip_addresses, ?int $member_id, string $email_address, array $others) : ?array