Roster Class Reference

Public Member Functions
	__construct ($roster_array=array())
	addContact ($jid, $subscription, $name='', $groups=array())
	getContact ($jid)
	isContact ($jid)
	setPresence ($presence, $priority, $show, $status)
	getPresence ($jid)
	getRoster ()
Protected Member Functions
	verifyRoster ($roster_array)
Protected Attributes
	$roster_array = array()

---

Detailed Description

Definition at line 41 of file Roster.php.

---

Constructor & Destructor Documentation

__construct

(

$

roster_array = array()

)

Constructor

Definition at line 52 of file Roster.php.

Here is the call graph for this function:

---

Member Function Documentation

addContact	(	$	jid,
		$	subscription,
		$	name = '',
		$	groups = array()
	)

Add given contact to roster

Parameters:

string	$jid
string	$subscription
string	$name
array	$groups

Definition at line 80 of file Roster.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getContact

(

$

jid

)

Retrieve contact via jid

Parameters:

string

$jid

Definition at line 95 of file Roster.php.

Here is the call graph for this function:

getPresence

(

$

jid

)

Definition at line 139 of file Roster.php.

Here is the call graph for this function:

getRoster

(

)

Get roster

Definition at line 159 of file Roster.php.

isContact

(

$

jid

)

Discover if a contact exists in the roster via jid

Parameters:

string

$jid

Definition at line 107 of file Roster.php.

Here is the caller graph for this function:

setPresence	(	$	presence,
		$	priority,
		$	show,
		$	status
	)

Set presence

Parameters:

string	$presence
integer	$priority
string	$show
string	$status

Definition at line 120 of file Roster.php.

Here is the call graph for this function:

verifyRoster

(

$

roster_array

)

[protected]

Check that a given roster array is of a valid structure (empty is still valid)

Parameters:

array

$roster_array

Definition at line 66 of file Roster.php.

Here is the caller graph for this function:

---

Field Documentation

$roster_array = array() [protected]

Definition at line 47 of file Roster.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/jabber/XMPP/Roster.php