ilChatroomXMLWriter Class Reference

Class ilChatroomXMLWriter. More...

Inheritance diagram for ilChatroomXMLWriter:

Collaboration diagram for ilChatroomXMLWriter:

Public Member Functions
	__construct (ilObjChatroom $chat)
	start ()
	getXML ()
Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")
	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...
	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...
	xmlFormatData (string $data)
	Indents text for better reading. More...
	xmlHeader ()
	Writes xml header. More...
	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...
	xmlEndTag (string $tag)
	Writes an endtag. More...
	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...
	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...
	appendXML (string $a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr More...

Protected Attributes
ilObjChatroom	$chat
ilChatroom	$room

Private Member Functions
	exportData ()

Detailed Description

Class ilChatroomXMLWriter.

Definition at line 24 of file class.ilChatroomXMLWriter.php.

Constructor & Destructor Documentation

__construct()

ilChatroomXMLWriter::__construct

(

ilObjChatroom

$chat

)

Definition at line 29 of file class.ilChatroomXMLWriter.php.

References $chat, ILIAS\GlobalScreen\Provider\__construct(), and ilChatroom\byObjectId().

    {
        $this->chat = $chat;

        $this->room = ilChatroom::byObjectId($this->chat->getId());
        if (!$this->room) {
            $this->room = new ilChatroom();
            $this->room->setSetting('object_id', $this->chat->getId());
        }

        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

exportData()

ilChatroomXMLWriter::exportData ( )

private

Definition at line 66 of file class.ilChatroomXMLWriter.php.

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                 : void
    {
        $privateRooms = $this->room->getPrivateRooms();
        if (count($privateRooms) > 0) {
            $this->xmlStartTag('SubRooms');
            foreach ($privateRooms as $privateRoom) {
                $this->xmlStartTag('SubRoom');
                $this->xmlElement('SubRoomId', null, (string) ((int) $privateRoom['proom_id']));
                $this->xmlElement('Title', null, (string) $privateRoom['title']);
                $this->xmlElement('Owner', null, (string) ((int) $privateRoom['owner']));
                $this->xmlElement('Closed', null, (string) ((int) $privateRoom['closed']));
                $this->xmlElement('Public', null, (string) ((int) $privateRoom['is_public']));
                $this->xmlElement('CreatedTimestamp', null, (string) ((int) $privateRoom['created']));

                foreach ($this->room->getPrivilegedUsersForPrivateRoom((int) $privateRoom['proom_id']) as $usrId) {
                    $this->xmlElement('PrivilegedUserId', null, (string) $usrId);
                }

                $this->xmlEndTag('SubRoom');
            }
            $this->xmlEndTag('SubRooms');
        }

        $history = $this->room->getHistory(null, null, null, null, false);
        if (count($history) > 0) {
            $this->xmlStartTag('Messages');
            foreach ($history as $entry) {
                $this->xmlStartTag('Message');
                $this->xmlElement('SubRoomId', null, (string) ((int) $entry['sub_room']));
                $this->xmlElement('Body', null, json_encode($entry['message'], JSON_THROW_ON_ERROR));
                $this->xmlElement('CreatedTimestamp', null, (string) ((int) $entry['timestamp']));
                $this->xmlEndTag('Message');
            }
            $this->xmlEndTag('Messages');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getXML()

ilChatroomXMLWriter::getXML

(

)

Definition at line 103 of file class.ilChatroomXMLWriter.php.

References ilXmlWriter\xmlDumpMem().

                            : string
    {
        // Replace ascii code 11 characters because of problems with xml sax parser
        return str_replace('', '', $this->xmlDumpMem(false));
    }

Here is the call graph for this function:

start()

ilChatroomXMLWriter::start

(

)

Definition at line 42 of file class.ilChatroomXMLWriter.php.

References exportData(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                           : void
    {
        $this->xmlStartTag('Chatroom');

        $this->xmlElement('ObjId', null, (string) $this->chat->getId());
        $this->xmlElement('RoomId', null, (string) $this->room->getRoomId());
        $this->xmlElement('Title', null, $this->chat->getTitle());
        $this->xmlElement('Description', null, $this->chat->getDescription());
        $this->xmlElement('OnlineStatus', null, (string) ((int) $this->room->getSetting('online_status')));
        $this->xmlElement('AllowAnonymousAccess', null, (string) ((int) $this->room->getSetting('allow_anonymous')));
        $this->xmlElement('AllowCustomUsernames', null, (string) ((int) $this->room->getSetting('allow_custom_usernames')));
        $this->xmlElement('EnableHistory', null, (string) ((int) $this->room->getSetting('enable_history')));
        $this->xmlElement('RestrictHistory', null, (string) ((int) $this->room->getSetting('restrict_history')));
        $this->xmlElement('PrivateRoomsEnabled', null, (string) ((int) $this->room->getSetting('private_rooms_enabled')));
        $this->xmlElement('DisplayPastMessages', null, (string) ((int) $this->room->getSetting('display_past_msgs')));
        $this->xmlElement('AutoGeneratedUsernameSchema', null, (string) $this->room->getSetting('autogen_usernames'));

        if ($this->room->getRoomId() > 0) {
            $this->exportData();
        }

        $this->xmlEndTag('Chatroom');
    }

Here is the call graph for this function:

Field Documentation

$chat

ilObjChatroom ilChatroomXMLWriter::$chat

protected

Definition at line 26 of file class.ilChatroomXMLWriter.php.

Referenced by __construct().

$room

ilChatroom ilChatroomXMLWriter::$room

protected

Definition at line 27 of file class.ilChatroomXMLWriter.php.

---

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

• Modules/Chatroom/classes/class.ilChatroomXMLWriter.php