Scriptlog Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ConfigurationService ======

**Layer:** ''Service'' &middot; **Source:** ''lib/service/ConfigurationService.php:23'' (lines 23–207)

----
<code>
class ConfigurationService
</code>

======= Docblock Metadata =======

^ Tag ^ Value ^
| ''@category'' | Event Class |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |

======= Inheritance =======

//No parent, interface or trait. This is a root type.//

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

//None.//

======= Properties (6) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$setting_id'' |  | 30 |
| ''private'' | ''(untyped)'' | ''$setting_name'' |  | 37 |
| ''private'' | ''(untyped)'' | ''$setting_value'' |  | 44 |
| ''private'' | ''(untyped)'' | ''$configDao'' |  | 52 |
| ''private'' | ''(untyped)'' | ''$validator'' |  | 60 |
| ''private'' | ''(untyped)'' | ''$sanitizer'' |  | 68 |

======= Methods (15) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 70 |
| public | ''setConfigId()'' | (undocumented) | 77 |
| public | ''setConfigName()'' | (undocumented) | 82 |
| public | ''setConfigValue()'' | (undocumented) | 87 |
| public | ''grabSettings()'' | (undocumented) | 92 |
| public | ''grabGeneralSettings()'' | (undocumented) | 97 |
| public | ''grabReadingSettings()'' | (undocumented) | 102 |
| public | ''grabSettingByName()'' | (undocumented) | 107 |
| public | ''grabSetting()'' | (undocumented) | 112 |
| public | ''addSetting()'' | addSetting | 125 |
| public | ''modifySetting()'' | modifySetting | 142 |
| public | ''removeSetting()'' | removeSetting | 161 |
| public | ''timezoneIdentifierDropDown()'' | timezoneIdentifierDropDown | 179 |
| public | ''membershipDefaultRoleDropDown()'' | membershipDefaultRole | 191 |
| public | ''totalSettings()'' | totalSettings | 203 |


======== __construct() ========

<code>
public function __construct(ConfigurationDao $configDao, FormValidator $validator, Sanitize $sanitize)
</code>

//lines 70–75 (6)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$configDao'' |  [[scriptlog:lib:dao:configurationdao|''ConfigurationDao'']] |  //required// |  //none// |
|  ''$validator'' |  [[scriptlog:lib:core:formvalidator|''FormValidator'']] |  //required// |  //none// |
|  ''$sanitize'' |  [[scriptlog:lib:core:sanitize|''Sanitize'']] |  //required// |  //none// |


======== setConfigId() ========

<code>
public function setConfigId($setting_id)
</code>

//lines 77–80 (4)//

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

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


======== setConfigName() ========

<code>
public function setConfigName($setting_name)
</code>

//lines 82–85 (4)//

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

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


======== setConfigValue() ========

<code>
public function setConfigValue($setting_value)
</code>

//lines 87–90 (4)//

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

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


======== grabSettings() ========

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

//lines 92–95 (4)//

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

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


======== grabGeneralSettings() ========

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

//lines 97–100 (4)//

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

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


======== grabReadingSettings() ========

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

//lines 102–105 (4)//

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

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


======== grabSettingByName() ========

<code>
public function grabSettingByName($setting_name)
</code>

//lines 107–110 (4)//

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

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


======== grabSetting() ========

<code>
public function grabSetting($id)
</code>

//lines 112–115 (4)//

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

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


======== addSetting() ========

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

//lines 125–136 (12)//

addSetting

Creates a new configuration row. The DAO sanitizes both the name and
the value internally.

//Takes no parameters.//

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


======== modifySetting() ========

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

//lines 142–155 (14)//

modifySetting

//Takes no parameters.//

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


======== removeSetting() ========

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

//lines 161–171 (11)//

removeSetting

//Takes no parameters.//

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


======== timezoneIdentifierDropDown() ========

<code>
public function timezoneIdentifierDropDown($selected = &quot;&quot;)
</code>

//lines 179–182 (4)//

timezoneIdentifierDropDown

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

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


======== membershipDefaultRoleDropDown() ========

<code>
public function membershipDefaultRoleDropDown($selected = &quot;&quot;)
</code>

//lines 191–195 (5)//

membershipDefaultRole

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

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


======== totalSettings() ========

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

//lines 203–206 (4)//

totalSettings

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

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

======= Imports =======

^ Alias ^ Fully-qualified name ^
| ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] |
| ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] |
| ''ConfigurationDao'' | [[scriptlog:lib:dao:configurationdao|''Scriptlog\Dao\ConfigurationDao'']] |
| ''UserDao'' | [[scriptlog:lib:dao:userdao|''Scriptlog\Dao\UserDao'']] |


----

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