Function __global->chat_get_room_content
Definitions
sources/chat.php
- Get a multidimensional array of the content of the specified chatroom.It automatically parses for Comcode, chatcode, banned words, emoticons, and uses complex logic to decide whether or not to show each message; based upon who the member is, the message content, and other such inputs.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $room_id | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The room ID (null: for all IM) |
| $_rooms | array | No | No | required parameter | N/A | N/A | Rooms database rows that we'll need |
| $max_messages | ?integer | No | No | Null | N/A | N/A | The maximum number of messages to be returned (null: no maximum) |
| $dereference | boolean | No | No | False | N/A | N/A | Whether to dereference the returned messages (i.e. lookup the content language strings) |
| $downloading | boolean | No | No | False | N/A | N/A | Whether to return the messages in a downloadable format (using the templates for log downloading) |
| $start | ?integer | No | No | Null | N/A | N/A | The datetime stamp to start gathering messages from (null: all) |
| $finish | ?integer | No | No | Null | N/A | N/A | The datetime stamp to stop gathering messages at (null: current time) |
| $uptoid | ?integer | No | No | Null | N/A | N/A | The lowest message ID to return (null: no special lowest number) |
| $zone | ?ID_TEXT | No | No | Null | N/A | N/A | The zone the chat module is in (null: find it) |
| $entering_room | ?mixed | No | No | Null | N/A | N/A | The content language string ID for the "entering room" message (null: not entering the room) |
| $return_my_messages | boolean | No | No | True | N/A | N/A | Return the current user's messages? |
| $return_system_messages | boolean | No | No | True | N/A | N/A | Return system messages |
Returns
- An array of all the messages collected according to the search criteria
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a multidimensional array of the content of the specified chatroom.It automatically parses for Comcode, chatcode, banned words, emoticons, and uses complex logic to decide whether or not to show each message; based upon who the member is, the message content, and other such inputs.
*
* @param ?AUTO_LINK $room_id The room ID (null: for all IM)
* @param array $_rooms Rooms database rows that we'll need
* @param ?integer $max_messages The maximum number of messages to be returned (null: no maximum)
* @param boolean $dereference Whether to dereference the returned messages (i.e. lookup the content language strings)
* @param boolean $downloading Whether to return the messages in a downloadable format (using the templates for log downloading)
* @param ?integer $start The datetime stamp to start gathering messages from (null: all)
* @param ?integer $finish The datetime stamp to stop gathering messages at (null: current time)
* @param ?integer $uptoid The lowest message ID to return (null: no special lowest number)
* @param ?ID_TEXT $zone The zone the chat module is in (null: find it)
* @param ?mixed $entering_room The content language string ID for the "entering room" message (null: not entering the room)
* @param boolean $return_my_messages Return the current user's messages?
* @param boolean $return_system_messages Return system messages
* @return array An array of all the messages collected according to the search criteria
*/
function chat_get_room_content(?int $room_id, array $_rooms, ?int $max_messages = null, bool $dereference = false, bool $downloading = false, ?int $start = null, ?int $finish = null, ?int $uptoid = null, ?string $zone = null, $entering_room = null, bool $return_my_messages = true, bool $return_system_messages = true) : array
* Get a multidimensional array of the content of the specified chatroom.It automatically parses for Comcode, chatcode, banned words, emoticons, and uses complex logic to decide whether or not to show each message; based upon who the member is, the message content, and other such inputs.
*
* @param ?AUTO_LINK $room_id The room ID (null: for all IM)
* @param array $_rooms Rooms database rows that we'll need
* @param ?integer $max_messages The maximum number of messages to be returned (null: no maximum)
* @param boolean $dereference Whether to dereference the returned messages (i.e. lookup the content language strings)
* @param boolean $downloading Whether to return the messages in a downloadable format (using the templates for log downloading)
* @param ?integer $start The datetime stamp to start gathering messages from (null: all)
* @param ?integer $finish The datetime stamp to stop gathering messages at (null: current time)
* @param ?integer $uptoid The lowest message ID to return (null: no special lowest number)
* @param ?ID_TEXT $zone The zone the chat module is in (null: find it)
* @param ?mixed $entering_room The content language string ID for the "entering room" message (null: not entering the room)
* @param boolean $return_my_messages Return the current user's messages?
* @param boolean $return_system_messages Return system messages
* @return array An array of all the messages collected according to the search criteria
*/
function chat_get_room_content(?int $room_id, array $_rooms, ?int $max_messages = null, bool $dereference = false, bool $downloading = false, ?int $start = null, ?int $finish = null, ?int $uptoid = null, ?string $zone = null, $entering_room = null, bool $return_my_messages = true, bool $return_system_messages = true) : array
