Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Contacts Class Reference
Inheritance diagram for Contacts:
RouteMap

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)
 
 paginated ($data, $total, $uri_params=[], $query_params=[])
 
 paginate ($uri_format, $total, $offset=null, $limit=null)
 
 collect ($data)
 
 status ($status)
 
 headers ($headers=[])
 
 body ($body)
 
 contentType ($mime_type, $params=[])
 
 error ($status, $body=null)
 
 etag ($value, $strong_etag=true, $new_resource=null)
 
 expires ($amount, $cache_control=[])
 
 cacheControl ($values)
 
 halt ()
 
 lastModified ($time)
 
 notFound ($body=null)
 
 redirect ($url, $args=null)
 
 sendFile ($_path, $opts=[])
 
 url ($addr, $url_params=null)
 
 urlf ($addr_f, $format_params, $url_params=null)
 
 getRoutes ($http_method=null)
 
 getResponse ()
 

Static Public Member Functions

static before ()
 

Additional Inherited Members

- Protected Member Functions inherited from RouteMap
 extractConditions ($docblock, $conditions=[])
 
- Protected Attributes inherited from RouteMap
 $router
 
 $route
 
 $data = null
 
 $response
 
 $pagination = false
 
 $offset
 
 $limit
 

Detailed Description

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

user_id ^[a-f0-9]{1,32}$ friend_id ^[a-f0-9]{1,32}$ group_id ^[a-f0-9]{1,32}$

Member Function Documentation

addToContactGroup (   $group_id,
  $user_id 
)

Add a user to a contact group

/contact_group/:group_id/members/:user_id

addUserContact (   $user_id,
  $buddy_user_id 
)

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

/user/:user_id/contacts/:friend_id

static before ( )
static
createContactGroup (   $user_id)

Create a new contact group for a user.

Postcondition
/user/:user_id/contact_groups
destroyContactGroup (   $group_id)

Remove a contact group

/contact_group/:group_id

getUserContactGroups (   $user_id)

List all contact groups of a user

/user/:user_id/contact_groups

getUserContacts (   $user_id)

Lists all contacts of a user

/user/:user_id/contacts

indexOfContactGroupMembers (   $group_id)

List all members of a contact group

/contact_group/:group_id/members

removeFromContactGroup (   $group_id,
  $user_id 
)

Remove a user from a contact group

/contact_group/:group_id/members/:user_id

removeUserContact (   $user_id,
  $buddy_user_id 
)

Deletes a contact

/user/:user_id/contacts/:friend_id

showContactGroup (   $group_id)

Show a single contact group

/contact_group/:group_id


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