Function __global->points_dispatch_notification
Definitions
sources/points2.php
- Dispatch a points transaction notification to staff and optionally to the members involved.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the points ledger record pertaining to this notification |
| $sending_member | MEMBER | No | No | required parameter | N/A | N/A | The member sending points |
| $receiving_member | MEMBER | No | No | required parameter | N/A | N/A | The member receiving points |
| $reason | SHORT_TEXT | No | No | required parameter | N/A | N/A | The reason for this transaction |
| $actual_points | integer | No | No | required parameter | N/A | N/A | The actual number of regular points transacted |
| $actual_gift_points | integer | No | No | required parameter | N/A | N/A | The actual number of gift points transacted |
| $anonymous | BINARY | No | No | 0 | N/A | N/A | Whether the sender should be kept hidden |
| $send_member_notifications | boolean | No | No | True | N/A | N/A | Also send the notification to the members involved in this transaction |
| $is_refund | boolean | No | No | False | N/A | N/A | Whether the transaction was a refund |
Preview
Code (PHP)
/**
* Dispatch a points transaction notification to staff and optionally to the members involved.
*
* @param AUTO_LINK $id The ID of the points ledger record pertaining to this notification
* @param MEMBER $sending_member The member sending points
* @param MEMBER $receiving_member The member receiving points
* @param SHORT_TEXT $reason The reason for this transaction
* @param integer $actual_points The actual number of regular points transacted
* @param integer $actual_gift_points The actual number of gift points transacted
* @param BINARY $anonymous Whether the sender should be kept hidden
* @param boolean $send_member_notifications Also send the notification to the members involved in this transaction
* @param boolean $is_refund Whether the transaction was a refund
*/
function points_dispatch_notification(int $id, int $sending_member, int $receiving_member, string $reason, int $actual_points, int $actual_gift_points, int $anonymous = 0, bool $send_member_notifications = true, bool $is_refund = false)
* Dispatch a points transaction notification to staff and optionally to the members involved.
*
* @param AUTO_LINK $id The ID of the points ledger record pertaining to this notification
* @param MEMBER $sending_member The member sending points
* @param MEMBER $receiving_member The member receiving points
* @param SHORT_TEXT $reason The reason for this transaction
* @param integer $actual_points The actual number of regular points transacted
* @param integer $actual_gift_points The actual number of gift points transacted
* @param BINARY $anonymous Whether the sender should be kept hidden
* @param boolean $send_member_notifications Also send the notification to the members involved in this transaction
* @param boolean $is_refund Whether the transaction was a refund
*/
function points_dispatch_notification(int $id, int $sending_member, int $receiving_member, string $reason, int $actual_points, int $actual_gift_points, int $anonymous = 0, bool $send_member_notifications = true, bool $is_refund = false)
