Function __global->_points_transact
Definitions
sources/points2.php
- Actualisation for processing the points transaction and putting it into the ledger.This adds the points transaction into the ledger (officiating the points transaction) and re-calculates points CPFs and cache.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: int
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $sending_member | MEMBER | required parameter | N/A | N/A | The member sending the points (use guest ID for a credit from the system) |
| $receiving_member | MEMBER | required parameter | N/A | N/A | The member receiving the points (use guest ID for a debit to the system) |
| $reason | SHORT_TEXT | required parameter | N/A | N/A | The reason for this transaction used in the logs |
| $amount_points | integer | required parameter | N/A | N/A | Number of regular points transacted (does not include gift points) |
| $amount_gift_points | integer | required parameter | N/A | N/A | Number of gift points transacted |
| $anonymous | BINARY | 0 | N/A | N/A | Whether the sending_member for this transaction should be hidden |
| $status | integer | 0 | N/A | N/A | The status of this transaction (see LEDGER_STATUS_*) |
| $locked | BINARY | 0 | N/A | N/A | Whether this transaction is irreversible |
| $linked_ledger | ?array | Null | N/A | N/A | The database row of the points_ledger this one relates to (null: does not relate to another ledger) |
| $t_type | ID_TEXT | Blank (empty string) | N/A | N/A | An identifier to relate this transaction with other transactions of the same $type (e.g. content type) |
| $t_subtype | ID_TEXT | Blank (empty string) | N/A | N/A | An identifier to relate this transaction with other transactions of the same $type and $subtype (e.g. an action performed on the $type) |
| $t_type_id | ID_TEXT | Blank (empty string) | N/A | N/A | Some content or row ID of the specified $type |
| $time | ?TIME | Null | N/A | N/A | The time this transaction occurred (null: now) |
| $is_ranked | BINARY | 1 | N/A | N/A | Whether the points should affect rank points for the sending member if a debit, else the reciving member |
Return
- The ID of the point transaction in the ledger
- Type: AUTO_LINK
- Set: N/A
- Range: N/A