/sources/points.php

Description
Functions
available_points (line 104)

Get the total points the specified member has

  • return: The number of points the member has
integer available_points (MEMBER $member)
  • MEMBER $member: The member
get_gift_points_to_give (line 160)

Get the number of gifts points to give that the given member has.

  • return: The number of gifts points to give that the given member has
integer get_gift_points_to_give (MEMBER $member)
  • MEMBER $member: The member we want it for
get_gift_points_used (line 146)

Get the number of gift points used by the given member.

  • return: The number of gift points used by the member
integer get_gift_points_used (MEMBER $member)
  • MEMBER $member: The member we want it for
get_price (line 40)

Get the price of the specified item for sale in the point-store (only for tableless items).

  • return: The price of the item
integer get_price (ID_TEXT $item)
  • ID_TEXT $item: The name of the item
init__points (line 24)

Standard code module initialisation function.

void init__points ()
points_used (line 86)

Get the total points the specified member has used (spent).

  • return: The number of points the member has spent
integer points_used (MEMBER $member)
  • MEMBER $member: The member
point_info (line 117)

Get all sorts of information about a specified member's point account.

  • return: The map containing the members point info (fields as enumerated in description)
array point_info (MEMBER $member)
  • MEMBER $member: The member the point info is of
total_points (line 51)

Get the total points in the specified member's account; some of these will probably have been spent already

  • return: The number of points the member has
integer total_points (MEMBER $member)
  • MEMBER $member: The member

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