Docs For Class Module

Class Module_chat

Description

Module page class.

Located in /site/pages/modules/chat.php (line 24)

Method Summary

tempcode blocking_add ()

tempcode blocking_interface ()

tempcode blocking_remove ()

tempcode blocking_set ()

tempcode buddies_list ()

tempcode buddy_add ()

tempcode buddy_remove ()

tempcode chat_download_logs ()

tempcode chat_lobby ()

tempcode chat_options ()

tempcode chat_private ()

tempcode chat_room ()

array extract_page_link_permissions (string $page_link)

?array get_entry_points ()

?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])

void get_sitemap_pagelinks (string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub)

?tempcode handle_repost (ID_TEXT $action, string $param)

?array info ()

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

tempcode run ()

tempcode set_effects ()

void uninstall ()

tempcode _chat_download_logs ()

tempcode _chat_private ()

tempcode _set_effects ()

Methods

blocking_add (line 808)

Change blocking settings (add one specific to block list, and then redirect).

return: The UI

tempcode blocking_add ()

blocking_interface (line 698)

The UI to manage who is blocked.

return: The UI

tempcode blocking_interface ()

blocking_remove (line 840)

Change blocking settings (remove one specific member from block list, and then redirect).

return: The UI

tempcode blocking_remove ()

blocking_set (line 737)

Change blocking settings.

return: The UI

tempcode blocking_set ()

buddies_list (line 958)

List all the buddies of a member.

return: The UI

tempcode buddies_list ()

buddy_add (line 872)

Add a buddy.

return: The UI

tempcode buddy_add ()

buddy_remove (line 910)

Remove a buddy.

return: The UI

tempcode buddy_remove ()

chat_download_logs (line 1031)

The UI to download chat logs.

return: The UI

tempcode chat_download_logs ()

chat_lobby (line 383)

The UI to choose a chat room.

return: The UI

tempcode chat_lobby ()

chat_options (line 1014)

Save the user's options into a cookie.

return: The UI

tempcode chat_options ()

chat_private (line 614)

The UI to create a private chat room.

return: The UI

tempcode chat_private ()

chat_room (line 512)

The UI for a chat room.

return: The UI

tempcode chat_room ()

extract_page_link_permissions (line 328)

Convert a page link to a category ID and category permission module type.

return: The pair

array extract_page_link_permissions (string $page_link)

string $page_link: The page link

get_entry_points (line 257)

Standard modular entry-point finder function.

return: A map of entry points (type-code=>language-code) (NULL: disabled).

?array get_entry_points ()

get_page_links (line 271)

Standard modular page-link finder function (does not return the main entry-points that are not inside the tree).

return: A tuple: 1) full tree structure [made up of (pagelink, permission-module, permissions-id, title, children, ?entry point for the children, ?children permission module, ?whether there are children) OR a list of maps from a get_* function] 2) permissions-page 3) optional base entry-point for the tree 4) optional permission-module 5) optional permissions-id (NULL: disabled).

?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])

?integer $max_depth: The number of tree levels to computer (NULL: no limit)
boolean $require_permission_support: Whether to not return stuff that does not support permissions (unless it is underneath something that does).
?string $start_at: Position to start at in the tree. Does not need to be respected. (NULL: from root)
boolean $dont_care_about_categories: Whether to avoid returning categories.

get_sitemap_pagelinks (line 300)

Standard modular new-style deep page-link finder function (does not return the main entry-points).

void get_sitemap_pagelinks (string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub)

string $callback: Callback function to send discovered page-links to.
MEMBER $member_id: The member we are finding stuff for (we only find what the member can view).
integer $depth: Code for how deep we are tunnelling down, in terms of whether we are getting entries as well as categories.
string $pagelink_stub: Stub used to create page-links. This is passed in because we don't want to assume a zone or page name within this function.

handle_repost (line 777)

Certain add/remove actions may be triggered by hyperlinks, but they need confirming because a link click should never constitute a state change.

return: If a confirm page is being output, this is it (NULL: continue as before)

?tempcode handle_repost (ID_TEXT $action, string $param)

ID_TEXT $action: The language code of our action
string $param: Parameter of action

info (line 32)

Standard modular info function.

return: Map of module info (NULL: module is disabled).

?array info ()

install (line 89)

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

?integer $upgrade_from: What version we're upgrading from (NULL: new install)
?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)

run (line 340)

Standard modular run function.

return: The result of execution.

tempcode run ()

set_effects (line 1089)

The interface for setting sound effects.

return: The UI

tempcode set_effects ()

uninstall (line 48)

Standard modular uninstall function.

void uninstall ()

_chat_download_logs (line 1064)

The actualiser to download chat logs.

return: The UI

tempcode _chat_download_logs ()

_chat_private (line 644)

The actualiser to add a chat room.

return: The UI to choose a chat room (probably what was just added, but...)

tempcode _chat_private ()

_set_effects (line 1169)

The actualiser to set sound effects.

return: The UI

tempcode _set_effects ()

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