Combu Server  3.1.1
PHP API Documentation
Public Member Functions | Static Public Member Functions | Data Fields
Achievement_User Class Reference
Inheritance diagram for Achievement_User:
DataClass

Public Member Functions

 __construct ($src=null, $stripSlashes=false)
 
 Save ()
 
 Delete ()
 
- Public Member Functions inherited from DataClass
 Save ()
 
 Delete ()
 
 ToJson ()
 
 ToArray ()
 

Static Public Member Functions

static LoadAccount ($idAccount, $idAchievement=0, $returnArray=false)
 
static Load ($idAchievement, $limit=null, $offset=null, &$count=null, $returnArray=false)
 
static Prune ()
 
- Static Public Member Functions inherited from DataClass
static GetTableName ($class)
 
static LoadRecords ($query, $returnedClass="")
 
static CountRecords ($tableName, $filter=null)
 
static TruncateTable ($tableName)
 
static TruncateClass ($class)
 

Data Fields

const TABLE_NAME = "Achievement_User"
 
 $Id = 0
 
 $IdAchievement = 0
 
 $IdAccount = 0
 
 $Progress = 0
 
 $LastUpdated = ""
 

Additional Inherited Members

- Protected Member Functions inherited from DataClass
 _loadFilter ($tableName, $filter)
 
 _loadByRow ($row, $stripSlashes=false, $callbackOnExists=false)
 
 _Delete ($tableName, $filter=null)
 
- Static Protected Member Functions inherited from DataClass
static _count ($tableName, $filter=null)
 
static _load ($tableName, $returnedClass="", $where="", $order=null, $limit=null, $offset=null, &$count=null)
 
static _loadEx ($select, $from, $returnedClass="", $where="", $order=null, $limit=null, $offset=null, &$count=null, $debug=false)
 
static _loadQuery ($query, $returnedClass="")
 

Detailed Description

Class to handle Achievement User Records

Author
Skared Creations

Definition at line 10 of file Achievement_User.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $src = null,
  $stripSlashes = false 
)

Contructor

Definition at line 23 of file Achievement_User.php.

Member Function Documentation

◆ Delete()

Delete ( )

Delete the record from the database

Returns
bool Returns TRUE on success

Definition at line 104 of file Achievement_User.php.

◆ Load()

static Load (   $idAchievement,
  $limit = null,
  $offset = null,
$count = null,
  $returnArray = false 
)
static

Get the registered scores

Parameters
string$idAchievementFilter IdLeaderboard
int$limitMax number of results (for paged results)
int$offsetOffset number of results (for paged results)
int$countWill be set to the total count of results
boolean$returnArrayIf TRUE then it will return associative arrays else objects
Returns
array Returns the array of records

Definition at line 62 of file Achievement_User.php.

◆ LoadAccount()

static LoadAccount (   $idAccount,
  $idAchievement = 0,
  $returnArray = false 
)
static

Get the registered scores

Parameters
string$idAccountFilter IdAccount
string$idAchievementFilter IdAchievement
boolean$returnArrayIf TRUE then it will return associative arrays else objects
Returns
[] Returns the array of records

Definition at line 44 of file Achievement_User.php.

◆ Prune()

static Prune ( )
static

Delete all records associated to this class

Definition at line 114 of file Achievement_User.php.

◆ Save()

Save ( )

Save the record in the database

Returns
bool Returns TRUE on success

Definition at line 72 of file Achievement_User.php.

Field Documentation

◆ $Id

$Id = 0

Definition at line 14 of file Achievement_User.php.

◆ $IdAccount

$IdAccount = 0

Definition at line 16 of file Achievement_User.php.

◆ $IdAchievement

$IdAchievement = 0

Definition at line 15 of file Achievement_User.php.

◆ $LastUpdated

$LastUpdated = ""

Definition at line 18 of file Achievement_User.php.

◆ $Progress

$Progress = 0

Definition at line 17 of file Achievement_User.php.

◆ TABLE_NAME

const TABLE_NAME = "Achievement_User"

Definition at line 12 of file Achievement_User.php.