Collaboration diagram for ilCloudPluginConfig:

Public Member Functions
	__construct ($table_name)

	setTableName ($table_name)

	getTableName ()

	__call ($method, $params)

	setValue ($key, $value)

	getValue ($key)

	initDB ()

	tableExists ()

Static Public Member Functions
static	_fromCamelCase ($str)

static	_toCamelCase ($str, $capitalise_first_char=false)

Protected Attributes
	$table_name = ""

	$cache = array()

Detailed Description

Class ilCloudPluginConfig.

Model class for the administration settings. Note the use of the __call Function. The value max_file_size could be for example set by the method setMaxFileSize without the declaring this method. Similarly it could be get by getMaxFileSize

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch; fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id$

Definition at line 17 of file class.ilCloudPluginConfig.php.

Constructor & Destructor Documentation

◆ __construct()

ilCloudPluginConfig::__construct ( $table_name )

Parameters

$table_name

Definition at line 33 of file class.ilCloudPluginConfig.php.

    {
        $this->table_name = $table_name;
    }

References $table_name.

Member Function Documentation

◆ __call()

ilCloudPluginConfig::__call	(	$method,
		$params
	)

Parameters

$method
$params

Returns: bool|null

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

    {
        $index = substr($method, 3);
        if (substr($method, 0, 3) == 'get') {
            if (!isset($this->cache[$index])) {
                $this->cache[$index] = $this->getValue(self::_fromCamelCase(substr($method, 3)));
            }
            if ($this->cache[$index] == null) {
                $this->cache[$index] = false;
            }
 
            return $this->cache[$index];
        } else {
            if (substr($method, 0, 3) == 'set') {
                $this->cache[$index] = $params[0];
                $this->setValue(self::_fromCamelCase(substr($method, 3)), $params[0]);
 
                return true;
            } else {
                throw new ilCloudPluginConfigException(ilCloudPluginConfigException::NO_VALID_GET_OR_SET_FUNCTION, $method);
            }
        }
    }

References $index, getValue(), ilCloudPluginConfigException\NO_VALID_GET_OR_SET_FUNCTION, and setValue().

Here is the call graph for this function:

◆ _fromCamelCase()

static ilCloudPluginConfig::_fromCamelCase ( $str )

static

Parameters

string $str

Returns: string

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

    {
        $str[0] = strtolower($str[0]);
 
        return preg_replace_callback('/([A-Z])/', function ($c) {
            return "_" . strtolower($c[1]);
        }, $str);
    }

References Vendor\Package\$c.

◆ _toCamelCase()

static ilCloudPluginConfig::_toCamelCase	(	$str,
		$capitalise_first_char = `false`
	)

static

Parameters

string	$str
bool	$capitalise_first_char

Returns: string

Definition at line 187 of file class.ilCloudPluginConfig.php.

    {
        if ($capitalise_first_char) {
            $str[0] = strtoupper($str[0]);
        }
 
        return preg_replace_callback('/-([a-z])/', function ($c) {
            return strtoupper($c[1]);
        }, $str);
    }

References Vendor\Package\$c.

◆ getTableName()

ilCloudPluginConfig::getTableName ( )

Returns: string

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

    {
        return $this->table_name;
    }

References $table_name.

Referenced by initDB(), and tableExists().

Here is the caller graph for this function:

◆ getValue()

ilCloudPluginConfig::getValue ( $key )

Parameters

$key

Returns: bool|string

Definition at line 114 of file class.ilCloudPluginConfig.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        if (!$this->tableExists($this->table_name)) {
            throw new ilCloudPluginConfigException(ilCloudPluginConfigException::TABLE_DOES_NOT_EXIST, $this->table_name);
        }
 
        $result = $ilDB->query("SELECT config_value FROM " . $this->table_name . " WHERE config_key = " . $ilDB->quote($key, "text"));
 
        if ($result->numRows() == 0) {
            return false;
        }
        $record = $ilDB->fetchAssoc($result);
 
        return (string) $record['config_value'];
    }

References $DIC, $ilDB, $result, ilCloudPluginConfigException\TABLE_DOES_NOT_EXIST, and tableExists().

Referenced by __call(), and setValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initDB()

ilCloudPluginConfig::initDB ( )

Returns: bool

Definition at line 137 of file class.ilCloudPluginConfig.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        if (!$ilDB->tableExists($this->getTableName())) {
            $fields = array(
                'config_key' => array(
                    'type' => 'text',
                    'length' => 128,
                    'notnull' => true,
                ),
                'config_value' => array(
                    'type' => 'clob',
                    'notnull' => false,
                ),
            );
            $ilDB->createTable($this->getTableName(), $fields);
            $ilDB->addPrimaryKey($this->getTableName(), array("config_key"));
        }
 
        return true;
    }

References $DIC, $ilDB, and getTableName().

Here is the call graph for this function:

◆ setTableName()

ilCloudPluginConfig::setTableName ( $table_name )

Parameters

string $table_name

Definition at line 42 of file class.ilCloudPluginConfig.php.

    {
        $this->table_name = $table_name;
    }

References $table_name.

◆ setValue()

ilCloudPluginConfig::setValue	(	$key,
		$value
	)

Parameters

$key
$value

Definition at line 92 of file class.ilCloudPluginConfig.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        if (!$ilDB->tableExists($this->table_name)) {
            throw new ilCloudPluginConfigException(ilCloudPluginConfigException::TABLE_DOES_NOT_EXIST, $this->table_name);
        }
 
        if (!is_string($this->getValue($key))) {
            $ilDB->insert($this->table_name, array("config_key" => array("text", $key), "config_value" => array("text", $value)));
        } else {
            $ilDB->update($this->table_name, array("config_key" => array("text", $key), "config_value" => array("text", $value)), array("config_key" => array("text", $key)));
        }
    }

References $DIC, $ilDB, getValue(), and ilCloudPluginConfigException\TABLE_DOES_NOT_EXIST.

Referenced by __call().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tableExists()

ilCloudPluginConfig::tableExists ( )

Definition at line 199 of file class.ilCloudPluginConfig.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $result = $ilDB->query("show tables like '" . $this->getTableName() . "'");
 
        if ($result->numRows() == 0) {
            return false;
        } else {
            return true;
        }
    }