Layer: Service · Source: lib/service/ConfigurationService.php:23 (lines 23–207)

class ConfigurationService

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

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

None.

None declared.

^ 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 |

public function __construct(ConfigurationDao $configDao, FormValidator $validator, Sanitize $sanitize)

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// |

public function setConfigId($setting_id)

lines 77–80 (4)

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

Returns: (none declared)

public function setConfigName($setting_name)

lines 82–85 (4)

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

Returns: (none declared)

public function setConfigValue($setting_value)

lines 87–90 (4)

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

Returns: (none declared)

public function grabSettings($orderBy = 'ID')

lines 92–95 (4)

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

Returns: (none declared)

public function grabGeneralSettings($orderBy = 'ID', $limit = 7)

lines 97–100 (4)

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

Returns: (none declared)

public function grabReadingSettings($orderBy = 'ID')

lines 102–105 (4)

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

Returns: (none declared)

public function grabSettingByName($setting_name)

lines 107–110 (4)

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

Returns: (none declared)

public function grabSetting($id)

lines 112–115 (4)

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

Returns: (none declared)

public function addSetting()

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

public function modifySetting()

lines 142–155 (14)

modifySetting

Takes no parameters.

Returns: (none declared)

public function removeSetting()

lines 161–171 (11)

removeSetting

Takes no parameters.

Returns: (none declared)

public function timezoneIdentifierDropDown($selected = "")

lines 179–182 (4)

timezoneIdentifierDropDown

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

Returns: (none declared)

public function membershipDefaultRoleDropDown($selected = "")

lines 191–195 (5)

membershipDefaultRole

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

Returns: (none declared) — mixed

public function totalSettings($data = null)

lines 203–206 (4)

totalSettings

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

Returns: (none declared)

^ 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.