/sources/chat2.php

Description
Functions
add_chatroom (line 236)

Add a chatroom.

  • return: The chat room ID
AUTO_LINK add_chatroom (SHORT_TEXT $welcome, SHORT_TEXT $roomname, MEMBER $room_owner, LONG_TEXT $allow2, LONG_TEXT $allow2_groups, LONG_TEXT $disallow2, LONG_TEXT $disallow2_groups, LANGUAGE_NAME $roomlang, [BINARY $is_im = 0])
  • SHORT_TEXT $welcome: The welcome message
  • SHORT_TEXT $roomname: The room name
  • MEMBER $room_owner: The room owner
  • LONG_TEXT $allow2: The comma-separated list of users that may access it (blank: no restriction)
  • LONG_TEXT $allow2_groups: The comma-separated list of usergroups that may access it (blank: no restriction)
  • LONG_TEXT $disallow2: The comma-separated list of users that may NOT access it (blank: no restriction)
  • LONG_TEXT $disallow2_groups: The comma-separated list of usergroups that may NOT access it (blank: no restriction)
  • LANGUAGE_NAME $roomlang: The room language
  • BINARY $is_im: Whether it is an IM room
blocking_add (line 28)

Block a member.

void blocking_add (MEMBER $blocker, MEMBER $blocked, [?TIME $time = NULL])
  • MEMBER $blocker: The member blocking
  • MEMBER $blocked: The member being blocked
  • ?TIME $time: The logged time of the block (NULL: now)
blocking_remove (line 52)

Unblock a member.

void blocking_remove (MEMBER $blocker, MEMBER $blocked)
  • MEMBER $blocker: The member unblocking
  • MEMBER $blocked: The member being unblocked
buddy_add (line 69)

Add a buddy.

void buddy_add (MEMBER $likes, MEMBER $liked, [?TIME $time = NULL])
  • MEMBER $likes: The member befriending
  • MEMBER $liked: The member being befriended
  • ?TIME $time: The logged time of the friendship (NULL: now)
buddy_remove (line 106)

Remove ('dump') a buddy.

void buddy_remove (MEMBER $likes, MEMBER $liked)
  • MEMBER $likes: The member befriending
  • MEMBER $liked: The member being dumped
chatroom_ban_to (line 345)

Ban a member from a chatroom.

void chatroom_ban_to (MEMBER $member_id, AUTO_LINK $id)
  • MEMBER $member_id: The member to ban
  • AUTO_LINK $id: The chat room ID
chatroom_unban_to (line 360)

Unban a member from a chatroom.

void chatroom_unban_to (MEMBER $member_id, AUTO_LINK $id)
  • MEMBER $member_id: The member to unban
  • AUTO_LINK $id: The chat room ID
delete_all_chatrooms (line 319)

Delete all chatrooms.

void delete_all_chatrooms ()
delete_chatroom (line 279)

Delete a chatroom.

void delete_chatroom (AUTO_LINK $id)
  • AUTO_LINK $id: The chat room ID
delete_chatroom_messages (line 381)

Delete all messages in a chatroom.

void delete_chatroom_messages (AUTO_LINK $id)
  • AUTO_LINK $id: The chat room ID
delete_chat_messages (line 301)

Delete chat messages.

void delete_chat_messages (array $where)
  • array $where: Where query to specify what to delete
edit_chatroom (line 260)

Edit a chatroom.

void edit_chatroom (AUTO_LINK $id, SHORT_TEXT $welcome, SHORT_TEXT $roomname, MEMBER $room_owner, LONG_TEXT $allow2, LONG_TEXT $allow2_groups, LONG_TEXT $disallow2, LONG_TEXT $disallow2_groups, LANGUAGE_NAME $roomlang)
  • AUTO_LINK $id: The chat room ID
  • SHORT_TEXT $welcome: The welcome message
  • SHORT_TEXT $roomname: The room name
  • MEMBER $room_owner: The room owner
  • LONG_TEXT $allow2: The comma-separated list of users that may access it (blank: no restriction)
  • LONG_TEXT $allow2_groups: The comma-separated list of usergroups that may access it (blank: no restriction)
  • LONG_TEXT $disallow2: The comma-separated list of users that may NOT access it (blank: no restriction)
  • LONG_TEXT $disallow2_groups: The comma-separated list of usergroups that may NOT access it (blank: no restriction)
  • LANGUAGE_NAME $roomlang: The room language
get_chatroom_fields (line 129)

Get form fields for adding/editing a chatroom.

  • return: The fields
tempcode get_chatroom_fields ([boolean $is_made_by_me = false], [SHORT_TEXT $room_name = ''], [LONG_TEXT $welcome = ''], [SHORT_TEXT $username = ''], [LONG_TEXT $allow2 = ''], [LONG_TEXT $allow2_groups = ''], [LONG_TEXT $disallow2 = ''], [LONG_TEXT $disallow2_groups = ''])
  • boolean $is_made_by_me: Whether the room is being made as a private room by the current member
  • SHORT_TEXT $room_name: The room name
  • LONG_TEXT $welcome: The welcome message
  • SHORT_TEXT $username: The owner username
  • LONG_TEXT $allow2: The comma-separated list of users that may access it (blank: no restriction)
  • LONG_TEXT $allow2_groups: The comma-separated list of usergroups that may access it (blank: no restriction)
  • LONG_TEXT $disallow2: The comma-separated list of users that may NOT access it (blank: no restriction)
  • LONG_TEXT $disallow2_groups: The comma-separated list of usergroups that may NOT access it (blank: no restriction)
read_in_chat_perm_fields (line 178)

Read in chat permission fields, from the complex posted data.

  • return: A tuple of permission fields
array read_in_chat_perm_fields ()

Documentation generated on Sun, 02 Jan 2011 23:10:47 +0000 by phpDocumentor 1.4.3