/sources/points2.php

Description
Functions
add_to_charge_log (line 151)

Add an entry to the change log.

void add_to_charge_log (MEMBER $member_id, integer $amount, SHORT_TEXT $reason, [?TIME $time = NULL])
  • MEMBER $member_id: The member that is being charged
  • integer $amount: The amount being charged
  • SHORT_TEXT $reason: The reason for the charging
  • ?TIME $time: The time this is recorded to have happened (NULL: use current time)
charge_member (line 126)

Charge points from a specified member's account.

void charge_member (MEMBER $member_id, integer $amount, SHORT_TEXT $reason)
  • MEMBER $member_id: The member that is being charged
  • integer $amount: The amount being charged
  • SHORT_TEXT $reason: The reason for the charging
give_points (line 73)

Give a member some points.

void give_points (integer $amount, MEMBER $recipient_id, MEMBER $sender_id, SHORT_TEXT $reason, [boolean $anonymous = false], [boolean $send_email = true])
  • integer $amount: The amount being given
  • MEMBER $recipient_id: The member receiving the points
  • MEMBER $sender_id: The member sending the points
  • SHORT_TEXT $reason: The reason for the gift
  • boolean $anonymous: Does the sender want to remain anonymous?
  • boolean $send_email: Whether to send out an email about it
init__points2 (line 24)

Standard code module initialisation function.

void init__points2 ()
system_gift_transfer (line 36)

Transfer gift-points into the specified member's account, courtesy of the system.

void system_gift_transfer (SHORT_TEXT $reason, integer $amount, MEMBER $member_id)
  • SHORT_TEXT $reason: The reason for the transfer
  • integer $amount: The size of the transfer
  • MEMBER $member_id: The member the transfer is to

Documentation generated on Sun, 02 Jan 2011 23:22:31 +0000 by phpDocumentor 1.4.3