Docs For Class Module_cms

Description

Module page class.

Located in /cms/pages/modules/cms_chat.php (line 24)

Method Summary

tempcode chat_ban ()

tempcode chat_choose_room ()

tempcode chat_delete_all_messages ()

tempcode chat_edit_message ()

tempcode chat_unban ()

?array get_entry_points ()

array get_sp_overrides ()

?array info ()

tempcode moderate_chat_room ()

tempcode run ()

tempcode _chat_delete_all_messages ()

tempcode _chat_delete_many_messages ()

tempcode _chat_delete_message ()

tempcode _chat_edit_message ()

integer _sort_chat_browse_rows (array $a, array $b)

Methods

chat_ban (line 250)

The actualiser for banning a chatter.

return: The UI.

tempcode chat_ban ()

chat_choose_room (line 100)

The main user interface for choosing a chat room to moderate.

return: The UI.

tempcode chat_choose_room ()

chat_delete_all_messages (line 522)

The UI for deleting all the messages in a room.

return: The UI.

tempcode chat_delete_all_messages ()

chat_edit_message (line 338)

The UI for editing a message.

return: The UI.

tempcode chat_edit_message ()

chat_unban (line 297)

The actualiser for unbanning a chatter.

return: The UI.

tempcode chat_unban ()

get_entry_points (line 49)

Standard modular entry-point finder function.

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

?array get_entry_points ()

get_sp_overrides (line 59)

Standard modular specific-permission-overide finder function.

return: A map of specific-permissions that are overridable; sp to 0 or 1. 0 means "not category overridable". 1 means "category overridable".

array get_sp_overrides ()

info (line 32)

Standard modular info function.

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

?array info ()

moderate_chat_room (line 173)

The main user interface for moderating a chat room.

return: The UI.

tempcode moderate_chat_room ()

run (line 70)

Standard modular run function.

return: The result of execution.

tempcode run ()

_chat_delete_all_messages (line 552)

The actualiser for deleting all the messages in a room.

return: The UI.

tempcode _chat_delete_all_messages ()

_chat_delete_many_messages (line 593)

The actualiser for deleting all the ticked messages in a room.

return: The UI.

tempcode _chat_delete_many_messages ()

_chat_delete_message (line 459)

The actualiser for deleting a message.

return: The UI.

tempcode _chat_delete_message ()

_chat_edit_message (line 395)

The actualiser for editing a message.

return: The UI.

tempcode _chat_edit_message ()

_sort_chat_browse_rows (line 159)

Sort chatroom rows (callback).

return: Sorting code.

integer _sort_chat_browse_rows (array $a, array $b)

array $a: First row.
array $b: Second row.

Class Module_cms_chat