Authentication

Layer: Core · Source: lib/core/Authentication.php:22 (lines 22–663)

class Authentication

Docblock Metadata

Tag	Value
`@category`	Core Class
`@author`	M.Noermoehammad
`@license`	MIT
`@version`	1.0
`@since`	Since Release 1.0

Inheritance

No parent, interface or trait. This is a root type.

Constants (2)

Visibility	Name	Value	Line
`-`	`COOKIE_EXPIRE`	`2_592_000;`	127
`-`	`COOKIE_PATH`	'`/';`	134

Properties (12)

Visibility	Type	Name	Default	Line
`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)

Visibility	Method	Summary	Line
public	`__construct()`	(undocumented)	136
public	`findUserById()`	findUserById	170
public	`findUserByEmail()`	findUserByEmail	182
public	`findUserByLogin()`	findUserByLogin()	194
public	`findTokenByLogin()`	findTokenByLogin	207
public	`markCookieAsExpired()`	markCookieAsExpired	219
public	`renewPersistentLogin()`	setPersistentLoginCookie	232
public	`checkEmailExists()`	Is Email Exists	244
public	`accessLevel()`	Checking access level	260
public	`login()`	Login	290
public	`logout()`	logout	366
public	`validateUserAccount()`	validateUserAccount	441
private	`resolveUserLogin()`	Resolve user login by email or username	456
public	`resetUserPassword()`	ResetUserPassword	477
public	`updateNewPassword()`	UpdateNewPassword	502
public	`removeCookies()`	Remove cookies	523
public	`clearAuthCookies()`	clearAuthCookies	538
private	`clearAllAuthCookies()`	Clear all auth cookies with PHP version compatibility	551
public	`activateUserAccount()`	Activate user account	581
public	`userAccessControl()`	userAccessControl	599
private	`checkAccessByLevel()`	(undocumented)	608
private	`requireLevel()`	(undocumented)	636
protected	`getUserAuthSession()`	getUserAuthSession()	649

__construct()

public function __construct(UserDao $userDao, UserTokenDao $userToken, FormValidator $validator)

lines 136–161 (26)

Parameter	Type	Default	Description
`$userDao`	''UserDao''	required	none
`$userToken`	''UserTokenDao''	required	none
`$validator`	''FormValidator''	required	none

findUserById()

public function findUserById($id)

lines 170–173 (4)

findUserById

Parameter	Type	Default	Description
`$id`	`(untyped)`	required	none

Returns: (none declared) — array

findUserByEmail()

public function findUserByEmail($email)

lines 182–185 (4)

findUserByEmail

Parameter	Type	Default	Description
`$email`	`(untyped)`	required	none

Returns: (none declared) — array

findUserByLogin()

public function findUserByLogin($user_login)

lines 194–197 (4)

findUserByLogin()

Parameter	Type	Default	Description
`$user_login`	`(untyped)`	required	none

Returns: (none declared) — mixed

findTokenByLogin()

public function findTokenByLogin($login, $expired)

lines 207–210 (4)

findTokenByLogin

Parameter	Type	Default	Description
`$login`	`(untyped)`	required	none
`$expired`	`(untyped)`	required	none

Returns: (none declared) — mixed

markCookieAsExpired()

public function markCookieAsExpired($tokenId)

lines 219–222 (4)

markCookieAsExpired

Parameter	Type	Default	Description
`$tokenId`	`(untyped)`	required	none

Returns: (none declared) — void

renewPersistentLogin()

public function renewPersistentLogin($bind, $login)

lines 232–235 (4)

setPersistentLoginCookie

Parameter	Type	Default	Description
`$bind`	`(untyped)`	required	none
`$login`	`(untyped)`	required	none

Returns: (none declared) — void

checkEmailExists()

public function checkEmailExists($email)

lines 244–252 (9)

Is Email Exists

Parameter	Type	Default	Description
`$email`	`(untyped)`	required	none

Returns: (none declared) — true|false

accessLevel()

public function accessLevel()

