Function __global->escrow_log_it
Definitions
sources/points_escrow.php
- Log something in a points escrow.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: int
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $type | ID_TEXT | No | No | required parameter | N/A | N/A | The type of log; a language string |
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the escrow |
| $member_id | ?MEMBER | No | No | Null | N/A | N/A | The member associated with this log (null: no member associated) |
| $information | LONG_TEXT | No | No | Blank (empty string) | N/A | N/A | Additional information pertaining to this log |
Returns
- The ID of the record
- Type: AUTO_LINK
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Log something in a points escrow.
*
* @param ID_TEXT $type The type of log; a language string
* @param AUTO_LINK $id The ID of the escrow
* @param ?MEMBER $member_id The member associated with this log (null: no member associated)
* @param LONG_TEXT $information Additional information pertaining to this log
* @return AUTO_LINK The ID of the record
*/
function escrow_log_it(string $type, int $id, ?int $member_id = null, string $information = '') : int
* Log something in a points escrow.
*
* @param ID_TEXT $type The type of log; a language string
* @param AUTO_LINK $id The ID of the escrow
* @param ?MEMBER $member_id The member associated with this log (null: no member associated)
* @param LONG_TEXT $information Additional information pertaining to this log
* @return AUTO_LINK The ID of the record
*/
function escrow_log_it(string $type, int $id, ?int $member_id = null, string $information = '') : int
