Table of Contents
UserDao
Layer: DAO · Source: lib/dao/UserDao.php:22 (lines 22–577)
class UserDao extends Dao
User class extends Dao
insert, update, delete and select records from users table
Docblock Metadata
| Tag | Value |
|---|---|
@category | Dao Class |
@author | M.Noermoehammad |
@license | MIT |
@version | 1.0 |
@since | Since Release 1.0 |
Inheritance
| Relation | Type | Meaning |
|---|---|---|
| extends | ''Dao'' | parent class/interface |
Constants (0)
None.
Properties (1)
| Visibility | Type | Name | Default | Line |
|---|---|---|---|---|
private | (untyped) | $selected | 24 |
Methods (24)
| Visibility | Method | Summary | Line |
|---|---|---|---|
| public | __construct() | (undocumented) | 26 |
| public | getUsers() | getUsers | 41 |
| public | getUserById() | getUserById | 66 |
| public | getUserByEmail() | getUserByEmail() | 90 |
| public | getUserByLogin() | getUserByLogin() | 116 |
| public | getUserBySession() | getUserBySession() | 141 |
| public | getUserByResetKey() | get User by reset key | 164 |
| public | createUser() | Create user | 183 |
| public | updateUser() | Update user | 227 |
| public | updateUserSession() | Update user session | 281 |
| public | updateResetKey() | Update reset key | 295 |
| public | recoverNewPassword() | Recover New password | 307 |
| public | activateUser() | Activate user | 319 |
| public | deleteUser() | deleteUser | 353 |
| public | dropDownUserLevel() | dropDownUserLevel | 367 |
| public | isUserLoginExists() | isUserLoginExists | 393 |
| public | checkUserSession() | checkUserSession | 411 |
| public | checkUserEmail() | checking email | 429 |
| public | checkUserPassword() | checkUserPassword | 447 |
| public | checkUserId() | checkUserId | 464 |
| public | totalUserRecords() | Total user records | 485 |
| private | checkUserPasswordByEmail() | checkUserPasswordByEmail | 501 |
| private | checkUserPasswordByLogin() | checkUserPasswordByLogin | 533 |
| private | checkActivationKey() | Check Activation Key | 565 |
__construct()
public function __construct()
lines 26–29 (4)
Takes no parameters.
getUsers()
public function getUsers($orderBy = 'ID', $fetchMode = null)
lines 41–54 (14)
getUsers
list of users
| Parameter | Type | Default | Description |
|---|---|---|---|
$orderBy | (untyped) | 'ID' | none |
$fetchMode | (untyped) | null | none |
Returns: (none declared) — boolean|array|object
getUserById()
public function getUserById($userID, $sanitize, $fetchMode = null)
lines 66–80 (15)
getUserById
fetch single value of record by ID
| Parameter | Type | Default | Description |
|---|---|---|---|
$userID | (untyped) | required | none |
$sanitize | (untyped) | required | none |
$fetchMode | (untyped) | null | = null |
Returns: (none declared) — boolean|array|object
getUserByEmail()
public function getUserByEmail($user_email, $fetchMode = null)
lines 90–104 (15)
getUserByEmail()
| Parameter | Type | Default | Description |
|---|---|---|---|
$user_email | (untyped) | required | none |
$fetchMode | (untyped) | null | none |
Returns: (none declared) — boolean|array|object
getUserByLogin()
public function getUserByLogin($user_login, $fetchMode = null)
lines 116–129 (14)
getUserByLogin()
retrieving user record based on user_login
| Parameter | Type | Default | Description |
|---|---|---|---|
$user_login | (untyped) | required | none |
$fetchMode | (untyped) | null | none |
Returns: (none declared) — mixed
getUserBySession()
public function getUserBySession($user_session, $fetchMode = null)
lines 141–155 (15)
getUserBySession()
retrieving user record based on user_session
| Parameter | Type | Default | Description |
|---|---|---|---|
$user_session | (untyped) | required | none |
$fetchMode | (untyped) | null | none |
Returns: (none declared) — mixed
getUserByResetKey()
public function getUserByResetKey($reset_key, $fetchMode = null)
lines 164–174 (11)
get User by reset key
| Parameter | Type | Default | Description |
|---|---|---|---|
$reset_key | (untyped) | required | none |
$fetchMode | (untyped) | null | none |
Returns: (none declared) — mixed
createUser()
public function createUser($bind)
lines 183–217 (35)
Create user
insert new record
| Parameter | Type | Default | Description |
|---|---|---|---|
$bind | (untyped) | required | none |
Returns: (none declared)
updateUser()
public function updateUser($accessLevel, $sanitize, $bind, $userID)
lines 227–271 (45)
Update user
Modify user record in user table
| Parameter | Type | Default | Description |
|---|---|---|---|
$accessLevel | (untyped) | required | none |
$sanitize | (untyped) | required | none |
$bind | (untyped) | required | none |
$userID | (untyped) | required | none |
Returns: (none declared)
updateUserSession()
public function updateUserSession($bind, $userID)
lines 281–284 (4)
Update user session
| Parameter | Type | Default | Description |
|---|---|---|---|
$bind | (untyped) | required | none |
$userID | (untyped) | required | none |
Returns: (none declared)
updateResetKey()
public function updateResetKey($bind, $user_email)
lines 295–298 (4)
Update reset key
update temporary reset key to reset password with key sent to user email account
| Parameter | Type | Default | Description |
|---|---|---|---|
$bind | (untyped) | required | none |
$user_email | (untyped) | required | none |
Returns: (none declared)
recoverNewPassword()
public function recoverNewPassword($bind, $userID)
lines 307–311 (5)
Recover New password
| Parameter | Type | Default | Description |
|---|---|---|---|
$bind | (untyped) | required | none |
$userID | (untyped) | required | none |
Returns: (none declared)
activateUser()
public function activateUser($key)
lines 319–334 (16)
Activate user
| Parameter | Type | Default | Description |
|---|---|---|---|
$key | (untyped) | required | none |
Returns: (none declared) — int
deleteUser()
public function deleteUser($userID, $sanitize)
lines 353–358 (6)
deleteUser
Remove a user record. Returns whether at least one row was deleted so callers can distinguish a successful erasure from a no-op.
| Parameter | Type | Default | Description |
|---|---|---|---|
$userID | (untyped) | required | none |
$sanitize | (untyped) | required | Sanitizer instance |
Returns: (none declared) — bool True when a row was deleted, false otherwise
dropDownUserLevel()
public function dropDownUserLevel($selected = '')
lines 367–383 (17)
dropDownUserLevel
| Parameter | Type | Default | Description |
|---|---|---|---|
$selected | (untyped) | '''''' | none |
Returns: (none declared) — string
isUserLoginExists()
public function isUserLoginExists($user_login)
lines 393–400 (8)
isUserLoginExists
checking whether user_login record does exists
| Parameter | Type | Default | Description |
|---|---|---|---|
$user_login | (untyped) | required | none |
Returns: (none declared) — boolean
checkUserSession()
public function checkUserSession($user_session)
lines 411–421 (11)
checkUserSession
checking whether user_session availability
| Parameter | Type | Default | Description |
|---|---|---|---|
$user_session | (untyped) | required | none |
Returns: (none declared) — bool
checkUserEmail()
public function checkUserEmail($email)
lines 429–435 (7)
checking email
| Parameter | Type | Default | Description |
|---|---|---|---|
$email | (untyped) | required | none |
Returns: (none declared) — boolean
checkUserPassword()
public function checkUserPassword($login, $password)
lines 447–455 (9)
checkUserPassword
Checking user password
| Parameter | Type | Default | Description |
|---|---|---|---|
$login | (untyped) | required | none |
$password | (untyped) | required | none |
Returns: (none declared) — bool
checkUserId()
public function checkUserId($userID, $sanitize)
lines 464–476 (13)
checkUserId
| Parameter | Type | Default | Description |
|---|---|---|---|
$userID | (untyped) | required | none |
$sanitize | (untyped) | required | none |
Returns: (none declared) — numeric
totalUserRecords()
public function totalUserRecords(array $data = []): ?int
lines 485–492 (8)
Total user records
| Parameter | Type | Default | Description |
|---|---|---|---|
$data | array | [] | default = null |
Returns: ?int — integer
checkUserPasswordByEmail()
private function checkUserPasswordByEmail($login, $password)
lines 501–524 (24)
checkUserPasswordByEmail
| Parameter | Type | Default | Description |
|---|---|---|---|
$login | (untyped) | required | none |
$password | (untyped) | required | none |
Returns: (none declared) — bool
checkUserPasswordByLogin()
private function checkUserPasswordByLogin($login, $password)
lines 533–557 (25)
checkUserPasswordByLogin
| Parameter | Type | Default | Description |
|---|---|---|---|
$login | (untyped) | required | none |
$password | (untyped) | required | none |
Returns: (none declared) — bool
checkActivationKey()
private function checkActivationKey($key)
lines 565–576 (12)
Check Activation Key
| Parameter | Type | Default | Description |
|---|---|---|---|
$key | (untyped) | required | none |
Returns: (none declared) — false
Imports
| Alias | Fully-qualified name |
|---|---|
Dao | ''Scriptlog\Core\Dao'' |
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.
