Inheritance diagram for ilChatroomXMLParser:

Collaboration diagram for ilChatroomXMLParser:

Public Member Functions
	__construct ($chat, $a_xml_data)
	Constructor. More...

	setImportInstallId ($id)

	getImportInstallId ()

	setHandlers ($a_xml_parser)

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)

	handlerEndTag ($a_xml_parser, $a_name)

	handlerCharacterData ($a_xml_parser, $a_data)

Public Member Functions inherited from ilSaxParser
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object public. More...

	setXMLContent ($a_xml_content)

	getXMLContent ()

	getInputType ()

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

	createParser ()
	create parser More...

	setOptions ($a_xml_parser)
	set parser options More...

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...

	openXMLFile ()
	open xml file More...

	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...

	freeParser ($a_xml_parser)
	free xml parser handle More...

	setThrowException ($throwException)
	set error handling More...

Public Member Functions inherited from PEAR
	__construct ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Protected Attributes
	$chat

	$room

	$import_install_id = null

	$cdata = ''

	$in_sub_rooms = false

	$in_messages = false

	$exportRoomId = 0

	$userIds = array()

	$exportSubRoomId = 0

	$owner = 0

	$closed = 0

	$public = 0

	$timestamp = 0

	$message = ''

	$title = ''

	$subRoomIdMapping = array()

Private Member Functions
	isSameInstallation ()

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static &	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

Data Fields inherited from ilSaxParser
	$input_type = null

	$xml_content = ''

	$ilias

	$lng

	$xml_file

	$throwException = false

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Detailed Description

Class ilChatroomXMLParser.

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

Constructor & Destructor Documentation

◆ __construct()

ilChatroomXMLParser::__construct	(	$chat,
		$a_xml_data
	)

Constructor.

Parameters

ilObjChatroom	$chat
string	$a_xml_data

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

References $chat, ilChatroom\byObjectId(), and ilSaxParser\setXMLContent().

     {
         parent::__construct();
 
         $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());
             $this->room->save();
         }
 
         $this->setXMLContent('<?xml version="1.0" encoding="utf-8"?>' . $a_xml_data);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getImportInstallId()

ilChatroomXMLParser::getImportInstallId ( )

Returns: int|null

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

References $import_install_id.

Referenced by isSameInstallation().

     {
         return $this->import_install_id;
     }

Here is the caller graph for this function:

◆ handlerBeginTag()

ilChatroomXMLParser::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

Parameters

$a_xml_parser
$a_name
$a_attribs

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

     {
         switch ($a_name) {
             case 'SubRooms':
                 $this->in_sub_rooms = true;
                 break;
 
             case 'Messages':
                 $this->in_messages = true;
                 break;
         }
     }

◆ handlerCharacterData()

ilChatroomXMLParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

Parameters

$a_xml_parser
$a_data

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

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

◆ handlerEndTag()

ilChatroomXMLParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

Parameters

$a_xml_parser
$a_name

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

