Function __global->satisfy_escrow

Definitions

sources/points_escrow.php

  • Mark an escrow as satisfied by a member. Also completes the escrow if both members satisfied.
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$id AUTO_LINK required parameter N/A N/A The ID of the escrow to satisfy
$member_id MEMBER required parameter N/A N/A The member who is satisfying it
$row ?array Null N/A N/A If the escrow was already queried from the database, this is the row (null: query for the escrow)
$escrow_log boolean True N/A N/A Whether to log this in the escrow logs
$send_notifications ?boolean True N/A N/A Whether to send notifications for this transaction (false: only the staff get it) (true: both the member and staff get it) (null: neither the member nor staff get it)

Return

  • Tuple [integer ID of the recipient ledger, ?integer ID of the ledger refunding the sender (null means no refund processed), ?integer total points refunded (null means no refund), ?integer number of refunded points that were gift points (null means no refund)] (null: the escrow was not yet fully satisfied by all members)
  • Type: ?array
  • Set: N/A
  • Range: N/A