CustomData Class Reference

Inheritance diagram for CustomData:

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	Load ($idAccount, $returnArray=false)
static	Prune ()
static	SetCustomData ($idAccount, $key, $value)
static	DeleteCustomData ($idAccount, $keys)
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 = "CustomData"
	$IdAccount = 0
	$DataKey = ""
	$DataValue = ""

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 User Custom Data

Author

Skared Creations

Definition at line 10 of file CustomData.php.

Constructor & Destructor Documentation

__construct()

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

Contructor

Definition at line 21 of file CustomData.php.

Member Function Documentation

Delete()

Delete

(

)

Delete the record from the database Database $Database

Returns

boolean Returns TRUE on success

Definition at line 62 of file CustomData.php.

DeleteCustomData()

static DeleteCustomData (   $idAccount,   $keys  )

static

A shortcut to quickly delete custom data for an account and returns if it was successful

Parameters

int	$idAccount
	string|string[]	$keys

Returns

boolean

Definition at line 98 of file CustomData.php.

Load()

static Load (   $idAccount,   $returnArray = false  )

static

Get the registered custom data

Parameters

string	$idAccount	Filter IdAccount
boolean	$returnArray	If TRUE then it will return associative arrays else objects

Returns

[] Returns the array of records

Definition at line 37 of file CustomData.php.

Prune()

static Prune ( )

static

Delete all records associated to this class

Definition at line 73 of file CustomData.php.

Save()

Save

(

)

Save the record in the database

Returns

bool Returns TRUE on success

Definition at line 47 of file CustomData.php.

SetCustomData()

static SetCustomData (   $idAccount,   $key,   $value  )

static

A shortcut to quickly update custom data for an account and returns if it was successful

Parameters

int	$idAccount
string	$key
string	$value

Returns

boolean

Definition at line 84 of file CustomData.php.

Field Documentation

$DataKey

$DataKey = ""

Definition at line 15 of file CustomData.php.

$DataValue

$DataValue = ""

Definition at line 16 of file CustomData.php.

$IdAccount

$IdAccount = 0

Definition at line 14 of file CustomData.php.

TABLE_NAME

const TABLE_NAME = "CustomData"

Definition at line 12 of file CustomData.php.