lines 260–277 (18)

Checking access level

Takes no parameters.

Returns: (none declared) — bool|string|void

public function login(array $values)

lines 290–356 (67)

Parameter	Type	Default	Description
`$values`	`array`	required	none

Returns: (none declared)

logout()

public function logout()

lines 366–430 (65)

Takes no parameters.

Returns: (none declared) — void

validateUserAccount()

public function validateUserAccount($login, $password)

lines 441–451 (11)

validateUserAccount

Parameter	Type	Default	Description
`$login`	`(untyped)`	required	none
`$password`	`(untyped)`	required	none

Returns: (none declared) — boolean

resolveUserLogin()

private function resolveUserLogin($login)

lines 456–466 (11)

Resolve user login by email or username

Parameter	Type	Default	Description
`$login`	`(untyped)`	required	none

Returns: (none declared)

resetUserPassword()

public function resetUserPassword($user_email)

lines 477–491 (15)

ResetUserPassword

updating reset key and send notification to user

Parameter	Type	Default	Description
`$user_email`	`(untyped)`	required	none

Returns: (none declared)

updateNewPassword()

public function updateNewPassword($user_pass, $user_id, $user_email)

lines 502–515 (14)

UpdateNewPassword

Recovering user password

Parameter	Type	Default	Description
`$user_pass`	`(untyped)`	required	none
`$user_id`	`(untyped)`	required	none
`$user_email`	`(untyped)`	required	none

Returns: (none declared)

removeCookies()

public function removeCookies()

lines 523–530 (8)

Remove cookies

removing cookies when logging out from administrator page

Takes no parameters.

Returns: (none declared)

clearAuthCookies()

public function clearAuthCookies($user_login)

lines 538–546 (9)

clearAuthCookies

Parameter	Type	Default	Description
`$user_login`	`(untyped)`	required	none

Returns: (none declared)

clearAllAuthCookies()

private function clearAllAuthCookies()

lines 551–572 (22)

Clear all auth cookies with PHP version compatibility

Takes no parameters.

Returns: (none declared)

activateUserAccount()

public function activateUserAccount($key)

lines 581–591 (11)

Activate user account

user activation

Parameter	Type	Default	Description
`$key`	`(untyped)`	required	none

Returns: (none declared)

userAccessControl()

public function userAccessControl($control = null)

lines 599–606 (8)

userAccessControl

Parameter	Type	Default	Description
`$control`	`(untyped)`	`null`	none

Returns: (none declared)

checkAccessByLevel()

private function checkAccessByLevel($control, $level)

lines 608–634 (27)

Parameter	Type	Default	Description
`$control`	`(untyped)`	required	none
`$level`	`(untyped)`	required	none

Returns: (none declared)

requireLevel()

private function requireLevel($level, array $allowed)

lines 636–639 (4)

Parameter	Type	Default	Description
`$level`	`(untyped)`	required	none
`$allowed`	`array`	required	none

Returns: (none declared)

getUserAuthSession()

protected function getUserAuthSession()

lines 649–662 (14)

getUserAuthSession()

Takes no parameters.

Returns: (none declared) — void

Imports

Alias	Fully-qualified name
`Key`	`Defuse\Crypto\Key`
`UserDao`	''Scriptlog\Dao\UserDao''
`UserTokenDao`	''Scriptlog\Dao\UserTokenDao''

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

Table of Contents

Authentication

Docblock Metadata

Inheritance

Constants (2)

Properties (12)

Methods (23)

__construct()

findUserById()

findUserByEmail()

findUserByLogin()

findTokenByLogin()

markCookieAsExpired()

renewPersistentLogin()

checkEmailExists()

accessLevel()

login()

logout()

validateUserAccount()

resolveUserLogin()

resetUserPassword()

updateNewPassword()

removeCookies()

clearAuthCookies()

clearAllAuthCookies()

activateUserAccount()

userAccessControl()

checkAccessByLevel()

requireLevel()

getUserAuthSession()

Imports