This is an old revision of the document!
Table of Contents
ConfigurationDao
Layer: DAO · Source: lib/dao/ConfigurationDao.php:20 (lines 20–292)
class ConfigurationDao extends Dao
Docblock Metadata
| Tag | Value |
|---|---|
@category | Dao Class |
@author | M.Noermoehammad |
@license | MIT |
@version | 1.0 |
@since | Since Release 1.0 |
Inheritance
| Relation | Type | Meaning |
|---|---|---|
| extends | ''Dao'' | parent class/interface |
Constants (0)
None.
Properties (0)
None declared.
Methods (14)
| Visibility | Method | Summary | Line |
|---|---|---|---|
| public | __construct() | (undocumented) | 27 |
| public | updateConfig() | Update configuration | 42 |
| public | deleteConfig() | Delete config | 63 |
| public | findConfigs() | Find configurations | 77 |
| public | findGeneralConfigs() | Find general configurations | 97 |
| public | findReadingConfigs() | findReadingConfigs | 115 |
| public | findConfig() | Find Configuration | 135 |
| public | findConfigByName() | findConfigByName | 157 |
| public | checkConfigId() | Check configuration Id | 179 |
| public | checkToSetup() | Checking to setup | 192 |
| public | dropDownTimezone() | dropDownTimezone | 206 |
| public | totalConfigRecords() | Total Config records | 242 |
| public | createConfig() | Create a new configuration entry | 255 |
| public | updateConfigByName() | Update configuration by name | 276 |
__construct()
public function __construct()
lines 27–31 (5)
Takes no parameters.
updateConfig()
public function updateConfig($sanitize, $bind, $configId)
lines 42–54 (13)
Update configuration
| Parameter | Type | Default | Description |
|---|---|---|---|
$sanitize | (untyped) | required | none |
$bind | (untyped) | required | none |
$configId | (untyped) | required | none |
Returns: (none declared)
deleteConfig()
public function deleteConfig($configId, $sanitize)
lines 63–67 (5)
Delete config
| Parameter | Type | Default | Description |
|---|---|---|---|
$configId | (untyped) | required | none |
$sanitize | (untyped) | required | none |
Returns: (none declared)
findConfigs()
public function findConfigs($orderBy = 'ID')
lines 77–87 (11)
Find configurations
| Parameter | Type | Default | Description |
|---|---|---|---|
$orderBy | (untyped) | 'ID' | – default order by ID |
Returns: (none declared) — array
findGeneralConfigs()
public function findGeneralConfigs($orderBy = 'ID', $limit = 7)
lines 97–106 (10)
Find general configurations
| Parameter | Type | Default | Description |
|---|---|---|---|
$orderBy | (untyped) | 'ID' | none |
$limit | (untyped) | 7 | none |
Returns: (none declared) — array
findReadingConfigs()
public function findReadingConfigs($orderBy = 'ID')
lines 115–124 (10)
findReadingConfigs
| Parameter | Type | Default | Description |
|---|---|---|---|
$orderBy | (untyped) | 'ID' | none |
Returns: (none declared) — array
findConfig()
public function findConfig($id, $sanitize)
lines 135–147 (13)
Find Configuration
| Parameter | Type | Default | Description |
|---|---|---|---|
$id | (untyped) | required | none |
$sanitize | (untyped) | required | none |
Returns: (none declared) — array
findConfigByName()
public function findConfigByName($setting_name, $sanitize)
lines 157–169 (13)
findConfigByName
| Parameter | Type | Default | Description |
|---|---|---|---|
$setting_name | (untyped) | required | none |
$sanitize | (untyped) | required | none |
Returns: (none declared) — array
checkConfigId()
public function checkConfigId($id, $sanitize)
lines 179–186 (8)
Check configuration Id
| Parameter | Type | Default | Description |
|---|---|---|---|
$id | (untyped) | required | none |
$sanitize | (untyped) | required | none |
Returns: (none declared)
checkToSetup()
public function checkToSetup()
lines 192–198 (7)
Checking to setup
Takes no parameters.
Returns: (none declared)
dropDownTimezone()
public function dropDownTimezone($selected = null)
lines 206–233 (28)
dropDownTimezone
| Parameter | Type | Default | Description |
|---|---|---|---|
$selected | (untyped) | null | none |
Returns: (none declared)
totalConfigRecords()
public function totalConfigRecords($data = null)
lines 242–247 (6)
Total Config records
| Parameter | Type | Default | Description |
|---|---|---|---|
$data | (untyped) | null | none |
Returns: (none declared) — integer|numeric
createConfig()
public function createConfig($settingName, $settingValue, $sanitize)
lines 255–266 (12)
Create a new configuration entry
| Parameter | Type | Default | Description |
|---|---|---|---|
$settingName | (untyped) | required | none |
$settingValue | (untyped) | required | none |
$sanitize | (untyped) | required | none |
Returns: (none declared) — bool
updateConfigByName()
public function updateConfigByName($settingName, $settingValue, $sanitize)
lines 276–291 (16)
Update configuration by name
| Parameter | Type | Default | Description |
|---|---|---|---|
$settingName | (untyped) | required | none |
$settingValue | (untyped) | required | none |
$sanitize | (untyped) | required | none |
Returns: (none declared) — bool
Imports
| Alias | Fully-qualified name |
|---|---|
Dao | ''Scriptlog\Core\Dao'' |
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.