ilChatroomConfigFileHandler Class Reference

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...

Protected Member Functions
	getClientFileContent (array $settings)
	Get the client config file content as json encoded string. More...
	writeDataToFile (string $content, string $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...

Private Attributes
const	CHATROOM_DATA_DIR = '/chatroom/'
const	CHATROOM_CLIENT_CONFIG_FILENAME = 'client.cfg'
const	CHATROOM_SERVER_CONFIG_FILENAME = 'server.cfg'

Detailed Description

Definition at line 28 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 39 of file class.ilChatroomConfigFileHandler.php.

References getClientFileContent(), and writeDataToFile().

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

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

RuntimeException

Throws Exception if data dir creation failed

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

References $path, ilFileUtils\getDataDir(), and ilFileUtils\makeDir().

Referenced by writeDataToFile().

                                                 : string
    {
        $path = ilFileUtils::getDataDir() . self::CHATROOM_DATA_DIR;

        if (!is_dir($path) && !ilFileUtils::makeDir($path)) {
            throw new RuntimeException('Directory cannot be created');
        }

        return $path;
    }

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 117 of file class.ilChatroomConfigFileHandler.php.

References getServerFileContent(), and writeDataToFile().

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

Here is the call graph for this function:

getClientFileContent()

ilChatroomConfigFileHandler::getClientFileContent ( array  $settings )

protected

Get the client config file content as json encoded string.

Parameters

array

$settings

Returns

string

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

References $DIC, $type, ILIAS\Repository\int(), ilDBConstants\TYPE_INNODB, and ilDBConstants\TYPE_MYSQL.

Referenced by createClientConfigFile().

                                                            : string
    {
        global $DIC;

        // Dirty configuration swap: Ilias differentiates between InnoDB and MyISAM.
        // MyISAM is configured as mysql, InnoDB as innodb.
        // The client config file only needs information about driver not engine
        $type = $DIC['ilClientIniFile']->readVariable('db', 'type');
        if (in_array($type, [
            ilDBConstants::TYPE_MYSQL,
            ilDBConstants::TYPE_INNODB,
            ''
        ], true)) {
            $type = 'mysql';
        }

        $settings['database'] = [
            'type' => $type,
            'host' => $DIC['ilClientIniFile']->readVariable('db', 'host'),
            'port' => (int) $DIC['ilClientIniFile']->readVariable('db', 'port'),
            'name' => $DIC['ilClientIniFile']->readVariable('db', 'name'),
            'user' => $DIC['ilClientIniFile']->readVariable('db', 'user'),
            'pass' => $DIC['ilClientIniFile']->readVariable('db', 'pass')
        ];

        return json_encode($settings, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT);
    }

Here is the call graph for this function:

Here is the caller 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 128 of file class.ilChatroomConfigFileHandler.php.

Referenced by createServerConfigFile().

                                                            : string
    {
        unset($settings['ilias_proxy'], $settings['client_proxy'], $settings['ilias_url'], $settings['client_url']);

        return json_encode($settings, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT);
    }

Here is the caller graph for this function:

writeDataToFile()

ilChatroomConfigFileHandler::writeDataToFile ( string  $content, string  $filename  )

protected

Writes $content to file named by $filename.

Parameters

string	$content
string	$filename

Exceptions

RuntimeException

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

References $path, and createDataDirIfNotExists().

Referenced by createClientConfigFile(), and createServerConfigFile().

                                                                         : void
    {
        $path = $this->createDataDirIfNotExists();
        $handle = fopen($path . $filename, 'wb');

        if (!fwrite($handle, $content)) {
            throw new RuntimeException('Cannot write to file');
        }

        fclose($handle);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

CHATROOM_CLIENT_CONFIG_FILENAME

const ilChatroomConfigFileHandler::CHATROOM_CLIENT_CONFIG_FILENAME = 'client.cfg'

private

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

CHATROOM_DATA_DIR

const ilChatroomConfigFileHandler::CHATROOM_DATA_DIR = '/chatroom/'

private

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

CHATROOM_SERVER_CONFIG_FILENAME

const ilChatroomConfigFileHandler::CHATROOM_SERVER_CONFIG_FILENAME = 'server.cfg'

private

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

---

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

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