Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools

You are here: start » scriptlog » lib » dao » userdao
Trace: • configurationservice
scriptlog:lib:dao:userdao

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
scriptlog:lib:dao:userdao [2026/09/26 09:09] – admin adminscriptlog:lib:dao:userdao [2026/09/26 09:34] (current) – admin admin
Line 15: Line 15:
 ======= Docblock Metadata ======= ======= Docblock Metadata =======
  
-  ^ Tag ^ Value ^ +^ Tag ^ Value ^ 
-  | ''@category'' | Dao Class | +| ''@category'' | Dao Class | 
-  | ''@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:dao|''Dao'']] | parent class/interface |+| extends | [[scriptlog:lib:core:dao|''Dao'']] | parent class/interface |
  
 ======= Constants (0) ======= ======= Constants (0) =======
Line 31: Line 31:
 //None.// //None.//
  
-======= Properties (0) =======+======= Properties (1) =======
  
-//None declared.//+^ Visibility ^ Type ^ Name ^ Default ^ Line ^ 
 +| ''private'' | ''(untyped)'' | ''$selected'' |  | 24 |
  
 ======= Methods (24) ======= ======= Methods (24) =======
  
-  ^ Visibility ^ Method ^ Summary ^ Line ^ +^ Visibility ^ Method ^ Summary ^ Line ^ 
-  | public | ''__construct()'' | (undocumented) | 26 | +| public | ''__construct()'' | (undocumented) | 26 | 
-  | public | ''getUsers()'' | getUsers | 41 | +| public | ''getUsers()'' | getUsers | 41 | 
-  | public | ''getUserById()'' | getUserById | 66 | +| public | ''getUserById()'' | getUserById | 66 | 
-  | public | ''getUserByEmail()'' | getUserByEmail() | 90 | +| public | ''getUserByEmail()'' | getUserByEmail() | 90 | 
-  | public | ''getUserByLogin()'' | getUserByLogin() | 116 | +| public | ''getUserByLogin()'' | getUserByLogin() | 116 | 
-  | public | ''getUserBySession()'' | getUserBySession() | 141 | +| public | ''getUserBySession()'' | getUserBySession() | 141 | 
-  | public | ''getUserByResetKey()'' | get User by reset key | 164 | +| public | ''getUserByResetKey()'' | get User by reset key | 164 | 
-  | public | ''createUser()'' | Create user | 183 | +| public | ''createUser()'' | Create user | 183 | 
-  | public | ''updateUser()'' | Update user | 227 | +| public | ''updateUser()'' | Update user | 227 | 
-  | public | ''updateUserSession()'' | Update user session | 281 | +| public | ''updateUserSession()'' | Update user session | 281 | 
-  | public | ''updateResetKey()'' | Update reset key | 295 | +| public | ''updateResetKey()'' | Update reset key | 295 | 
-  | public | ''recoverNewPassword()'' | Recover New password | 307 | +| public | ''recoverNewPassword()'' | Recover New password | 307 | 
-  | public | ''activateUser()'' | Activate user | 319 | +| public | ''activateUser()'' | Activate user | 319 | 
-  | public | ''deleteUser()'' | deleteUser | 353 | +| public | ''deleteUser()'' | deleteUser | 353 | 
-  | public | ''dropDownUserLevel()'' | dropDownUserLevel | 367 | +| public | ''dropDownUserLevel()'' | dropDownUserLevel | 367 | 
-  | public | ''isUserLoginExists()'' | isUserLoginExists | 393 | +| public | ''isUserLoginExists()'' | isUserLoginExists | 393 | 
-  | public | ''checkUserSession()'' | checkUserSession | 411 | +| public | ''checkUserSession()'' | checkUserSession | 411 | 
-  | public | ''checkUserEmail()'' | checking email | 429 | +| public | ''checkUserEmail()'' | checking email | 429 | 
-  | public | ''checkUserPassword()'' | checkUserPassword | 447 | +| public | ''checkUserPassword()'' | checkUserPassword | 447 | 
-  | public | ''checkUserId()'' | checkUserId | 464 | +| public | ''checkUserId()'' | checkUserId | 464 | 
-  | public | ''totalUserRecords()'' | Total user records | 485 | +| public | ''totalUserRecords()'' | Total user records | 485 | 
-  | private | ''checkUserPasswordByEmail()'' | checkUserPasswordByEmail | 501 | +| private | ''checkUserPasswordByEmail()'' | checkUserPasswordByEmail | 501 | 
-  | private | ''checkUserPasswordByLogin()'' | checkUserPasswordByLogin | 533 | +| private | ''checkUserPasswordByLogin()'' | checkUserPasswordByLogin | 533 | 
-  | private | ''checkActivationKey()'' | Check Activation Key | 565 |+| private | ''checkActivationKey()'' | Check Activation Key | 565 |
  
  
Line 87: Line 88:
 list of users list of users
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$orderBy'' | ''(untyped)'' | '''ID''' | //none// | +|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  //none// | 
-  | ''$fetchMode'' | ''(untyped)'' | ''null'' | //none// |+|  ''$fetchMode'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — boolean|array|object **Returns:** ''(none declared)'' — boolean|array|object
Line 106: Line 107:
 fetch single value of record by ID fetch single value of record by ID
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$userID'' | ''(untyped)'' | //required// | //none// | +|  ''$userID'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// | +|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$fetchMode'' | ''(untyped)'' | ''null'' | = null |+|  ''$fetchMode'' |  ''(untyped)'' |  ''null'' |  = null |
  
 **Returns:** ''(none declared)'' — boolean|array|object **Returns:** ''(none declared)'' — boolean|array|object