References $cdata, $exportRoomId, $exportSubRoomId, $message, $timestamp, $user, and isSameInstallation().

     {
         $this->cdata = trim($this->cdata);
 
         switch ($a_name) {
             case 'Title':
                 if ($this->in_sub_rooms) {
                     $this->title = $this->cdata;
                 } else {
                     $this->chat->setTitle($this->cdata);
                 }
                 break;
 
             case 'Description':
                 $this->chat->setDescription($this->cdata);
                 break;
 
             case 'OnlineStatus':
                 $this->room->setSetting('online_status', (int) $this->cdata);
                 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 'RestrictHistory':
                 $this->room->setSetting('restrict_history', (int) $this->cdata);
                 break;
 
             case 'PrivateRoomsEnabled':
                 $this->room->setSetting('private_rooms_enabled', (int) $this->cdata);
                 break;
 
             case 'DisplayPastMessages':
                 $this->room->setSetting('display_past_msgs', (int) $this->cdata);
                 break;
 
             case 'AutoGeneratedUsernameSchema':
                 $this->room->setSetting('autogen_usernames', $this->cdata);
                 break;
 
             case 'RoomId':
                 $this->exportRoomId = (int) $this->cdata;
                 break;
                 
             case 'SubRoomId':
                 $this->exportSubRoomId = (int) $this->cdata;
                 break;
 
             case 'Owner':
                 $this->owner = (int) $this->cdata;
                 break;
 
             case 'Closed':
                 $this->closed = (int) $this->cdata;
                 break;
 
             case 'Public':
                 $this->public = (int) $this->cdata;
                 break;
 
             case 'CreatedTimestamp':
                 $this->timestamp = (int) $this->cdata;
                 break;
                 
             case 'PrivilegedUserId':
                 $this->userIds[] = (int) $this->cdata;
                 break;
 
             case 'SubRoom':
                 if ($this->isSameInstallation() && $this->exportRoomId > 0) {
                     $user = new ilObjUser();
                     $user->setId($this->owner);
 
                     $chat_user = new ilChatroomUser($user, $this->room);
                     $subRoomId = $this->room->addPrivateRoom(
                         $this->title,
                         $chat_user,
                         array(
                             'public' => (bool) $this->public,
                             'created' => (int) $this->timestamp,
                             'closed' => (bool) $this->closed
                         )
                     );
 
                     foreach ($this->userIds as $userId) {
                         $this->room->inviteUserToPrivateRoom($userId, $subRoomId);
                     }
 
                     $this->subRoomIdMapping[$this->exportRoomId] = $subRoomId;
                 }
 
                 $this->exportSubRoomId = 0;
                 $this->title = '';
                 $this->owner = 0;
                 $this->closed = 0;
                 $this->public = 0;
                 $this->timestamp = 0;
                 $this->userIds = array();
                 break;
 
             case 'SubRooms':
                 $this->in_sub_rooms = false;
                 break;
 
             case 'Body':
                 $this->message = $this->cdata;
                 break;
 
             case 'Message':
                 if ($this->isSameInstallation()) {
                     $message = json_decode($this->message, true);
                     if (
                         is_array($message) &&
                         (!$this->exportSubRoomId || array_key_exists($this->exportSubRoomId, $this->subRoomIdMapping))
                     ) {
                         $message['roomId'] = $this->room->getRoomId();
                         $message['subRoomId'] = $this->exportSubRoomId ? $this->subRoomIdMapping[$this->exportSubRoomId] : 0;
                         $message['timestamp'] = $this->timestamp;
 
                         $this->room->addHistoryEntry($message);
                     }
                 }
 
                 $this->timestamp = 0;
                 $this->exportSubRoomId = 0;
                 break;
 
             case 'Messages':
                 $this->in_messages = false;
                 break;
 
             case 'Chatroom':
                 $this->chat->update();
                 // Set imported chats to offline
                 $this->room->setSetting('online_status', 0);
                 $this->room->save();
                 break;
         }
 
         $this->cdata = '';
     }

Here is the call graph for this function:

◆ isSameInstallation()

ilChatroomXMLParser::isSameInstallation ( )

private

Returns: bool

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

References getImportInstallId().

Referenced by handlerEndTag().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilChatroomXMLParser::setHandlers ( $a_xml_parser )

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

     {
         xml_set_object($a_xml_parser, $this);
         xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
         xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
     }

◆ setImportInstallId()

ilChatroomXMLParser::setImportInstallId ( $id )

Parameters

int | null $id

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

References $id.

     {
         $this->import_install_id = $id;
     }

Field Documentation

◆ $cdata

ilChatroomXMLParser::$cdata = ''

protected

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

Referenced by handlerEndTag().

◆ $chat

ilChatroomXMLParser::$chat

protected

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

Referenced by __construct().

◆ $closed

ilChatroomXMLParser::$closed = 0

protected

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

◆ $exportRoomId

ilChatroomXMLParser::$exportRoomId = 0

protected

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

Referenced by handlerEndTag().

◆ $exportSubRoomId

ilChatroomXMLParser::$exportSubRoomId = 0

protected

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

Referenced by handlerEndTag().

◆ $import_install_id

ilChatroomXMLParser::$import_install_id = null

protected

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

Referenced by getImportInstallId().

◆ $in_messages

ilChatroomXMLParser::$in_messages = false

protected

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

◆ $in_sub_rooms

ilChatroomXMLParser::$in_sub_rooms = false

protected

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

◆ $message

ilChatroomXMLParser::$message = ''

protected

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

Referenced by handlerEndTag().

◆ $owner

ilChatroomXMLParser::$owner = 0

protected

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

◆ $public

ilChatroomXMLParser::$public = 0

protected

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

◆ $room

ilChatroomXMLParser::$room

protected

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

◆ $subRoomIdMapping

ilChatroomXMLParser::$subRoomIdMapping = array()

protected

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

◆ $timestamp

ilChatroomXMLParser::$timestamp = 0

protected

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

Referenced by handlerEndTag().

◆ $title

ilChatroomXMLParser::$title = ''

protected

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

◆ $userIds

ilChatroomXMLParser::$userIds = array()

protected

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

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

Modules/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

◆ $chat

◆ $closed

◆ $exportRoomId

◆ $exportSubRoomId

◆ $import_install_id

◆ $in_messages

◆ $in_sub_rooms

◆ $message

◆ $owner

◆ $public

◆ $room

◆ $subRoomIdMapping

◆ $timestamp

◆ $title

◆ $userIds