Layer: Controller · Source: lib/controller/UserController.php:34 (lines 34–922)

class UserController extends BaseApp

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

^ Relation ^ Type ^ Meaning ^
| extends | [[scriptlog:lib:core:baseapp|''BaseApp'']] | parent class/interface |

None.

None declared.

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

public function __construct(userService $userService, ?ConfigurationService $configService = null)

lines 60–64 (5)

^ Parameter ^ Type ^ Default ^ Description ^
| ''$userService'' | ''userService'' | //required// | //none// |
| ''$configService'' | [[scriptlog:lib:service:configurationservice|''?ConfigurationService'']] | ''null'' | //none// |

public function listItems()

lines 76–115 (40)

Documentation inherited from ''Scriptlog\Core\BaseApp''.

abstract method list items

Takes no parameters.

Returns: (none declared)

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)

public function insert()

lines 191–257 (67)

Documentation inherited from ''Scriptlog\Core\BaseApp''.

abstract method insert

Takes no parameters.

Returns: (none declared)

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)

private function createNewUser($filters)

lines 315–335 (21)

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

Returns: (none declared)

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)

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)

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)

private function applyUserCookieUpdate($getUser, $secret)

lines 522–541 (20)

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

Returns: (none declared)

public function updateProfile($user_login)

lines 550–624 (75)

updateProfile

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

Returns: (none declared) — mixed

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)

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)

private function applyProfileCookieUpdate($getProfile, $secret)

lines 697–716 (20)

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

Returns: (none declared)

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)

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)

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)

protected function setView($viewName)

lines 918–921 (4)

setView

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

Returns: (none declared)

^ Alias ^ Fully-qualified name ^
| ''RFCValidation'' | ''Egulias\EmailValidator\Validation\RFCValidation'' |
| ''ActionConst'' | [[scriptlog:lib:core:actionconst|''Scriptlog\Core\ActionConst'']] |
| ''AppException'' | [[scriptlog:lib:core:appexception|''Scriptlog\Core\AppException'']] |
| ''Authentication'' | [[scriptlog:lib:core:authentication|''Scriptlog\Core\Authentication'']] |
| ''BaseApp'' | [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']] |
| ''LogError'' | [[scriptlog:lib:core:logerror|''Scriptlog\Core\LogError'']] |
| ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] |
| ''ScriptlogCryptonize'' | [[scriptlog:lib:core:scriptlogcryptonize|''Scriptlog\Core\ScriptlogCryptonize'']] |
| ''Session'' | [[scriptlog:lib:core:session|''Scriptlog\Core\Session'']] |
| ''Tokenizer'' | [[scriptlog:lib:core:tokenizer|''Scriptlog\Core\Tokenizer'']] |
| ''View'' | [[scriptlog:lib:core:view|''Scriptlog\Core\View'']] |
| ''ConfigurationService'' | [[scriptlog:lib:service:configurationservice|''Scriptlog\Service\ConfigurationService'']] |
| ''NotificationService'' | [[scriptlog:lib:service:notificationservice|''Scriptlog\Service\NotificationService'']] |
| ''UserService'' | [[scriptlog:lib:service:userservice|''Scriptlog\Service\UserService'']] |

This page is generated from source by 'tools/gendoc'. Edits will be overwritten.