Line 124: Line 125:
 getUserByEmail() getUserByEmail()
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$user_email'' | ''(untyped)'' | //required// | //none// | +|  ''$user_email'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$fetchMode'' | ''(untyped)'' | ''null'' | //none// |+|  ''$fetchMode'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — boolean|array|object **Returns:** ''(none declared)'' — boolean|array|object
Line 143: Line 144:
 retrieving user record based on user_login retrieving user record based on user_login
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$user_login'' | ''(untyped)'' | //required// | //none// | +|  ''$user_login'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$fetchMode'' | ''(untyped)'' | ''null'' | //none// |+|  ''$fetchMode'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — mixed **Returns:** ''(none declared)'' — mixed
Line 162: Line 163:
 retrieving user record based on user_session retrieving user record based on user_session
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$user_session'' | ''(untyped)'' | //required// | //none// | +|  ''$user_session'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$fetchMode'' | ''(untyped)'' | ''null'' | //none// |+|  ''$fetchMode'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — mixed **Returns:** ''(none declared)'' — mixed
Line 179: Line 180:
 get User by reset key get User by reset key
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$reset_key'' | ''(untyped)'' | //required// | //none// | +|  ''$reset_key'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$fetchMode'' | ''(untyped)'' | ''null'' | //none// |+|  ''$fetchMode'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — mixed **Returns:** ''(none declared)'' — mixed
Line 198: Line 199:
 insert new record insert new record
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$bind'' | ''(untyped)'' | //required// | //none// |+|  ''$bind'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 216: Line 217:
 Modify user record in user table Modify user record in user table
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$accessLevel'' | ''(untyped)'' | //required// | //none// | +|  ''$accessLevel'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// | +|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$bind'' | ''(untyped)'' | //required// | //none// | +|  ''$bind'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$userID'' | ''(untyped)'' | //required// | //none// |+|  ''$userID'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 235: Line 236:
 Update user session Update user session
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$bind'' | ''(untyped)'' | //required// | //none// | +|  ''$bind'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$userID'' | ''(untyped)'' | //required// | //none// |+|  ''$userID'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 255: Line 256:
 to reset password with key sent to user email account to reset password with key sent to user email account
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$bind'' | ''(untyped)'' | //required// | //none// | +|  ''$bind'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$user_email'' | ''(untyped)'' | //required// | //none// |+|  ''$user_email'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 272: Line 273:
 Recover New password Recover New password
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$bind'' | ''(untyped)'' | //required// | //none// | +|  ''$bind'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$userID'' | ''(untyped)'' | //required// | //none// |+|  ''$userID'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 289: Line 290:
 Activate user Activate user
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$key'' | ''(untyped)'' | //required// | //none// |+|  ''$key'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — int **Returns:** ''(none declared)'' — int
Line 308: Line 309:
 callers can distinguish a successful erasure from a no-op. callers can distinguish a successful erasure from a no-op.
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$userID'' | ''(untyped)'' | //required// | //none// | +|  ''$userID'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | Sanitizer instance |+|  ''$sanitize'' |  ''(untyped)'' |  //required// |  Sanitizer instance |
  
 **Returns:** ''(none declared)'' — bool True when a row was deleted, false otherwise **Returns:** ''(none declared)'' — bool True when a row was deleted, false otherwise
