Contacts Class Reference

Inheritance diagram for Contacts:

Collaboration diagram for Contacts:

Public Member Functions
	getUserContacts ($user_id)
	addUserContact ($user_id, $buddy_user_id)
	removeUserContact ($user_id, $buddy_user_id)
	getUserContactGroups ($user_id)
	createContactGroup ($user_id)
	showContactGroup ($group_id)
	destroyContactGroup ($group_id)
	indexOfContactGroupMembers ($group_id)
	addToContactGroup ($group_id, $user_id)
	removeFromContactGroup ($group_id, $user_id)
Public Member Functions inherited from RouteMap
	__construct ()
	init ($router, $route, $request_body=null)
	paginated ($data, $total, $uri_params=array(), $query_params=array())
	paginate ($uri_format, $total, $offset=null, $limit=null)
	collect ($data)
	status ($status)
	headers ($headers=array())
	body ($body)
	contentType ($mime_type, $params=array())
	error ($status, $body=null)
	etag ($value, $strong_etag=true, $new_resource=null)
	expires ($amount, $cache_control=array())
	cacheControl ($values)
	halt ()
	lastModified ($time)
	notFound ($body=null)
	redirect ($url, $args=null)
	sendFile ($_path, $opts=array())
	url ($addr, $url_params=null)
	urlf ($addr_f, $format_params, $url_params=null)

Static Public Member Functions
static	before ()

Additional Inherited Members
Protected Attributes inherited from RouteMap
	$pagination = false
	$offset
	$limit

Detailed Description

Author

mlunz.nosp@m.ena@.nosp@m.uos.d.nosp@m.e @license GPL 2 or later

@condition user_id ^[a-f0-9]{32}$ @condition friend_id ^[a-f0-9]{32}$ @condition group_id ^[a-f0-9]{32}$

Member Function Documentation

addToContactGroup()

addToContactGroup	(		$group_id,
			$user_id
	)

Add a user to a contact group

@put /contact_group/:group_id/members/:user_id

Here is the call graph for this function:

addUserContact()

addUserContact	(		$user_id,
			$buddy_user_id
	)

Adds/Updates a contact to user's list of contacts

@put /user/:user_id/contacts/:friend_id

Here is the call graph for this function:

before()

static before ( )

static

createContactGroup()

createContactGroup

(

$user_id

)

Create a new contact group for a user.

Postcondition

/user/:user_id/contact_groups

Here is the call graph for this function:

destroyContactGroup()

destroyContactGroup

(

$group_id

)

Remove a contact group

@delete /contact_group/:group_id

Here is the call graph for this function:

getUserContactGroups()

getUserContactGroups

(

$user_id

)

List all contact groups of a user

@get /user/:user_id/contact_groups

Here is the call graph for this function:

getUserContacts()

getUserContacts

(

$user_id

)

Lists all contacts of a user

@get /user/:user_id/contacts

Here is the call graph for this function:

indexOfContactGroupMembers()

indexOfContactGroupMembers

(

$group_id

)

List all members of a contact group

@get /contact_group/:group_id/members

Here is the call graph for this function:

removeFromContactGroup()

removeFromContactGroup	(		$group_id,
			$user_id
	)

Remove a user from a contact group

@delete /contact_group/:group_id/members/:user_id

Here is the call graph for this function:

removeUserContact()

removeUserContact	(		$user_id,
			$buddy_user_id
	)

Deletes a contact

@delete /user/:user_id/contacts/:friend_id

Here is the call graph for this function:

showContactGroup()

showContactGroup

(

$group_id

)

Show a single contact group

@get /contact_group/:group_id

Here is the call graph for this function:

---

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

• app/routes/Contacts.php