Inheritance diagram for ilChatroomXMLParser:

Collaboration diagram for ilChatroomXMLParser:

Public Member Functions
	__construct (protected ilObjChatroom $chat, string $a_xml_data)

	setImportInstallId (?string $id)

	getImportInstallId ()

	setHandlers ($a_xml_parser)

	handlerBeginTag (XMLParser $a_xml_parser, string $a_name, array $a_attribs)

	handlerEndTag (XMLParser $a_xml_parser, string $a_name)

	handlerCharacterData (XMLParser $a_xml_parser, string $a_data)

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

Protected Attributes
ilChatroom	$room

string	$cdata = ''

bool	$in_messages = false

string	$import_install_id = null

int	$exportRoomId = 0

int	$timestamp = 0

string	$message = ''

string	$title = ''

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Member Functions
	isSameInstallation ()

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Detailed Description

Definition at line 21 of file class.ilChatroomXMLParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomXMLParser::__construct	(	protected ilObjChatroom	$chat,
		string	$a_xml_data
	)

Definition at line 32 of file class.ilChatroomXMLParser.php.

    {
        parent::__construct();
 
        $room = ilChatroom::byObjectId($this->chat->getId());
        if ($room !== null) {
            $this->room = $room;
        } else {
            $this->room = new ilChatroom();
            $this->room->setSetting('object_id', $this->chat->getId());
            $this->room->save();
        }
 
        $this->setXMLContent('<?xml version="1.0" encoding="utf-8"?>' . $a_xml_data);
    }

References $room, ILIAS\GlobalScreen\Provider\__construct(), ilChatroom\byObjectId(), and ilSaxParser\setXMLContent().

Here is the call graph for this function:

Member Function Documentation

◆ getImportInstallId()

ilChatroomXMLParser::getImportInstallId ( )

Definition at line 53 of file class.ilChatroomXMLParser.php.

                                        : ?string
    {
        return $this->import_install_id;
    }

References $import_install_id.

Referenced by isSameInstallation().

Here is the caller graph for this function:

◆ handlerBeginTag()

