====== ConfigurationController ======
**Layer:** ''Controller'' · **Source:** ''lib/controller/ConfigurationController.php:28'' (lines 28–1213)
----
class ConfigurationController
======= Docblock Metadata =======
^ Tag ^ Value ^
| ''@category'' | Class ConfigurationController extends BaseApp |
| ''@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 (4) =======
^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$view'' | | 36 |
| ''private'' | ''(untyped)'' | ''$configService'' | | 44 |
| ''protected'' | ''(untyped)'' | ''$pageTitle'' | | 52 |
| ''protected'' | ''(untyped)'' | ''$formAction'' | | 60 |
======= Methods (18) =======
^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 62 |
| public | ''setPageTitle()'' | (undocumented) | 67 |
| public | ''getPageTitle()'' | (undocumented) | 72 |
| public | ''setFormAction()'' | (undocumented) | 77 |
| public | ''getFormAction()'' | (undocumented) | 82 |
| public | ''updateGeneralSetting()'' | UpdateGeneralSetting | 94 |
| public | ''updateReadingSetting()'' | updateReadingSetting | 249 |
| public | ''updatePermalinkConfig()'' | updatePermalinkConfig | 349 |
| public | ''updateTimezoneConfig()'' | updateTimezoneConfig | 470 |
| public | ''updateMembershipConfig()'' | updateMembershipConfig | 585 |
| public | ''updateDownloadSetting()'' | updateDownloadSetting | 701 |
| public | ''updateMailSetting()'' | updateMailSetting | 773 |
| public | ''updateLanguageSetting()'' | updateLanguageSetting | 879 |
| private | ''getCurrentLangSettings()'' | getCurrentLangSettings | 1006 |
| private | ''persistCacheSetting()'' | persistCacheSetting | 1029 |
| protected | ''setView()'' | setView | 1050 |
| public | ''updateApiSetting()'' | updateApiSetting | 1061 |
| public | ''updateWritingSetting()'' | updateWritingSetting | 1145 |
======== __construct() ========
public function __construct(ConfigurationService $configService)
//lines 62–65 (4)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$configService'' | [[scriptlog:lib:service:configurationservice|''ConfigurationService'']] | //required// | //none// |
======== setPageTitle() ========
public function setPageTitle($pageTitle)
//lines 67–70 (4)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$pageTitle'' | ''(untyped)'' | //required// | //none// |
**Returns:** ''(none declared)''
======== getPageTitle() ========
public function getPageTitle()
//lines 72–75 (4)//
//Takes no parameters.//
**Returns:** ''(none declared)''
======== setFormAction() ========
public function setFormAction($formAction)
//lines 77–80 (4)//
^ Parameter ^ Type ^ Default ^ Description ^
| ''$formAction'' | ''(untyped)'' | //required// | //none// |
**Returns:** ''(none declared)''
======== getFormAction() ========
public function getFormAction()
//lines 82–85 (4)//
//Takes no parameters.//
**Returns:** ''(none declared)''
======== updateGeneralSetting() ========
public function updateGeneralSetting()
//lines 94–241 (148)//
UpdateGeneralSetting
//Takes no parameters.//
**Returns:** ''(none declared)'' — void
======== updateReadingSetting() ========
public function updateReadingSetting()
//lines 249–341 (93)//
updateReadingSetting
//Takes no parameters.//
**Returns:** ''(none declared)'' — array|mixed
======== updatePermalinkConfig() ========
public function updatePermalinkConfig()
//lines 349–464 (116)//
updatePermalinkConfig
//Takes no parameters.//
**Returns:** ''(none declared)'' — mixed
======== updateTimezoneConfig() ========
public function updateTimezoneConfig()
//lines 470–577 (108)//
updateTimezoneConfig
//Takes no parameters.//
**Returns:** ''(none declared)''
======== updateMembershipConfig() ========
public function updateMembershipConfig()
//lines 585–693 (109)//
updateMembershipConfig
//Takes no parameters.//
**Returns:** ''(none declared)'' — mixed
======== updateDownloadSetting() ========
public function updateDownloadSetting()
//lines 701–765 (65)//
updateDownloadSetting
//Takes no parameters.//
**Returns:** ''(none declared)'' — array|mixed
======== updateMailSetting() ========
public function updateMailSetting()
//lines 773–871 (99)//
updateMailSetting
//Takes no parameters.//
**Returns:** ''(none declared)'' — array|mixed
======== updateLanguageSetting() ========
public function updateLanguageSetting()
//lines 879–998 (120)//
updateLanguageSetting
//Takes no parameters.//
**Returns:** ''(none declared)'' — mixed
======== getCurrentLangSettings() ========
private function getCurrentLangSettings(): array
//lines 1006–1016 (11)//
getCurrentLangSettings
//Takes no parameters.//
**Returns:** ''array'' — array
======== persistCacheSetting() ========
private function persistCacheSetting($name, $value)
//lines 1029–1042 (14)//
persistCacheSetting
Persist a single page-cache setting (cache_enabled / cache_lifetime),
creating the row when missing and updating it when present.
^ Parameter ^ Type ^ Default ^ Description ^
| ''$name'' | ''(untyped)'' | //required// | //none// |
| ''$value'' | ''(untyped)'' | //required// | //none// |
**Returns:** ''(none declared)'' — void
======== setView() ========
protected function setView($viewName)
//lines 1050–1053 (4)//
setView
^ Parameter ^ Type ^ Default ^ Description ^
| ''$viewName'' | ''(untyped)'' | //required// | //none// |
**Returns:** ''(none declared)''
======== updateApiSetting() ========
public function updateApiSetting()
//lines 1061–1136 (76)//
updateApiSetting
//Takes no parameters.//
**Returns:** ''(none declared)'' — mixed
======== updateWritingSetting() ========
public function updateWritingSetting()
//lines 1145–1212 (68)//
updateWritingSetting
Persists the Writing (scheduled posting) toggle.
//Takes no parameters.//
**Returns:** ''(none declared)'' — mixed
======= Imports =======
^ Alias ^ Fully-qualified name ^
| ''ActionConst'' | [[scriptlog:lib:core:actionconst|''Scriptlog\Core\ActionConst'']] |
| ''AppException'' | [[scriptlog:lib:core:appexception|''Scriptlog\Core\AppException'']] |
| ''LogError'' | [[scriptlog:lib:core:logerror|''Scriptlog\Core\LogError'']] |
| ''Registry'' | [[scriptlog:lib:core:registry|''Scriptlog\Core\Registry'']] |
| ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] |
| ''Session'' | [[scriptlog:lib:core:session|''Scriptlog\Core\Session'']] |
| ''View'' | [[scriptlog:lib:core:view|''Scriptlog\Core\View'']] |
| ''ConfigurationService'' | [[scriptlog:lib:service:configurationservice|''Scriptlog\Service\ConfigurationService'']] |
| ''LanguageService'' | [[scriptlog:lib:service:languageservice|''Scriptlog\Service\LanguageService'']] |
----
//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//