This is an old revision of the document!
Table of Contents
ThemeController
Layer: Controller · Source: lib/controller/ThemeController.php:27 (lines 27–553)
class ThemeController extends BaseApp
Docblock Metadata
^ Tag ^ Value ^ | ''@category'' | Class ThemeController extends BaseApp | | ''@author'' | M.Noermoehammad | | ''@license'' | MIT | | ''@version'' | 1.0.0 | | ''@since'' | Since Release 1.0 |
Inheritance
^ Relation ^ Type ^ Meaning ^ | extends | [[scriptlog:lib:core:baseapp|''BaseApp'']] | parent class/interface |
Constants (0)
None.
Properties (0)
None declared.
Methods (14)
^ Visibility ^ Method ^ Summary ^ Line ^ | public | ''__construct()'' | (undocumented) | 33 | | public | ''listItems()'' | (undocumented) | 38 | | private | ''retrieveThemeSessionStatus()'' | (undocumented) | 60 | | private | ''retrieveSessionErrors()'' | (undocumented) | 75 | | public | ''insert()'' | insert() | 93 | | public | ''setupTheme()'' | setupTheme | 165 | | private | ''validateThemeUpload()'' | (undocumented) | 219 | | private | ''handleUploadError()'' | (undocumented) | 266 | | private | ''installUploadedTheme()'' | (undocumented) | 288 | | public | ''update()'' | (undocumented) | 305 | | public | ''remove()'' | (undocumented) | 383 | | public | ''enableTheme()'' | (undocumented) | 432 | | public | ''disableTheme()'' | (undocumented) | 495 | | protected | ''setView()'' | setView | 549 |
__construct()
public function __construct(ThemeService $themeService)
lines 33–36 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$themeService'' | [[scriptlog:lib:service:themeservice|''ThemeService'']] | //required// | //none// |
listItems()
public function listItems()
lines 38–58 (21)
Takes no parameters.
Returns: (none declared)
retrieveThemeSessionStatus()
private function retrieveThemeSessionStatus()
lines 60–73 (14)
Takes no parameters.
Returns: (none declared)
retrieveSessionErrors()
private function retrieveSessionErrors()
lines 75–85 (11)
Takes no parameters.
Returns: (none declared)
insert()
public function insert()
lines 93–159 (67)
insert()
Takes no parameters.
Returns: (none declared)
setupTheme()
public function setupTheme()
lines 165–217 (53)
setupTheme
Takes no parameters.
Returns: (none declared)
validateThemeUpload()
private function validateThemeUpload($file_error, $file_size, $file_location, $file_name, $theme_title, &$errors, $checkError)
lines 219–264 (46)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$file_error'' | ''(untyped)'' | //required// | //none// | | ''$file_size'' | ''(untyped)'' | //required// | //none// | | ''$file_location'' | ''(untyped)'' | //required// | //none// | | ''$file_name'' | ''(untyped)'' | //required// | //none// | | ''$theme_title'' | ''(untyped)'' | //required// | //none// | | ''$errors (by reference)'' | ''(untyped)'' | //required// | //none// | | ''$checkError'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
handleUploadError()
private function handleUploadError($file_error, &$errors, $checkError)
lines 266–286 (21)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$file_error'' | ''(untyped)'' | //required// | //none// | | ''$errors (by reference)'' | ''(untyped)'' | //required// | //none// | | ''$checkError'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
installUploadedTheme()
private function installUploadedTheme($file_name, $file_location, $theme_title, $theme_dir)
lines 288–303 (16)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$file_name'' | ''(untyped)'' | //required// | //none// | | ''$file_location'' | ''(untyped)'' | //required// | //none// | | ''$theme_title'' | ''(untyped)'' | //required// | //none// | | ''$theme_dir'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
update()
public function update($id)
lines 305–381 (77)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
remove()
public function remove($id)
lines 383–430 (48)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
enableTheme()
public function enableTheme($id)
lines 432–493 (62)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
disableTheme()
public function disableTheme($id)
lines 495–541 (47)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setView()
protected function setView($viewName)
lines 549–552 (4)
setView
^ Parameter ^ Type ^ Default ^ Description ^ | ''$viewName'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
Imports
^ Alias ^ Fully-qualified name ^ | ''ActionConst'' | [[scriptlog:lib:core:actionconst|''Scriptlog\Core\ActionConst'']] | | ''AppException'' | [[scriptlog:lib:core:appexception|''Scriptlog\Core\AppException'']] | | ''BaseApp'' | [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']] | | ''LogError'' | [[scriptlog:lib:core:logerror|''Scriptlog\Core\LogError'']] | | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | | ''View'' | [[scriptlog:lib:core:view|''Scriptlog\Core\View'']] | | ''ThemeService'' | [[scriptlog:lib:service:themeservice|''Scriptlog\Service\ThemeService'']] |
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.
