Collaboration diagram for ilChatroomConfigFileHandler:

Public Member Functions
	createClientConfigFile (array $settings)
	Creates a client config file and saves it to the chatroom data directory. More...

	createServerConfigFile (array $settings)
	Creates a server config file and saves it to the chatroom data directory. More...

Data Fields
const	CHATROOM_DATA_DIR = '/chatroom/'

const	CHATROOM_CLIENT_CONFIG_FILENAME = 'client.cfg'

const	CHATROOM_SERVER_CONFIG_FILENAME = 'server.cfg'

Protected Member Functions
	writeDataToFile ($content, $filename)
	Writes $content to file named by $filename. More...

	createDataDirIfNotExists ()
	Creates a data directory for configuration files, if the directory does not already exists. More...

	getServerFileContent (array $settings)
	Get the server config file contetn as json encoded string. More...

Detailed Description

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

Member Function Documentation

◆ createClientConfigFile()

ilChatroomConfigFileHandler::createClientConfigFile ( array $settings )

Creates a client config file and saves it to the chatroom data directory.

Parameters

array $settings

Exceptions

Exception

Definition at line 22 of file class.ilChatroomConfigFileHandler.php.

        {
                $content = $this->getClientFileContent($settings);
                $this->writeDataToFile($content, self::CHATROOM_CLIENT_CONFIG_FILENAME);
        }

References writeDataToFile().

Here is the call graph for this function:

◆ createDataDirIfNotExists()

ilChatroomConfigFileHandler::createDataDirIfNotExists ( )

protected

Creates a data directory for configuration files, if the directory does not already exists.

Returns: string

Exceptions

Exception Throws Exception if data dir creation failed

Definition at line 89 of file class.ilChatroomConfigFileHandler.php.

        {
                $path = ilUtil::getDataDir() . self::CHATROOM_DATA_DIR;
 
                if(!file_exists($path))
                {
                        if(!ilUtil::makeDir($path))
                        {
                                throw new Exception('Directory cannot be created');
                        }
                }
 
                return $path;
        }

References $path, CHATROOM_DATA_DIR, ilUtil\getDataDir(), and ilUtil\makeDir().

Referenced by writeDataToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createServerConfigFile()

ilChatroomConfigFileHandler::createServerConfigFile ( array $settings )

Creates a server config file and saves it to the chatroom data directory.

Parameters

array $settings

Exceptions

Exception

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

        {
                $content = $this->getServerFileContent($settings);
                $this->writeDataToFile($content, self::CHATROOM_SERVER_CONFIG_FILENAME);
        }

References getServerFileContent(), and writeDataToFile().

Here is the call graph for this function:

◆ getServerFileContent()

ilChatroomConfigFileHandler::getServerFileContent ( array $settings )

protected

Get the server config file contetn as json encoded string.

Parameters

array $settings

Returns: string

Definition at line 120 of file class.ilChatroomConfigFileHandler.php.

        {
                unset($settings['ilias_proxy']);
                unset($settings['client_proxy']);
                unset($settings['ilias_url']);
                unset($settings['client_url']);
 
                return json_encode($settings, JSON_PRETTY_PRINT);
        }

Referenced by createServerConfigFile().

Here is the caller graph for this function:

◆ writeDataToFile()

ilChatroomConfigFileHandler::writeDataToFile	(	$content,
		$filename
	)

protected

Writes $content to file named by $filename.

Parameters

string	$content
string	$filename

Exceptions

Exception

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

        {
                $path   = $this->createDataDirIfNotExists();
                $handle = fopen($path . $filename, 'w');
 
                if(!fwrite($handle, $content))
                {
                        throw new Exception('Cannot write to file');
                }
 
                fclose($handle);
        }