Table of Contents
UserController
Layer: Controller · Source: lib/controller/UserController.php:34 (lines 34–922)
class UserController extends BaseApp
Docblock Metadata
| Tag | Value |
|---|---|
@category | Class UserController extends BaseApp |
@author | M.Noermoehammad |
@license | MIT |
@version | 1.0 |
@since | Since Release 1.0 |
Inheritance
| Relation | Type | Meaning |
|---|---|---|
| extends | ''BaseApp'' | parent class/interface |
Constants (0)
None.
Properties (3)
| Visibility | Type | Name | Default | Line |
|---|---|---|---|---|
private | (untyped) | $view | 42 | |
private | (untyped) | $userService | 50 | |
private | (untyped) | $configService | 58 |
Methods (18)
| Visibility | Method | Summary | Line |
|---|---|---|---|
| public | __construct() | (undocumented) | 60 |
| public | listItems() | abstract method list items | 76 |
| public | showProfile() | showProfile() | 127 |
| public | insert() | abstract method insert | 191 |
| private | validateNewUserInput() | (undocumented) | 259 |
| private | createNewUser() | (undocumented) | 315 |
| public | update() | Abstract method update | 346 |
| private | validateUserUpdate() | (undocumented) | 439 |
| private | applyUserUpdate() | (undocumented) | 497 |
| private | applyUserCookieUpdate() | (undocumented) | 522 |
| public | updateProfile() | updateProfile | 550 |
| private | validateProfileUpdate() | (undocumented) | 626 |
| private | applyProfileUpdate() | (undocumented) | 679 |
| private | applyProfileCookieUpdate() | (undocumented) | 697 |
| public | remove() | Abstract method remove | 725 |
| public | removeProfile() | removeProfile | 794 |
| private | processProfileDeletion() | (undocumented) | 883 |
| protected | setView() | setView | 918 |
__construct()
public function __construct(userService $userService, ?ConfigurationService $configService = null)
lines 60–64 (5)
| Parameter | Type | Default | Description |
|---|---|---|---|
$userService | userService | required | none |
$configService | ''?ConfigurationService'' | null | none |
listItems()
public function listItems()
lines 76–115 (40)
Documentation inherited from ''Scriptlog\Core\BaseApp''.
abstract method list items
Takes no parameters.
Returns: (none declared)
showProfile()
public function showProfile($user_login)
lines 127–182 (56)
showProfile()
Show individual user profile (except:administrator) retrieve individual user profile based on their user login
| Parameter | Type | Default | Description |
|---|---|---|---|
$user_login | (untyped) | required | none |
Returns: (none declared)
insert()
public function insert()
lines 191–257 (67)
Documentation inherited from ''Scriptlog\Core\BaseApp''.
abstract method insert
Takes no parameters.
Returns: (none declared)
validateNewUserInput()
private function validateNewUserInput($filters, &$errors, $checkError)
lines 259–313 (55)
| Parameter | Type | Default | Description |
|---|---|---|---|
$filters | (untyped) | required | none |
$errors (by reference) | (untyped) | required | none |
$checkError | (untyped) | required | none |
Returns: (none declared)
createNewUser()
private function createNewUser($filters)
lines 315–335 (21)
| Parameter | Type | Default | Description |
|---|---|---|---|
$filters | (untyped) | required | none |
Returns: (none declared)
update()
public function update($id)
lines 346–437 (92)
Documentation inherited from ''Scriptlog\Core\BaseApp''.
Abstract method update
| Parameter | Type | Default | Description |
|---|---|---|---|
$id | (untyped) | required | none |
Returns: (none declared)
validateUserUpdate()
private function validateUserUpdate($filters, $getUser, &$errors, $checkError)
lines 439–495 (57)
| Parameter | Type | Default | Description |
|---|---|---|---|
$filters | (untyped) | required | none |
$getUser | (untyped) | required | none |
$errors (by reference) | (untyped) | required | none |
$checkError | (untyped) | required | none |
Returns: (none declared)
applyUserUpdate()
private function applyUserUpdate($filters, $getUser, $secret)
lines 497–520 (24)
| Parameter | Type | Default | Description |
|---|---|---|---|
$filters | (untyped) | required | none |
$getUser | (untyped) | required | none |
$secret | (untyped) | required | none |
Returns: (none declared)
applyUserCookieUpdate()
private function applyUserCookieUpdate($getUser, $secret)
lines 522–541 (20)
| Parameter | Type | Default | Description |
|---|---|---|---|
$getUser | (untyped) | required | none |
$secret | (untyped) | required | none |
Returns: (none declared)
updateProfile()
public function updateProfile($user_login)
lines 550–624 (75)
updateProfile
| Parameter | Type | Default | Description |
|---|---|---|---|
$user_login | (untyped) | required | none |
Returns: (none declared) — mixed
validateProfileUpdate()
private function validateProfileUpdate($getProfile, &$errors, $checkError)
lines 626–677 (52)
| Parameter | Type | Default | Description |
|---|---|---|---|
$getProfile | (untyped) | required | none |
$errors (by reference) | (untyped) | required | none |
$checkError | (untyped) | required | none |
Returns: (none declared)
applyProfileUpdate()
private function applyProfileUpdate($filters, $getProfile, $secret)
lines 679–695 (17)
| Parameter | Type | Default | Description |
|---|---|---|---|
$filters | (untyped) | required | none |
$getProfile | (untyped) | required | none |
$secret | (untyped) | required | none |
Returns: (none declared)
applyProfileCookieUpdate()
private function applyProfileCookieUpdate($getProfile, $secret)
lines 697–716 (20)
| Parameter | Type | Default | Description |
|---|---|---|---|
$getProfile | (untyped) | required | none |
$secret | (untyped) | required | none |
Returns: (none declared)
remove()
public function remove($userId)
lines 725–785 (61)
Documentation inherited from ''Scriptlog\Core\BaseApp''.
Abstract method remove
| Parameter | Type | Default | Description |
|---|---|---|---|
$userId | (untyped) | required | none |
Returns: (none declared)
removeProfile()
public function removeProfile($user_login, $authenticator)
lines 794–881 (88)
removeProfile
| Parameter | Type | Default | Description |
|---|---|---|---|
$user_login | (untyped) | required | none |
$authenticator | (untyped) | required | none |
Returns: (none declared)
processProfileDeletion()
private function processProfileDeletion($filters, $getProfile, $authenticator)
lines 883–910 (28)
| Parameter | Type | Default | Description |
|---|---|---|---|
$filters | (untyped) | required | none |
$getProfile | (untyped) | required | none |
$authenticator | (untyped) | required | none |
Returns: (none declared)
setView()
protected function setView($viewName)
lines 918–921 (4)
setView
| Parameter | Type | Default | Description |
|---|---|---|---|
$viewName | (untyped) | required | none |
Returns: (none declared)
Imports
| Alias | Fully-qualified name |
|---|---|
RFCValidation | Egulias\EmailValidator\Validation\RFCValidation |
ActionConst | ''Scriptlog\Core\ActionConst'' |
AppException | ''Scriptlog\Core\AppException'' |
Authentication | ''Scriptlog\Core\Authentication'' |
BaseApp | ''Scriptlog\Core\BaseApp'' |
LogError | ''Scriptlog\Core\LogError'' |
Sanitize | ''Scriptlog\Core\Sanitize'' |
ScriptlogCryptonize | ''Scriptlog\Core\ScriptlogCryptonize'' |
Session | ''Scriptlog\Core\Session'' |
Tokenizer | ''Scriptlog\Core\Tokenizer'' |
View | ''Scriptlog\Core\View'' |
ConfigurationService | ''Scriptlog\Service\ConfigurationService'' |
NotificationService | ''Scriptlog\Service\NotificationService'' |
UserService | ''Scriptlog\Service\UserService'' |
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.