Combu Server  3.1.1
PHP API Documentation
Public Member Functions | Static Public Member Functions | Data Fields
UserGroupAccount Class Reference
Inheritance diagram for UserGroupAccount:
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 Exists ($idGroup, $idAccount)
 
static Load ($idGroup=0, $idAccount=0, $returnArray=false)
 
- 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 = "UserGroupAccount"
 
 $IdGroup = 0
 
 $IdAccount = 0
 

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 membership of Accounts in in-game Mail Groups

Author
Skared Creations

Definition at line 10 of file UserGroupAccount.php.

Constructor & Destructor Documentation

◆ __construct()

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

Contructor

Definition at line 20 of file UserGroupAccount.php.

Member Function Documentation

◆ Delete()

Delete ( )

Delete the record from the database

Returns
bool Returns TRUE on success

Definition at line 79 of file UserGroupAccount.php.

◆ Exists()

static Exists (   $idGroup,
  $idAccount 
)
static

Check if an account is already member of a group

Parameters
int$idGroupId of the group
int$idAccountId of the account
Returns
boolean Membership exists

Definition at line 36 of file UserGroupAccount.php.

◆ Load()

static Load (   $idGroup = 0,
  $idAccount = 0,
  $returnArray = false 
)
static

Get the registered memberships

Parameters
boolean$returnArrayIf TRUE then it will return associative arrays else objects
Returns
array Returns the array of records

Definition at line 49 of file UserGroupAccount.php.

◆ Save()

Save ( )

Save the record in the database

Returns
bool Returns TRUE on success

Definition at line 63 of file UserGroupAccount.php.

Field Documentation

◆ $IdAccount

$IdAccount = 0

Definition at line 15 of file UserGroupAccount.php.

◆ $IdGroup

$IdGroup = 0

Definition at line 14 of file UserGroupAccount.php.

◆ TABLE_NAME

const TABLE_NAME = "UserGroupAccount"

Definition at line 12 of file UserGroupAccount.php.