Friend Class Reference

Inheritance diagram for Friend:

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, $state=NULL, $limit=null, $offset=null, &$count=null, $returnArray=false)
static	DeleteBoth ($idUser1, $idUser2)
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 = "Friend"
	$IdAccount = 0
	$IdFriend = 0
	$State = FRIEND_STATE_ACCEPTED

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 Friends

Author

Skared Creations

Definition at line 10 of file Friend.php.

Constructor & Destructor Documentation

__construct()

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

Contructor

Definition at line 21 of file Friend.php.

Member Function Documentation

Delete()

Delete

(

)

Delete the record from the database

Returns

bool Returns TRUE on success

Definition at line 69 of file Friend.php.

DeleteBoth()

static DeleteBoth (   $idUser1,   $idUser2  )

static

Delete the records of both users from the database

Parameters

int	$idUser1	Id of the first Account
int	$idUser2	Id of the second Account

Returns

bool Returns TRUE on success

Definition at line 82 of file Friend.php.

Load()

static Load (   $idAccount,   $state = NULL,   $limit = null,   $offset = null, &  $count = null,   $returnArray = false  )

static

Get the registered contacts

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 Friend.php.

Save()

Save

(

)

Save the record in the database

Returns

bool Returns TRUE on success

Definition at line 54 of file Friend.php.

Field Documentation

$IdAccount

$IdAccount = 0

Definition at line 14 of file Friend.php.

$IdFriend

$IdFriend = 0

Definition at line 15 of file Friend.php.

$State

$State = FRIEND_STATE_ACCEPTED

Definition at line 16 of file Friend.php.

TABLE_NAME

const TABLE_NAME = "Friend"

Definition at line 12 of file Friend.php.