Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools

You are here: start » scriptlog » lib » core » authentication
Trace: • sidebarviewmodel
scriptlog:lib:core:authentication

Differences

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

Link to this comparison view

Next revision		Previous revision
scriptlog:lib:core:authentication [2026/09/26 09:09] – admin adminscriptlog:lib:core:authentication [2026/09/26 09:34] (current) – admin admin
Line 10: Line 10:
 ======= Docblock Metadata ======= ======= Docblock Metadata =======
  
-  ^ Tag ^ Value ^ +^ Tag ^ Value ^ 
-  | ''@category'' | Core Class | +| ''@category'' | Core 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 =======
Line 23: Line 23:
 ======= Constants (2) ======= ======= Constants (2) =======
  
-  ^ Visibility ^ Name ^ Value ^ Line ^ +^ Visibility ^ Name ^ Value ^ Line ^ 
-  | ''-'' | ''COOKIE_EXPIRE'' | ''2_592_000;'' | 127 | +| ''-'' | ''COOKIE_EXPIRE'' | ''2_592_000;'' | 127 | 
-  | ''-'' | ''COOKIE_PATH'' | '''/';'' | 134 |+| ''-'' | ''COOKIE_PATH'' | '''/';'' | 134 |
  
-======= Properties (1) =======+======= Properties (12) =======
  
-  ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ +^ Visibility ^ Type ^ Name ^ Default ^ Line ^ 
-  | ''private'' | ''(untyped)'' | ''$account_info'' | ''[];'' | 30 |+| ''private'' | ''(untyped)'' | ''$account_info'' | ''[]'' | 30 | 
 +| ''private'' | ''(untyped)'' | ''$session_cookies'' |  | 38 | 
 +| ''private'' | ''(untyped)'' | ''$user_login'' |  | 46 | 
 +| ''private'' | ''(untyped)'' | ''$agent'' |  | 54 | 
 +| ''private'' | ''(untyped)'' | ''$accept_charset'' |  | 62 | 
 +| ''private'' | ''(untyped)'' | ''$accept_language'' |  | 70 | 
 +| ''private'' | ''(untyped)'' | ''$accept_encoding'' |  | 78 | 
 +| ''private'' | ''(untyped)'' | ''$ip_address'' |  | 86 | 
 +| ''private'' | ''Key'' | ''$key'' |  | 94 | 
 +| ''private'' | ''(untyped)'' | ''$userDao'' |  | 102 | 
 +| ''private'' | ''(untyped)'' | ''$userToken'' |  | 110 | 
 +| ''private'' | ''(untyped)'' | ''$validator'' |  | 118 |
  
 ======= Methods (23) ======= ======= Methods (23) =======
  
-  ^ Visibility ^ Method ^ Summary ^ Line ^ +^ Visibility ^ Method ^ Summary ^ Line ^ 
-  | public | ''__construct()'' | (undocumented) | 136 | +| public | ''__construct()'' | (undocumented) | 136 | 
-  | public | ''findUserById()'' | findUserById | 170 | +| public | ''findUserById()'' | findUserById | 170 | 
-  | public | ''findUserByEmail()'' | findUserByEmail | 182 | +| public | ''findUserByEmail()'' | findUserByEmail | 182 | 
-  | public | ''findUserByLogin()'' | findUserByLogin() | 194 | +| public | ''findUserByLogin()'' | findUserByLogin() | 194 | 
-  | public | ''findTokenByLogin()'' | findTokenByLogin | 207 | +| public | ''findTokenByLogin()'' | findTokenByLogin | 207 | 
-  | public | ''markCookieAsExpired()'' | markCookieAsExpired | 219 | +| public | ''markCookieAsExpired()'' | markCookieAsExpired | 219 | 
-  | public | ''renewPersistentLogin()'' | setPersistentLoginCookie | 232 | +| public | ''renewPersistentLogin()'' | setPersistentLoginCookie | 232 | 
-  | public | ''checkEmailExists()'' | Is Email Exists | 244 | +| public | ''checkEmailExists()'' | Is Email Exists | 244 | 
-  | public | ''accessLevel()'' | Checking access level | 260 | +| public | ''accessLevel()'' | Checking access level | 260 | 
-  | public | ''login()'' | Login | 290 | +| public | ''login()'' | Login | 290 | 
-  | public | ''logout()'' | logout | 366 | +| public | ''logout()'' | logout | 366 | 
-  | public | ''validateUserAccount()'' | validateUserAccount | 441 | +| public | ''validateUserAccount()'' | validateUserAccount | 441 | 
-  | private | ''resolveUserLogin()'' | Resolve user login by email or username | 456 | +| private | ''resolveUserLogin()'' | Resolve user login by email or username | 456 | 
-  | public | ''resetUserPassword()'' | ResetUserPassword | 477 | +| public | ''resetUserPassword()'' | ResetUserPassword | 477 | 
-  | public | ''updateNewPassword()'' | UpdateNewPassword | 502 | +| public | ''updateNewPassword()'' | UpdateNewPassword | 502 | 
-  | public | ''removeCookies()'' | Remove cookies | 523 | +| public | ''removeCookies()'' | Remove cookies | 523 | 
-  | public | ''clearAuthCookies()'' | clearAuthCookies | 538 | +| public | ''clearAuthCookies()'' | clearAuthCookies | 538 | 
-  | private | ''clearAllAuthCookies()'' | Clear all auth cookies with PHP version compatibility | 551 | +| private | ''clearAllAuthCookies()'' | Clear all auth cookies with PHP version compatibility | 551 | 
-  | public | ''activateUserAccount()'' | Activate user account | 581 | +| public | ''activateUserAccount()'' | Activate user account | 581 | 
-  | public | ''userAccessControl()'' | userAccessControl | 599 | +| public | ''userAccessControl()'' | userAccessControl | 599 | 
-  | private | ''checkAccessByLevel()'' | (undocumented) | 608 | +| private | ''checkAccessByLevel()'' | (undocumented) | 608 | 
-  | private | ''requireLevel()'' | (undocumented) | 636 | +| private | ''requireLevel()'' | (undocumented) | 636 | 
-  | protected | ''getUserAuthSession()'' | getUserAuthSession() | 649 |+| protected | ''getUserAuthSession()'' | getUserAuthSession() | 649 |
  
  
Line 68: Line 79:
 //lines 136–161 (26)// //lines 136–161 (26)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$userDao'' | [[scriptlog:lib:dao:userdao|''UserDao'']] | //required// | //none// | +|  ''$userDao'' |  [[scriptlog:lib:dao:userdao|''UserDao'']] |  //required// |  //none// | 
