====== ConfigurationDao ======

**Layer:** ''DAO'' · **Source:** ''lib/dao/ConfigurationDao.php:20'' (lines 20–292)

----
<code>
class ConfigurationDao extends Dao
</code>

======= 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 | [[scriptlog:lib:core:dao|''Dao'']] | parent class/interface |

======= Constants (0) =======

//None.//

======= Properties (1) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$selected'' |  | 22 |

======= 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() ========

<code>
public function __construct()
</code>

//lines 27–31 (5)//

//Takes no parameters.//


======== updateConfig() ========

<code>
public function updateConfig($sanitize, $bind, $configId)
</code>

//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() ========

<code>
public function deleteConfig($configId, $sanitize)
</code>

//lines 63–67 (5)//

Delete config

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$configId'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== findConfigs() ========

<code>
public function findConfigs($orderBy = &#039;ID&#039;)
</code>

//lines 77–87 (11)//

Find configurations

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  -- default order by ID |

**Returns:** ''(none declared)'' — array


======== findGeneralConfigs() ========

<code>
public function findGeneralConfigs($orderBy = &#039;ID&#039;, $limit = 7)
</code>

//lines 97–106 (10)//

Find general configurations

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  //none// |
|  ''$limit'' |  ''(untyped)'' |  ''7'' |  //none// |

**Returns:** ''(none declared)'' — array


======== findReadingConfigs() ========

<code>
public function findReadingConfigs($orderBy = &#039;ID&#039;)
</code>

//lines 115–124 (10)//

findReadingConfigs

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  //none// |

**Returns:** ''(none declared)'' — array


======== findConfig() ========

<code>
public function findConfig($id, $sanitize)
</code>

//lines 135–147 (13)//

Find Configuration

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)'' — array


======== findConfigByName() ========

<code>
public function findConfigByName($setting_name, $sanitize)
</code>

//lines 157–169 (13)//

findConfigByName

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$setting_name'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)'' — array


======== checkConfigId() ========

<code>
public function checkConfigId($id, $sanitize)
</code>

//lines 179–186 (8)//

Check configuration Id

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== checkToSetup() ========

<code>
public function checkToSetup()
</code>

//lines 192–198 (7)//

Checking to setup

//Takes no parameters.//

**Returns:** ''(none declared)''


======== dropDownTimezone() ========

<code>
public function dropDownTimezone($selected = null)
</code>

//lines 206–233 (28)//

dropDownTimezone

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$selected'' |  ''(untyped)'' |  ''null'' |  //none// |

**Returns:** ''(none declared)''


======== totalConfigRecords() ========

<code>
public function totalConfigRecords($data = null)
</code>

//lines 242–247 (6)//

Total Config records

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$data'' |  ''(untyped)'' |  ''null'' |  //none// |

**Returns:** ''(none declared)'' — integer&#124;numeric


======== createConfig() ========

<code>
public function createConfig($settingName, $settingValue, $sanitize)
</code>

//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() ========

<code>
public function updateConfigByName($settingName, $settingValue, $sanitize)
</code>

//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:lib:core:dao|''Scriptlog\Core\Dao'']] |


----

//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//