Documentation

Auth
in package
Uses Attempt

Class AuthServiceProvider

Güvenilir ve hızlı kimlik doğrulama araçları sunar.

Table of Contents

$userWhere  : array<string|int, mixed>
login olacak kulanıcılarda aranan temel kriterler
$app  : App
$attempt  : bool
$attemptMax  : int
$attemptTimeout  : int
$multiDevice  : bool
$sessionNotStored  : array<string|int, mixed>
$table  : string
$tokenName  : string
$user  : object|null
__construct()  : mixed
authSession()  : bool|mixed
check()  : bool
Oturumunun başlatılıp başlatılmadığını kontrol eder.
generateUserSessions()  : mixed
Kullanıcı session bilgilerini oluşturur
guard()  : bool
$gruopName group ismi veya group isimlerinden oluşan bir dizi olabilir.
login()  : bool
loginWithEmail()  : bool
loginWithEmailOrUserName()  : bool
loginWithUserName()  : bool
logout()  : mixed
Kullanıcının çıkış işlemini gerçekleştirir.
permission()  : bool
$permissions bir izin adı veya izinlerden oluşan bir dizi Belirtilen tüm izinlere sahipse true aksi ahalde false döner
rememberMe()  : false
role()  : bool|mixed
roleName()  : null|string
Sessiondan yetki seviyesini döndürür.
user()  : object|null
userID()  : bool|int
Sessiondan id değerini döndürür.
clearAttempt()  : mixed
kullanıcı giriş haklarını sıfırlar
cookie()  : Cookie
createToken()  : string
Cookie doğrulaması useragent ile token oluşturur.
creatRememberCookie()  : mixed
Beni hatırla seçeneği için cookie oluşturur.
findUser()  : array<string|int, mixed>|mixed|string|array<string|int, string>
Token ile login olacak kullanıcı bilgileri
findUserWithPassword()  : array<string|int, mixed>|mixed|string|array<string|int, string>|null
Password ile login olacak kullanıcı bilgileri
getRoleName()  : mixed
hash()  : string
request()  : Request
session()  : Session
table()  : QueryBuilder
userPermissions()  : array<string|int, mixed>
Gruba ait izin ve bilgileri döndürür
cache()  : CacheInterface
checkAttempt()  : bool
kullanıcı giriş deneme haklarını tüketmişse true döner
setAttempt()  : mixed
Giriş deneme sayısını arttırır

Properties

$userWhere

login olacak kulanıcılarda aranan temel kriterler

public array<string|int, mixed> $userWhere = ['deleted_at' => null, 'status' => 1]

$attempt

protected bool $attempt = true

$attemptMax

protected int $attemptMax = 3

$attemptTimeout

protected int $attemptTimeout = 60

$multiDevice

protected bool $multiDevice = true

$sessionNotStored

protected array<string|int, mixed> $sessionNotStored = ['password']

$table

protected string $table = 'users'

$tokenName

protected string $tokenName = 'user_token'

$user

protected object|null $user = null

Methods

authSession()

public authSession( $key[, null $value = null ]) : bool|mixed
Parameters
$key :
$value : null = null
Return values
bool|mixed

check()

Oturumunun başlatılıp başlatılmadığını kontrol eder.

public check() : bool
Return values
bool

generateUserSessions()

Kullanıcı session bilgilerini oluşturur

public generateUserSessions( $user) : mixed
Parameters
$user :
Return values
mixed

guard()

$gruopName group ismi veya group isimlerinden oluşan bir dizi olabilir.

public guard(string|array<string|int, mixed> $roleName) : bool

KUllanıcı bu gruoplardan birine aitse true aksi halde false döner.

Parameters
$roleName : string|array<string|int, mixed>
Return values
bool

login()

public login(string $password[, array<string|int, mixed> $userInfo = [] ], int|DateInterval|Era $remember) : bool
Parameters
$password : string
$userInfo : array<string|int, mixed> = []
$remember : int|DateInterval|Era
Tags
throws
AuthError
throws
SqlErrorException
Return values
bool

loginWithEmail()

