| Next revision | Previous revision |
| scriptlog:lib:controller:usercontroller [2026/09/26 09:09] – admin admin | scriptlog:lib:controller:usercontroller [2026/09/26 09:34] (current) – admin admin |
|---|
| ======= Docblock Metadata ======= | ======= Docblock Metadata ======= |
| |
| ^ Tag ^ Value ^ | ^ Tag ^ Value ^ |
| | ''@category'' | Class UserController extends BaseApp | | | ''@category'' | Class UserController extends BaseApp | |
| | ''@author'' | M.Noermoehammad | | | ''@author'' | M.Noermoehammad | |
| | ''@license'' | MIT | | | ''@license'' | MIT | |
| | ''@version'' | 1.0 | | | ''@version'' | 1.0 | |
| | ''@since'' | Since Release 1.0 | | | ''@since'' | Since Release 1.0 | |
| |
| ======= Inheritance ======= | ======= Inheritance ======= |
| |
| ^ Relation ^ Type ^ Meaning ^ | ^ Relation ^ Type ^ Meaning ^ |
| | extends | [[scriptlog:lib:core:baseapp|''BaseApp'']] | parent class/interface | | | extends | [[scriptlog:lib:core:baseapp|''BaseApp'']] | parent class/interface | |
| |
| ======= Constants (0) ======= | ======= Constants (0) ======= |
| //None.// | //None.// |
| |
| ======= Properties (0) ======= | ======= Properties (3) ======= |
| |
| //None declared.// | ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ |
| | | ''private'' | ''(untyped)'' | ''$view'' | | 42 | |
| | | ''private'' | ''(untyped)'' | ''$userService'' | | 50 | |
| | | ''private'' | ''(untyped)'' | ''$configService'' | | 58 | |
| |
| ======= Methods (18) ======= | ======= Methods (18) ======= |
| |
| ^ Visibility ^ Method ^ Summary ^ Line ^ | ^ Visibility ^ Method ^ Summary ^ Line ^ |
| | public | ''__construct()'' | (undocumented) | 60 | | | public | ''__construct()'' | (undocumented) | 60 | |
| | public | ''listItems()'' | abstract method list items | 76 | | | public | ''listItems()'' | abstract method list items | 76 | |
| | public | ''showProfile()'' | showProfile() | 127 | | | public | ''showProfile()'' | showProfile() | 127 | |
| | public | ''insert()'' | abstract method insert | 191 | | | public | ''insert()'' | abstract method insert | 191 | |
| | private | ''validateNewUserInput()'' | (undocumented) | 259 | | | private | ''validateNewUserInput()'' | (undocumented) | 259 | |
| | private | ''createNewUser()'' | (undocumented) | 315 | | | private | ''createNewUser()'' | (undocumented) | 315 | |
| | public | ''update()'' | Abstract method update | 346 | | | public | ''update()'' | Abstract method update | 346 | |
| | private | ''validateUserUpdate()'' | (undocumented) | 439 | | | private | ''validateUserUpdate()'' | (undocumented) | 439 | |
| | private | ''applyUserUpdate()'' | (undocumented) | 497 | | | private | ''applyUserUpdate()'' | (undocumented) | 497 | |
| | private | ''applyUserCookieUpdate()'' | (undocumented) | 522 | | | private | ''applyUserCookieUpdate()'' | (undocumented) | 522 | |
| | public | ''updateProfile()'' | updateProfile | 550 | | | public | ''updateProfile()'' | updateProfile | 550 | |
| | private | ''validateProfileUpdate()'' | (undocumented) | 626 | | | private | ''validateProfileUpdate()'' | (undocumented) | 626 | |
| | private | ''applyProfileUpdate()'' | (undocumented) | 679 | | | private | ''applyProfileUpdate()'' | (undocumented) | 679 | |
| | private | ''applyProfileCookieUpdate()'' | (undocumented) | 697 | | | private | ''applyProfileCookieUpdate()'' | (undocumented) | 697 | |
| | public | ''remove()'' | Abstract method remove | 725 | | | public | ''remove()'' | Abstract method remove | 725 | |
| | public | ''removeProfile()'' | removeProfile | 794 | | | public | ''removeProfile()'' | removeProfile | 794 | |
| | private | ''processProfileDeletion()'' | (undocumented) | 883 | | | private | ''processProfileDeletion()'' | (undocumented) | 883 | |
| | protected | ''setView()'' | setView | 918 | | | protected | ''setView()'' | setView | 918 | |
| |
| |
| //lines 60–64 (5)// | //lines 60–64 (5)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$userService'' | ''userService'' | //required// | //none// | | | ''$userService'' | ''userService'' | //required// | //none// | |
| | ''$configService'' | [[scriptlog:lib:service:configurationservice|''?ConfigurationService'']] | ''null'' | //none// | | | ''$configService'' | [[scriptlog:lib:service:configurationservice|''?ConfigurationService'']] | ''null'' | //none// | |
| |
| |
| retrieve individual user profile based on their user login | retrieve individual user profile based on their user login |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$user_login'' | ''(untyped)'' | //required// | //none// | | | ''$user_login'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| //lines 259–313 (55)// | //lines 259–313 (55)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$filters'' | ''(untyped)'' | //required// | //none// | | | ''$filters'' | ''(untyped)'' | //required// | //none// | |
| | ''$errors (by reference)'' | ''(untyped)'' | //required// | //none// | | | ''$errors (by reference)'' | ''(untyped)'' | //required// | //none// | |
| | ''$checkError'' | ''(untyped)'' | //required// | //none// | | | ''$checkError'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| //lines 315–335 (21)// | //lines 315–335 (21)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$filters'' | ''(untyped)'' | //required// | //none// | | | ''$filters'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| Abstract method update | Abstract method update |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$id'' | ''(untyped)'' | //required// | //none// | | | ''$id'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| //lines 439–495 (57)// | //lines 439–495 (57)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$filters'' | ''(untyped)'' | //required// | //none// | | | ''$filters'' | ''(untyped)'' | //required// | //none// | |
| | ''$getUser'' | ''(untyped)'' | //required// | //none// | | | ''$getUser'' | ''(untyped)'' | //required// | //none// | |
| | ''$errors (by reference)'' | ''(untyped)'' | //required// | //none// | | | ''$errors (by reference)'' | ''(untyped)'' | //required// | //none// | |
| | ''$checkError'' | ''(untyped)'' | //required// | //none// | | | ''$checkError'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| //lines 497–520 (24)// | //lines 497–520 (24)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$filters'' | ''(untyped)'' | //required// | //none// | | | ''$filters'' | ''(untyped)'' | //required// | //none// | |
| | ''$getUser'' | ''(untyped)'' | //required// | //none// | | | ''$getUser'' | ''(untyped)'' | //required// | //none// | |
| | ''$secret'' | ''(untyped)'' | //required// | //none// | | | ''$secret'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| //lines 522–541 (20)// | //lines 522–541 (20)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$getUser'' | ''(untyped)'' | //required// | //none// | | | ''$getUser'' | ''(untyped)'' | //required// | //none// | |
| | ''$secret'' | ''(untyped)'' | //required// | //none// | | | ''$secret'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| updateProfile | updateProfile |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$user_login'' | ''(untyped)'' | //required// | //none// | | | ''$user_login'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' — mixed | **Returns:** ''(none declared)'' — mixed |
| //lines 626–677 (52)// | //lines 626–677 (52)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$getProfile'' | ''(untyped)'' | //required// | //none// | | | ''$getProfile'' | ''(untyped)'' | //required// | //none// | |
| | ''$errors (by reference)'' | ''(untyped)'' | //required// | //none// | | | ''$errors (by reference)'' | ''(untyped)'' | //required// | //none// | |
| | ''$checkError'' | ''(untyped)'' | //required// | //none// | | | ''$checkError'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| //lines 679–695 (17)// | //lines 679–695 (17)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$filters'' | ''(untyped)'' | //required// | //none// | | | ''$filters'' | ''(untyped)'' | //required// | //none// | |
| | ''$getProfile'' | ''(untyped)'' | //required// | //none// | | | ''$getProfile'' | ''(untyped)'' | //required// | //none// | |
| | ''$secret'' | ''(untyped)'' | //required// | //none// | | | ''$secret'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| //lines 697–716 (20)// | //lines 697–716 (20)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$getProfile'' | ''(untyped)'' | //required// | //none// | | | ''$getProfile'' | ''(untyped)'' | //required// | //none// | |
| | ''$secret'' | ''(untyped)'' | //required// | //none// | | | ''$secret'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| Abstract method remove | Abstract method remove |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$userId'' | ''(untyped)'' | //required// | //none// | | | ''$userId'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| removeProfile | removeProfile |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$user_login'' | ''(untyped)'' | //required// | //none// | | | ''$user_login'' | ''(untyped)'' | //required// | //none// | |
| | ''$authenticator'' | ''(untyped)'' | //required// | //none// | | | ''$authenticator'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| //lines 883–910 (28)// | //lines 883–910 (28)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$filters'' | ''(untyped)'' | //required// | //none// | | | ''$filters'' | ''(untyped)'' | //required// | //none// | |
| | ''$getProfile'' | ''(untyped)'' | //required// | //none// | | | ''$getProfile'' | ''(untyped)'' | //required// | //none// | |
| | ''$authenticator'' | ''(untyped)'' | //required// | //none// | | | ''$authenticator'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| setView | setView |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$viewName'' | ''(untyped)'' | //required// | //none// | | | ''$viewName'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| ======= Imports ======= | ======= Imports ======= |
| |
| ^ Alias ^ Fully-qualified name ^ | ^ Alias ^ Fully-qualified name ^ |
| | ''RFCValidation'' | ''Egulias\EmailValidator\Validation\RFCValidation'' | | | ''RFCValidation'' | ''Egulias\EmailValidator\Validation\RFCValidation'' | |
| | ''ActionConst'' | [[scriptlog:lib:core:actionconst|''Scriptlog\Core\ActionConst'']] | | | ''ActionConst'' | [[scriptlog:lib:core:actionconst|''Scriptlog\Core\ActionConst'']] | |
| | ''AppException'' | [[scriptlog:lib:core:appexception|''Scriptlog\Core\AppException'']] | | | ''AppException'' | [[scriptlog:lib:core:appexception|''Scriptlog\Core\AppException'']] | |
| | ''Authentication'' | [[scriptlog:lib:core:authentication|''Scriptlog\Core\Authentication'']] | | | ''Authentication'' | [[scriptlog:lib:core:authentication|''Scriptlog\Core\Authentication'']] | |
| | ''BaseApp'' | [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']] | | | ''BaseApp'' | [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']] | |
| | ''LogError'' | [[scriptlog:lib:core:logerror|''Scriptlog\Core\LogError'']] | | | ''LogError'' | [[scriptlog:lib:core:logerror|''Scriptlog\Core\LogError'']] | |
| | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | | | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | |
| | ''ScriptlogCryptonize'' | [[scriptlog:lib:core:scriptlogcryptonize|''Scriptlog\Core\ScriptlogCryptonize'']] | | | ''ScriptlogCryptonize'' | [[scriptlog:lib:core:scriptlogcryptonize|''Scriptlog\Core\ScriptlogCryptonize'']] | |
| | ''Session'' | [[scriptlog:lib:core:session|''Scriptlog\Core\Session'']] | | | ''Session'' | [[scriptlog:lib:core:session|''Scriptlog\Core\Session'']] | |
| | ''Tokenizer'' | [[scriptlog:lib:core:tokenizer|''Scriptlog\Core\Tokenizer'']] | | | ''Tokenizer'' | [[scriptlog:lib:core:tokenizer|''Scriptlog\Core\Tokenizer'']] | |
| | ''View'' | [[scriptlog:lib:core:view|''Scriptlog\Core\View'']] | | | ''View'' | [[scriptlog:lib:core:view|''Scriptlog\Core\View'']] | |
| | ''ConfigurationService'' | [[scriptlog:lib:service:configurationservice|''Scriptlog\Service\ConfigurationService'']] | | | ''ConfigurationService'' | [[scriptlog:lib:service:configurationservice|''Scriptlog\Service\ConfigurationService'']] | |
| | ''NotificationService'' | [[scriptlog:lib:service:notificationservice|''Scriptlog\Service\NotificationService'']] | | | ''NotificationService'' | [[scriptlog:lib:service:notificationservice|''Scriptlog\Service\NotificationService'']] | |
| | ''UserService'' | [[scriptlog:lib:service:userservice|''Scriptlog\Service\UserService'']] | | | ''UserService'' | [[scriptlog:lib:service:userservice|''Scriptlog\Service\UserService'']] | |
| |
| |