Function Hook_task_export_voting_power->run

Definitions

sources/hooks/systems/tasks/export_voting_power.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
$base float No No required parameter N/A N/A The root base to use for this calculation
$multiplier float No No required parameter N/A N/A The multiplier to use
$offset integer No No required parameter N/A N/A The offset to use
$ceiling ?integer No No required parameter N/A N/A The ceiling to use (null: no (infinite) ceiling)
$file_type ?string No No Null N/A N/A The file type to export with (null: default)

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  float $base The root base to use for this calculation
 * @param  float $multiplier The multiplier to use
 * @param  integer $offset The offset to use
 * @param  ?integer $ceiling The ceiling to use (null: no (infinite) ceiling)
 * @param  ?string $file_type The file type to export with (null: default)
 * @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(float $base, float $multiplier, int $offset, ?int $ceiling, ?string $file_type = null) : ?array