Function __global->points_get_transactions

Definitions

sources/points3.php

  • Get the point transactions a member has had.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$type ID_TEXT No No required parameter sender recipient sender_recipient credit debit all N/A The type of transactions we are looking for
$member_id_of MEMBER No No required parameter N/A N/A Who we are looking at transactions for
$member_id_viewing MEMBER No No required parameter N/A N/A Who we are looking at transactions using the account of
$max integer No No required parameter N/A N/A Maximum number of records to return
$start integer No No 0 N/A N/A The starting record number
$sortable SHORT_TEXT No No Blank (empty string) N/A N/A Fields by which we want to order (blank: no ordering)
$sort_order ID_TEXT No No DESC ASC DESC N/A Direction of ordering to use
$status ?integer No No Null N/A N/A Filter by the given ledger status (null: do not filter)
$skip_locked boolean No No False N/A N/A Whether to skip locked records
$skip_low_impact boolean No No True N/A N/A Whether to skip low-impact records (like forum posts)
$after_time ?TIME No No Null N/A N/A Only return transactions after this time (null: do not filter by time)

Returns

  • Duple of total rows in the database and an array of rows
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the point transactions a member has had.
 *
 * @param  ID_TEXT $type The type of transactions we are looking for
 * @set sender recipient sender_recipient credit debit all
 * @param  MEMBER $member_id_of Who we are looking at transactions for
 * @param  MEMBER $member_id_viewing Who we are looking at transactions using the account of
 * @param  integer $max Maximum number of records to return
 * @param  integer $start The starting record number
 * @param  SHORT_TEXT $sortable Fields by which we want to order (blank: no ordering)
 * @param  ID_TEXT $sort_order Direction of ordering to use
 * @set ASC DESC
 * @param  ?integer $status Filter by the given ledger status (null: do not filter)
 * @param  boolean $skip_locked Whether to skip locked records
 * @param  boolean $skip_low_impact Whether to skip low-impact records (like forum posts)
 * @param  ?TIME $after_time Only return transactions after this time (null: do not filter by time)
 * @return array Duple of total rows in the database and an array of rows
 */
function points_get_transactions(string $type, int $member_id_of, int $member_id_viewing, int $max, int $start = 0, string $sortable = '', string $sort_order = 'DESC', ?int $status = null, bool $skip_locked = false, bool $skip_low_impact = true, ?int $after_time = null) : array