Function __global->complete_all_escrows_by_content

Definitions

sources/points_escrow.php

  • Complete all escrows by a given content type and ID.This bypasses the satisfy system. It will only complete escrows in the pending state.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$receiving_member MEMBER No No required parameter N/A N/A The member receiving the points for escrows without a receiving member set
$content_type ID_TEXT No No required parameter N/A N/A The associated content type to complete
$content_id ID_TEXT No No required parameter N/A N/A The associated content ID to complete

Returns

  • Map of escrow IDs to the output of _complete_escrow()
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Complete all escrows by a given content type and ID.This bypasses the satisfy system. It will only complete escrows in the pending state.
 *
 * @param  MEMBER $receiving_member The member receiving the points for escrows without a receiving member set
 * @param  ID_TEXT $content_type The associated content type to complete
 * @param  ID_TEXT $content_id The associated content ID to complete
 * @return array Map of escrow IDs to the output of _complete_escrow()
 */
function complete_all_escrows_by_content(int $receiving_member, string $content_type, string $content_id) : array