PinCodeService
extends AirlayService
in package
Class PinCodeService
Table of Contents
- $ : AirlayConfig
- $collection : PinCodeCollection
- $rabbitmq : AMQPStreamConnection
- $user : UserEntity
- $collection : mixed
- $attemptCount : int
- $pinCodeAttemptDelay : int
- $pinCodeExpire : int
- __construct() : mixed
- confirmTotp() : void
- createPinCode() : PinCodeEntity
- deletePinCodeById() : void
- deletePinCodeByUserId() : void
- emailPinCodeVerify() : array<string|int, mixed>
- findPinCodeById() : PinCodeEntity|null
- getCollection() : mixed
- insertPinCode() : void
- totpAuth() : array<string|int, mixed>
- verificationPinCode() : bool
- generatePinCode() : int
- isExceededAttemptCount() : bool
- isExpired() : bool
Properties
$
public
AirlayConfig
$
config
$collection
public
PinCodeCollection
$collection
$rabbitmq
public
AMQPStreamConnection
$rabbitmq
$user
public
UserEntity
$user
$collection
protected
mixed
$collection
$attemptCount
private
int
$attemptCount
$pinCodeAttemptDelay
private
int
$pinCodeAttemptDelay
$pinCodeExpire
private
int
$pinCodeExpire
Methods
__construct()
public
__construct(mixed $collection) : mixed
Parameters
- $collection : mixed
Return values
mixed —confirmTotp()
public
confirmTotp(ObjectId $userId, string $pinCode) : void
Parameters
- $userId : ObjectId
- $pinCode : string
Return values
void —createPinCode()
public
createPinCode(ObjectId $userId) : PinCodeEntity
Parameters
- $userId : ObjectId
Return values
PinCodeEntity —deletePinCodeById()
public
deletePinCodeById(ObjectId $id) : void
Parameters
- $id : ObjectId
Return values
void —deletePinCodeByUserId()
public
deletePinCodeByUserId(ObjectId $userId) : void
Parameters
- $userId : ObjectId
Return values
void —emailPinCodeVerify()
public
emailPinCodeVerify(ObjectId $userId, string $username, ObjectId $pinCodeId, int $pin) : array<string|int, mixed>
Parameters
- $userId : ObjectId
- $username : string
- $pinCodeId : ObjectId
- $pin : int
Return values
array<string|int, mixed> —findPinCodeById()
public
findPinCodeById(ObjectId $id) : PinCodeEntity|null
Parameters
- $id : ObjectId
Return values
PinCodeEntity|null —getCollection()
public
getCollection() : mixed
Return values
mixed —insertPinCode()
public
insertPinCode(PinCodeEntity $pinCode) : void
Parameters
- $pinCode : PinCodeEntity
Return values
void —totpAuth()
public
totpAuth(ObjectId $userId, string $username, int $pin) : array<string|int, mixed>
Parameters
- $userId : ObjectId
- $username : string
- $pin : int
Return values
array<string|int, mixed> —verificationPinCode()
public
verificationPinCode(ObjectId $userId, int $pin, PinCodeEntity $pinCode) : bool
Parameters
- $userId : ObjectId
- $pin : int
- $pinCode : PinCodeEntity
Return values
bool —generatePinCode()
private
generatePinCode() : int
Return values
int —isExceededAttemptCount()
private
isExceededAttemptCount(PinCodeEntity $pinCode) : bool
Parameters
- $pinCode : PinCodeEntity
Return values
bool —isExpired()
private
isExpired(PinCodeEntity $pinCode) : bool
Parameters
- $pinCode : PinCodeEntity