ilChatroomXMLParser::handlerBeginTag	(	XMLParser	$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

Parameters

array<string,string> $a_attribs

Definition at line 72 of file class.ilChatroomXMLParser.php.

                                                                                              : void
    {
        switch ($a_name) {
            case 'Body':
                $this->timestamp = null;
                $this->message = null;
                break;
 
            case 'Messages':
                $this->in_messages = true;
                break;
        }
    }

Referenced by setHandlers().

Here is the caller graph for this function:

◆ handlerCharacterData()

ilChatroomXMLParser::handlerCharacterData	(	XMLParser	$a_xml_parser,
		string	$a_data
	)

Definition at line 164 of file class.ilChatroomXMLParser.php.

                                                                                 : void
    {
        if ($a_data !== "\n") {
            $this->cdata .= preg_replace("/\t+/", ' ', $a_data);
        }
    }

Referenced by setHandlers().

Here is the caller graph for this function:

◆ handlerEndTag()

ilChatroomXMLParser::handlerEndTag	(	XMLParser	$a_xml_parser,
		string	$a_name
	)

Definition at line 86 of file class.ilChatroomXMLParser.php.

                                                                          : void
    {
        $this->cdata = trim($this->cdata);
 
        switch ($a_name) {
            case 'Title':
                $this->chat->setTitle(ilUtil::stripSlashes($this->cdata));
                break;
 
            case 'Description':
                $this->chat->setDescription(ilUtil::stripSlashes($this->cdata));
                break;
 
            case 'OnlineStatus':
                $this->chat->setOfflineStatus(
                    ((int) $this->cdata) === 0
                );
                break;
 
            case 'AllowAnonymousAccess':
                $this->room->setSetting('allow_anonymous', (int) $this->cdata);
                break;
 
            case 'AllowCustomUsernames':
                $this->room->setSetting('allow_custom_usernames', (int) $this->cdata);
                break;
 
            case 'EnableHistory':
                $this->room->setSetting('enable_history', (int) $this->cdata);
                break;
 
            case 'DisplayPastMessages':
                $this->room->setSetting('display_past_msgs', (int) $this->cdata);
                break;
 
            case 'AutoGeneratedUsernameSchema':
                $this->room->setSetting('autogen_usernames', ilUtil::stripSlashes($this->cdata));
                break;
 
            case 'RoomId':
                $this->exportRoomId = (int) $this->cdata;
                break;
 
            case 'CreatedTimestamp':
                $this->timestamp = (int) $this->cdata;
                break;
 
            case 'Body':
                $this->message = $this->cdata;
                break;
 
            case 'Message':
                if ($this->isSameInstallation()) {
                    $message = json_decode($this->message, true, 512, JSON_THROW_ON_ERROR);
                    if (is_array($message)) {
                        $message['roomId'] = $this->room->getRoomId();
                        $message['timestamp'] = $this->timestamp;
 
                        $this->room->addHistoryEntry($message);
                    }
                }
                break;
 
            case 'Messages':
                $this->in_messages = false;
                break;
 
            case 'Chatroom':
                // Set imported chats to offline
                $this->chat->setOfflineStatus(true);
                $this->chat->update();
                $this->room->save();
                break;
        }
 
        $this->cdata = '';
    }

References $cdata, $message, $timestamp, ILIAS\Repository\int(), isSameInstallation(), and ilUtil\stripSlashes().

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSameInstallation()

ilChatroomXMLParser::isSameInstallation ( )

private

Definition at line 58 of file class.ilChatroomXMLParser.php.

                                         : bool
    {
        return defined('IL_INST_ID') && IL_INST_ID > 0 && $this->getImportInstallId() == IL_INST_ID;
    }

References getImportInstallId(), and IL_INST_ID.

Referenced by handlerEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilChatroomXMLParser::setHandlers ( $a_xml_parser )

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Reimplemented from ilSaxParser.

Definition at line 63 of file class.ilChatroomXMLParser.php.

                                              : void
    {
        xml_set_element_handler($a_xml_parser, $this->handlerBeginTag(...), $this->handlerEndTag(...));
        xml_set_character_data_handler($a_xml_parser, $this->handlerCharacterData(...));
    }

References handlerBeginTag(), handlerCharacterData(), and handlerEndTag().

Here is the call graph for this function:

◆ setImportInstallId()

ilChatroomXMLParser::setImportInstallId ( ?string $id )

Definition at line 48 of file class.ilChatroomXMLParser.php.

                                                   : void
    {
        $this->import_install_id = $id;
    }

References $id.

Field Documentation

◆ $cdata

string ilChatroomXMLParser::$cdata = ''

protected

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

Referenced by handlerEndTag().

◆ $exportRoomId

int ilChatroomXMLParser::$exportRoomId = 0

protected

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

◆ $import_install_id

string ilChatroomXMLParser::$import_install_id = null

protected

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

Referenced by getImportInstallId().

◆ $in_messages

bool ilChatroomXMLParser::$in_messages = false

protected

Definition at line 25 of file class.ilChatroomXMLParser.php.

◆ $message

string ilChatroomXMLParser::$message = ''

protected

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

Referenced by handlerEndTag().

◆ $room

ilChatroom ilChatroomXMLParser::$room

protected

Definition at line 23 of file class.ilChatroomXMLParser.php.

Referenced by __construct().

◆ $timestamp

int ilChatroomXMLParser::$timestamp = 0

protected

Definition at line 28 of file class.ilChatroomXMLParser.php.

Referenced by handlerEndTag().

◆ $title

string ilChatroomXMLParser::$title = ''

protected

Definition at line 30 of file class.ilChatroomXMLParser.php.

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

components/ILIAS/Chatroom/classes/class.ilChatroomXMLParser.php

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getImportInstallId()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ isSameInstallation()

◆ setHandlers()

◆ setImportInstallId()

Field Documentation

◆ $cdata

◆ $exportRoomId

◆ $import_install_id

◆ $in_messages

◆ $message

◆ $room

◆ $timestamp

◆ $title