-  | ''$userToken'' | [[scriptlog:lib:dao:usertokendao|''UserTokenDao'']] | //required// | //none// | +|  ''$userToken'' |  [[scriptlog:lib:dao:usertokendao|''UserTokenDao'']] |  //required// |  //none// | 
-  | ''$validator'' | [[scriptlog:lib:core:formvalidator|''FormValidator'']] | //required// | //none// |+|  ''$validator'' |  [[scriptlog:lib:core:formvalidator|''FormValidator'']] |  //required// |  //none// |
  
  
Line 84: Line 95:
 findUserById findUserById
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$id'' | ''(untyped)'' | //required// | //none// |+|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 100: Line 111:
 findUserByEmail findUserByEmail
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$email'' | ''(untyped)'' | //required// | //none// |+|  ''$email'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 116: Line 127:
 findUserByLogin() findUserByLogin()
  
-  ^ 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
Line 132: Line 143:
 findTokenByLogin findTokenByLogin
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$login'' | ''(untyped)'' | //required// | //none// | +|  ''$login'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$expired'' | ''(untyped)'' | //required// | //none// |+|  ''$expired'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — mixed **Returns:** ''(none declared)'' — mixed
Line 149: Line 160:
 markCookieAsExpired markCookieAsExpired
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$tokenId'' | ''(untyped)'' | //required// | //none// |+|  ''$tokenId'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — void **Returns:** ''(none declared)'' — void
Line 165: Line 176:
 setPersistentLoginCookie setPersistentLoginCookie
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$bind'' | ''(untyped)'' | //required// | //none// | +|  ''$bind'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$login'' | ''(untyped)'' | //required// | //none// |+|  ''$login'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — void **Returns:** ''(none declared)'' — void
Line 182: Line 193:
 Is Email Exists Is Email Exists
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$email'' | ''(untyped)'' | //required// | //none// |+|  ''$email'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — true|false **Returns:** ''(none declared)'' — true|false
Line 213: Line 224:
 Login Login
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$values'' | ''array'' | //required// | //none// |+|  ''$values'' |  ''array'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 242: Line 253:
 validateUserAccount validateUserAccount
  
-  ^ 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)'' — boolean **Returns:** ''(none declared)'' — boolean
Line 259: Line 270:
 Resolve user login by email or username Resolve user login by email or username
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$login'' | ''(untyped)'' | //required// | //none// |+|  ''$login'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 277: Line 288:
 updating reset key and send notification to user updating reset key and send notification to user
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$user_email'' | ''(untyped)'' | //required// | //none// |+|  ''$user_email'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 295: Line 306:
 Recovering user password Recovering user password
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$user_pass'' | ''(untyped)'' | //required// | //none// | +|  ''$user_pass'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$user_id'' | ''(untyped)'' | //required// | //none// | +|  ''$user_id'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$user_email'' | ''(untyped)'' | //required// | //none// |+|  ''$user_email'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 331: Line 342:
 clearAuthCookies clearAuthCookies
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$user_login'' | ''(untyped)'' | //required// | //none// |+|  ''$user_login'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 364: Line 375:
 user activation user activation
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$key'' | ''(untyped)'' | //required// | //none// |+|  ''$key'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 380: Line 391:
 userAccessControl userAccessControl
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$control'' | ''(untyped)'' | ''null'' | //none// |+|  ''$control'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 394: Line 405:
 //lines 608–634 (27)// //lines 608–634 (27)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$control'' | ''(untyped)'' | //required// | //none// | +|  ''$control'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$level'' | ''(untyped)'' | //required// | //none// |+|  ''$level'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 409: Line 420:
 //lines 636–639 (4)// //lines 636–639 (4)//
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$level'' | ''(untyped)'' | //required// | //none// | +|  ''$level'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$allowed'' | ''array'' | //required// | //none// |+|  ''$allowed'' |  ''array'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 432: Line 443:
 ======= Imports ======= ======= Imports =======
  
-  ^ Alias ^ Fully-qualified name ^ +^ Alias ^ Fully-qualified name ^ 
-  | ''Key'' | ''Defuse\Crypto\Key'' | +| ''Key'' | ''Defuse\Crypto\Key'' | 
-  | ''UserDao'' | [[scriptlog:lib:dao:userdao|''Scriptlog\Dao\UserDao'']] | +| ''UserDao'' | [[scriptlog:lib:dao:userdao|''Scriptlog\Dao\UserDao'']] | 
-  | ''UserTokenDao'' | [[scriptlog:lib:dao:usertokendao|''Scriptlog\Dao\UserTokenDao'']] |+| ''UserTokenDao'' | [[scriptlog:lib:dao:usertokendao|''Scriptlog\Dao\UserTokenDao'']] |
  
  
scriptlog/lib/core/authentication.1790413761.txt.gz · Last modified: by admin