Class ConfigurationModel

Description

ConfigurationModel class

Located in /inc/model/ConfigurationModel.php (line 21)


        
                    
Method Summary
 getAdminAction (string $lang) Array
 getAdminConfigStringAction (string $key) string
 getBackendLanguageStringAction (string $key) Value
 getConfigStringAction (string $key) string
 getGlobalsAction () Array
 getLoginInfoAction () Simple
 setAdminAction ( $admin, array $globals) Result
 setGlobalsAction (array $globals) void
 setTemplateAction (string $newTemplate) Result
Methods
static getConfigurationModel (line 280)

Singleton-create-method

  • return: Single instance of ConfigurationModel
  • access: public
ConfigurationModel getConfigurationModel ()
getAdminAction (line 421)

This method returns an ordered array with all admin settings

  • return: with all admin settings
  • throws: CaramelException
  • access: public
Array getAdminAction (string $lang)
  • string $lang: Language to fetch options for
getAdminConfigStringAction (line 544)

Wrapper for getAdminConfigString

  • return: Value for given key
  • see: getAdminConfigString
  • throws: CaramelException
  • access: public
string getAdminConfigStringAction (string $key)
  • string $key: Key to lookup in config-file
getBackendLanguageStringAction (line 562)

Wrapper for getBackendLanguagestring

  • return: for given key
  • see: getBackendLanguagestring
  • throws: CaramelException
  • access: public
Value getBackendLanguageStringAction (string $key)
  • string $key: Key to lookup in config-file
getConfigStringAction (line 526)

Wrapper for getConfigString

  • return: Value for given key
  • see: getConfigString
  • throws: CaramelException
  • access: public
string getConfigStringAction (string $key)
  • string $key: Key to lookup in config-file
getGlobalsAction (line 306)

This method returns an ordered array with all global settings

  • return: with all global settings
  • access: public
Array getGlobalsAction ()
getLoginInfoAction (line 399)

Method to return the base admin login information

  • return: array with admin login info to check while logging in
  • throws: CaramelException
  • access: public
Simple getLoginInfoAction ()
getTemplateAction (line 490)

Method to get current active template

  • return: current template set in template settings
  • throws: CaramelException
  • access: public
The getTemplateAction ()
setAdminAction (line 461)

Method to save admin config

  • return: of file_put_contents
  • throws: CaramelException
  • access: public
Result setAdminAction ( $admin, array $globals)
  • array $globals: Array that contains all admin settings
  • $admin
setGlobalsAction (line 370)

Method to save global config

  • throws: CaramelException
  • access: public
void setGlobalsAction (array $globals)
  • array $globals: Array that contains all global settings
setTemplateAction (line 506)

Method to set new template file for frontend

  • return: of file_put_contents
  • throws: CaramelException
  • access: public
Result setTemplateAction (string $newTemplate)
  • string $newTemplate: New template to set