Function __global->moderate_escrow

Definitions

sources/points_escrow.php

  • Moderate an escrow, and send out notifications.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: void

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id AUTO_LINK No No required parameter N/A N/A The ID of the escrow to moderate
$member_id MEMBER No No required parameter N/A N/A The member applying the dispute resolution action
$action ID_TEXT No No required parameter amend complete cancel N/A The action to take
$new_reason LONG_TEXT No No required parameter N/A N/A The new reason for the escrow
$new_agreement LONG_TEXT No No required parameter N/A N/A The new agreement terms for the escrow
$points integer No No required parameter N/A N/A The number of points to credit to the recipient (only applicable for the 'complete' action)
$reason LONG_TEXT No No required parameter N/A N/A The explanation for the action taken to resolve this dispute
$row ?array No No Null N/A N/A The database row for the escrow (null: query for it)

Preview

Code (PHP)

/**
 * Moderate an escrow, and send out notifications.
 *
 * @param  AUTO_LINK $id The ID of the escrow to moderate
 * @param  MEMBER $member_id The member applying the dispute resolution action
 * @param  ID_TEXT $action The action to take
 * @set amend complete cancel
 * @param  LONG_TEXT $new_reason The new reason for the escrow
 * @param  LONG_TEXT $new_agreement The new agreement terms for the escrow
 * @param  integer $points The number of points to credit to the recipient (only applicable for the 'complete' action)
 * @param  LONG_TEXT $reason The explanation for the action taken to resolve this dispute
 * @param  ?array $row The database row for the escrow (null: query for it)
 */
function moderate_escrow(int $id, int $member_id, string $action, string $new_reason, string $new_agreement, int $points, string $reason, ?array $row = null) : void