Line 325: Line 326:
 dropDownUserLevel dropDownUserLevel
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$selected'' | ''(untyped)'' | '''''' | //none// |+|  ''$selected'' |  ''(untyped)'' |  '''''' |  //none// |
  
 **Returns:** ''(none declared)'' — string **Returns:** ''(none declared)'' — string
Line 343: Line 344:
 checking whether user_login record does exists checking whether user_login record does exists
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$user_login'' | ''(untyped)'' | //required// | //none// |+|  ''$user_login'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — boolean **Returns:** ''(none declared)'' — boolean
Line 361: Line 362:
 checking whether user_session availability checking whether user_session availability
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$user_session'' | ''(untyped)'' | //required// | //none// |+|  ''$user_session'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 377: Line 378:
 checking email checking email
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$email'' | ''(untyped)'' | //required// | //none// |+|  ''$email'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — boolean **Returns:** ''(none declared)'' — boolean
Line 395: Line 396:
 Checking user password Checking user password
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$login'' | ''(untyped)'' | //required// | //none// | +|  ''$login'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$password'' | ''(untyped)'' | //required// | //none// |+|  ''$password'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 412: Line 413:
 checkUserId checkUserId
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$userID'' | ''(untyped)'' | //required// | //none// | +|  ''$userID'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// |+|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — numeric **Returns:** ''(none declared)'' — numeric
Line 429: Line 430:
 Total user records Total user records
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$data'' | ''array'' | ''[]'' | default = null |+|  ''$data'' |  ''array'' |  ''[]'' |  default = null |
  
 **Returns:** ''?int'' — integer **Returns:** ''?int'' — integer
Line 445: Line 446:
 checkUserPasswordByEmail checkUserPasswordByEmail
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$login'' | ''(untyped)'' | //required// | //none// | +|  ''$login'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$password'' | ''(untyped)'' | //required// | //none// |+|  ''$password'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 462: Line 463:
 checkUserPasswordByLogin checkUserPasswordByLogin
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$login'' | ''(untyped)'' | //required// | //none// | +|  ''$login'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$password'' | ''(untyped)'' | //required// | //none// |+|  ''$password'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 479: Line 480:
 Check Activation Key Check Activation Key
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$key'' | ''(untyped)'' | //required// | //none// |+|  ''$key'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — false **Returns:** ''(none declared)'' — false
Line 486: Line 487:
 ======= Imports ======= ======= Imports =======
  
-  ^ Alias ^ Fully-qualified name ^ +^ Alias ^ Fully-qualified name ^ 
-  | ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] |+| ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] |
  
  
scriptlog/lib/dao/userdao.1790413761.txt.gz · Last modified: by admin