public loginWithEmail(string $password, string $email, int|DateInterval|Era $remember[, array<string|int, mixed> $where = [] ]) : bool
Parameters
$password : string
$email : string
$remember : int|DateInterval|Era
$where : array<string|int, mixed> = []
Tags
throws
AuthError
Return values
bool

loginWithEmailOrUserName()

public loginWithEmailOrUserName(string $password, string $userNameOrEmail, int|DateInterval|Era $remember[, array<string|int, mixed> $where = [] ]) : bool
Parameters
$password : string
$userNameOrEmail : string
$remember : int|DateInterval|Era
$where : array<string|int, mixed> = []
Tags
throws
AuthError
Return values
bool

loginWithUserName()

public loginWithUserName(string $password, string $userName, int|DateInterval|Era $remember[, array<string|int, mixed> $where = [] ]) : bool
Parameters
$password : string
$userName : string
$remember : int|DateInterval|Era
$where : array<string|int, mixed> = []
Tags
throws
AuthError
Return values
bool

logout()

Kullanıcının çıkış işlemini gerçekleştirir.

public logout([bool $clear_all = false ]) : mixed

{false} girilir yada boş bırakılırsa AUTH bilgileri silinir. {true girilirse} kullanıcıya ait tüm bilgiler silinir.

Parameters
$clear_all : bool = false
Return values
mixed

permission()

$permissions bir izin adı veya izinlerden oluşan bir dizi Belirtilen tüm izinlere sahipse true aksi ahalde false döner

public permission(string|array<string|int, mixed> $permissions) : bool
Parameters
$permissions : string|array<string|int, mixed>
Return values
bool

role()

public role() : bool|mixed
Return values
bool|mixed

roleName()

Sessiondan yetki seviyesini döndürür.

public roleName() : null|string
Return values
null|string

Sessiona ulaşamazsa false döndürür.

user()

public user() : object|null
Return values
object|null

userID()

Sessiondan id değerini döndürür.

public userID() : bool|int
Return values
bool|int

clearAttempt()

kullanıcı giriş haklarını sıfırlar

protected clearAttempt(string $string) : mixed
Parameters
$string : string
Return values
mixed

createToken()

Cookie doğrulaması useragent ile token oluşturur.

protected createToken( $user) : string
Parameters
$user :
Return values
string

creatRememberCookie()

Beni hatırla seçeneği için cookie oluşturur.

protected creatRememberCookie(string $token, int|DateInterval|Era $lifetime) : mixed
Parameters
$token : string
$lifetime : int|DateInterval|Era

strtottime veya int saniye

Return values
mixed

findUser()

Token ile login olacak kullanıcı bilgileri

protected findUser(array<string|int, mixed> $userInfo) : array<string|int, mixed>|mixed|string|array<string|int, string>
Parameters
$userInfo : array<string|int, mixed>
Tags
throws
SqlErrorException
Return values
array<string|int, mixed>|mixed|string|array<string|int, string>

findUserWithPassword()

Password ile login olacak kullanıcı bilgileri

protected findUserWithPassword(string $password, array<string|int, mixed> $userInfo) : array<string|int, mixed>|mixed|string|array<string|int, string>|null
Parameters
$password : string
$userInfo : array<string|int, mixed>
Tags
throws
AuthError
throws
SqlErrorException
Return values
array<string|int, mixed>|mixed|string|array<string|int, string>|null

getRoleName()

protected getRoleName(mixed $roleID) : mixed
Parameters
$roleID : mixed
Tags
throws
SqlErrorException
Return values
mixed

hash()

protected hash(string $string) : string
Parameters
$string : string
Return values
string

userPermissions()

Gruba ait izin ve bilgileri döndürür

protected userPermissions(mixed $roleID) : array<string|int, mixed>
Parameters
$roleID : mixed
Return values
array<string|int, mixed>

[groupID, groupName, permissions]

checkAttempt()

kullanıcı giriş deneme haklarını tüketmişse true döner

private checkAttempt(string $string) : bool
Parameters
$string : string
Return values
bool

setAttempt()

Giriş deneme sayısını arttırır

private setAttempt(string $string) : mixed
Parameters
$string : string
Return values
mixed

Search results