ilChatroomXMLWriter Class Reference

Class ilChatroomXMLWriter. More...

Inheritance diagram for ilChatroomXMLWriter:

Collaboration diagram for ilChatroomXMLWriter:

Public Member Functions
	__construct (ilObjChatroom $chat)
	ilChatroomXMLWriter constructor. More...
	start ()
	getXML ()
Public Member Functions inherited from ilXmlWriter
	__construct ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor More...
	_ilXmlWriter ()
	destructor public More...
	xmlSetDtdDef ($dtdDef)
	Sets dtd definition. More...
	xmlSetStSheet ($stSheet)
	Sets stylesheet. More...
	xmlSetGenCmt ($genCmt)
	Sets generated comment. More...
	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding. More...
	xmlFormatData ($data)
	Indents text for better reading. More...
	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly. More...
	xmlHeader ()
	Writes xml header public. More...
	xmlStartTag ($tag, $attrs=null, $empty=false, $encode=true, $escape=true)
	Writes a starttag. More...
	xmlEndTag ($tag)
	Writes an endtag. More...
	xmlComment ($comment)
	Writes a comment. More...
	xmlData ($data, $encode=true, $escape=true)
	Writes data. More...
	xmlElement ($tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile ($file, $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem ($format=true)
	Returns xml document from memory. More...
	appendXML ($a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr public More...

Protected Attributes
	$chat
	$room

Private Member Functions
	exportData ()

Additional Inherited Members
Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...
Data Fields inherited from ilXmlWriter
	$xmlStr
	$version
	$outEnc
	$inEnc
	$dtdDef = ""
	$stSheet = ""
	$genCmt = "Generated by ILIAS XmlWriter"

Detailed Description

Class ilChatroomXMLWriter.

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

Constructor & Destructor Documentation

__construct()

ilChatroomXMLWriter::__construct

(

ilObjChatroom

$chat

)

ilChatroomXMLWriter constructor.

Parameters

ilObjChatroom

$chat

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

References $chat, 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 69 of file class.ilChatroomXMLWriter.php.

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

Referenced by start().

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

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

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

        $history = $this->room->getHistory(null, null, null, null, false);
        if (count($history) > 0) {
            $this->xmlStartTag('Messages', null);
            foreach ($history as $entry) {
                $this->xmlStartTag('Message', null);
                $this->xmlElement('SubRoomId', null, (int) $entry['sub_room']);
                $this->xmlElement('Body', null, json_encode($entry['message']));
                $this->xmlElement('CreatedTimestamp', null, (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

(

)

Returns

string

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

References ilXmlWriter\xmlDumpMem().

    {
        // 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().

    {
        $this->xmlStartTag('Chatroom', null);

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

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

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

Here is the call graph for this function:

Field Documentation

$chat

ilChatroomXMLWriter::$chat

protected

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

Referenced by __construct().

$room

ilChatroomXMLWriter::$room

protected

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

---

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

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