Function __global->_points_transact_calculate
Definitions
sources/points2.php
- Calculate how many points will be transacted from the sender to the recipient.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $sending_member | MEMBER | required parameter | N/A | N/A | The ID of the member sending the points |
| $total_points | integer | required parameter | N/A | N/A | The total number of points to transact (includes gift points when applicable) |
| $amount_gift_points | ?integer | Null | N/A | N/A | The strict number of $total_points which should come from the sender's gift points (null: use what gift points the sender has available) |
| $force | boolean | False | N/A | N/A | Whether this transaction is being forced (true: this function will never return null) |
Return
- Duple containing the number of regular points (key 0) and number of gift points (key 1) that should be transacted from the sender (null: not enough points to satisfy the conditions specified)
- Type: ?array
- Set: N/A
- Range: N/A