ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilCloudPluginConfig Class Reference

Class ilCloudPluginConfig. More...

+ 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 32 of file class.ilCloudPluginConfig.php.

33 {
34 $this->table_name = $table_name;
35 }

References $table_name.

Member Function Documentation

◆ __call()

ilCloudPluginConfig::__call (   $method,
  $params 
)
Parameters
$method
$params
Returns
bool|null

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

59 {
60 $index = substr($method,3);
61 if (substr($method, 0, 3) == 'get')
62 {
63 if (!isset($this->cache[$index]))
64 {
65 $this->cache[$index] = $this->getValue(self::_fromCamelCase(substr($method, 3)));
66 }
67 if ($this->cache[$index] == null)
68 {
69 $this->cache[$index] = false;
70 }
71
72 return $this->cache[$index];
73 } else if (substr($method, 0, 3) == 'set')
74 {
75 $this->cache[$index] = $params[0];
76 $this->setValue(self::_fromCamelCase(substr($method, 3)), $params[0]);
77 return true;
78 } else
79 {
81 }
82
83 }
Class ilCloudPluginConfigException.
$params
Definition: example_049.php:96

References $params, 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 169 of file class.ilCloudPluginConfig.php.

170 {
171 $str[0] = strtolower($str[0]);
172 $func = create_function('$c', 'return "_" . strtolower($c[1]);');
173 return preg_replace_callback('/([A-Z])/', $func, $str);
174 }

◆ _toCamelCase()

static ilCloudPluginConfig::_toCamelCase (   $str,
  $capitalise_first_char = false 
)
static
Parameters
string$str
bool$capitalise_first_char
Returns
string

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

182 {
183 if ($capitalise_first_char)
184 {
185 $str[0] = strtoupper($str[0]);
186 }
187 $func = create_function('$c', 'return strtoupper($c[1]);');
188 return preg_replace_callback('/-([a-z])/', $func, $str);
189 }

◆ getTableName()

ilCloudPluginConfig::getTableName ( )
Returns
string

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

49 {
50 return $this->table_name;
51 }

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 113 of file class.ilCloudPluginConfig.php.

114 {
115 global $ilDB;
116
117
118 if (!$this->tableExists($this->table_name))
119 {
121 }
122
123 $result = $ilDB->query("SELECT config_value FROM ". $this->table_name ." WHERE config_key = " . $ilDB->quote($key, "text"));
124
125 if ($result->numRows() == 0)
126 {
127 return false;
128 }
129 $record = $ilDB->fetchAssoc($result);
130 return (string)$record['config_value'];
131 }
$result
global $ilDB

References $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 138 of file class.ilCloudPluginConfig.php.

139 {
140 global $ilDB;
141
142 if (!$ilDB->tableExists($this->getTableName()))
143 {
144 $fields = array(
145 'config_key' => array(
146 'type' => 'text',
147 'length' => 128,
148 'notnull' => true),
149 'config_value' => array(
150 'type' => 'clob',
151 'notnull' => false),);
152 $ilDB->createTable($this->getTableName(), $fields);
153 $ilDB->addPrimaryKey($this->getTableName(), array("config_key"));
154 }
155
156 return true;
157 }

References $ilDB, and getTableName().

+ Here is the call graph for this function:

◆ setTableName()

ilCloudPluginConfig::setTableName (   $table_name)
Parameters
string$table_name

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

41 {
42 $this->table_name = $table_name;
43 }

References $table_name.

◆ setValue()

ilCloudPluginConfig::setValue (   $key,
  $value 
)
Parameters
$key
$value

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

90 {
91 global $ilDB;
92
93 if(!$ilDB->tableExists($this->table_name))
94 {
96 }
97
98 if (!is_string($this->getValue($key)))
99 {
100 $ilDB->insert($this->table_name, array("config_key" => array("text", $key), "config_value" => array("text", $value)));
101 }
102
103 else
104 {
105 $ilDB->update($this->table_name, array("config_key" => array("text", $key), "config_value" => array("text", $value)), array("config_key" => array("text", $key)));
106 }
107 }

References $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 191 of file class.ilCloudPluginConfig.php.

192 {
193 global $ilDB;
194 $result = $ilDB->query("show tables like '".$this->getTableName()."'");
195
196 if ($result->numRows() == 0)
197 {
198 return false;
199 }
200 else return true;
201 }

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

Referenced by getValue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $cache

ilCloudPluginConfig::$cache = array()
protected

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

◆ $table_name

ilCloudPluginConfig::$table_name = ""
protected

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

Referenced by __construct(), getTableName(), and setTableName().


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