QrAuthRecord
extends Model
in package
Table of Contents
- STATUS_DONE = 'done'
- STATUS_PIN_CREATED = 'pinCreated'
- STATUS_PIN_ENTERED = 'pinEntered'
- STATUS_QRID_CREATED = 'qrIdCreated'
- STATUS_MAP = [self::STATUS_QRID_CREATED => 0, self::STATUS_PIN_CREATED => 1, self::STATUS_PIN_ENTERED => 2, self::STATUS_DONE => 3]
- $baseOptions : array<string|int, mixed>
- $baseSort : array<string|int, mixed>
- $collectionName : string
- add() : bool|array<string|int, mixed>
- addMany() : bool
- aggregate() : array<string|int, mixed>
- create() : mixed
- deleteById() : bool
- deleteMany() : bool
- deleteOne() : bool
- doneAuth() : bool
- enterPin() : bool
- find() : array<string|int, mixed>
- Поиск объекта в бд по фильтру.
- findAll() : array<string|int, mixed>
- findById() : object|bool|array<string|int, mixed>
- findByPinId() : mixed
- findOne() : object|bool|array<string|int, mixed>
- generatePin() : void
- getCursor() : Cursor
- getExpireTime() : UTCDateTime
- getPermissionMask() : array<string|int, mixed>
- getPin() : string
- getPinId() : ObjectId
- getQrId() : ObjectId
- getStatus() : string
- getUserId() : ObjectId
- isExpired() : bool
- isStatusGreaterThan() : mixed
- isStatusLessThan() : mixed
- save() : bool
- update() : bool
- updateMany() : bool
- getCollection() : Collection
- getConfig() : AirlayConfig
- getMongoDbManager() : Manager
Constants
STATUS_DONE
public
mixed
STATUS_DONE
= 'done'
STATUS_PIN_CREATED
public
mixed
STATUS_PIN_CREATED
= 'pinCreated'
STATUS_PIN_ENTERED
public
mixed
STATUS_PIN_ENTERED
= 'pinEntered'
STATUS_QRID_CREATED
public
mixed
STATUS_QRID_CREATED
= 'qrIdCreated'
STATUS_MAP
private
mixed
STATUS_MAP
= [self::STATUS_QRID_CREATED => 0, self::STATUS_PIN_CREATED => 1, self::STATUS_PIN_ENTERED => 2, self::STATUS_DONE => 3]
Properties
$baseOptions
public
static array<string|int, mixed>
$baseOptions
= ['typeMap' => ['root' => 'array', 'document' => 'array', 'array' => 'array'], 'sort' => ['_id' => 1]]
$baseSort
public
static array<string|int, mixed>
$baseSort
= ['_id' => 1]
$collectionName
public
static string
$collectionName
= 'qrAuthCollection'
Methods
add()
public
static add(array<string|int, mixed> $object) : bool|array<string|int, mixed>
Parameters
- $object : array<string|int, mixed>
Return values
bool|array<string|int, mixed> —addMany()
public
static addMany(array<string|int, mixed> $objects) : bool
Parameters
- $objects : array<string|int, mixed>
Return values
bool —aggregate()
public
static aggregate(array<string|int, mixed> $aggregate[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $aggregate : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —create()
public
static create(mixed $userId, mixed $timeout) : mixed
Parameters
- $userId : mixed
- $timeout : mixed
Return values
mixed —deleteById()
public
static deleteById(ObjectId $id) : bool
Parameters
- $id : ObjectId
Return values
bool —deleteMany()
public
static deleteMany(array<string|int, mixed> $filter) : bool
Parameters
- $filter : array<string|int, mixed>
Return values
bool —deleteOne()
public
static deleteOne(mixed $filter) : bool
Parameters
- $filter : mixed
Return values
bool —doneAuth()
public
static doneAuth(mixed $obj) : bool
Parameters
- $obj : mixed
Return values
bool —enterPin()
public
static enterPin(mixed $obj, string $pin) : bool
Parameters
- $obj : mixed
- $pin : string
Return values
bool —find()
Поиск объекта в бд по фильтру.
public
static find([array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $filter : array<string|int, mixed> = []
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —findAll()
public
static findAll([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —findById()
public
static findById(ObjectId|int $id[, array<string|int, mixed> $options = [] ]) : object|bool|array<string|int, mixed>
Parameters
- $id : ObjectId|int
- $options : array<string|int, mixed> = []
Return values
object|bool|array<string|int, mixed> —findByPinId()
public
static findByPinId(mixed $pinId) : mixed
Parameters
- $pinId : mixed
Return values
mixed —findOne()
public
static findOne(array<string|int, mixed> $filter[, array<string|int, mixed> $options = [] ]) : object|bool|array<string|int, mixed>
Parameters
- $filter : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
object|bool|array<string|int, mixed> —generatePin()
public
static generatePin(mixed $obj) : void
Parameters
- $obj : mixed
Return values
void —getCursor()
public
static getCursor() : Cursor
Return values
Cursor —getExpireTime()
public
static getExpireTime(mixed $obj) : UTCDateTime
Parameters
- $obj : mixed
Return values
UTCDateTime —getPermissionMask()
public
static getPermissionMask() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPin()
public
static getPin(mixed $obj) : string
Parameters
- $obj : mixed
Return values
string —getPinId()
public
static getPinId(mixed $obj) : ObjectId
Parameters
- $obj : mixed
Return values
ObjectId —getQrId()
public
static getQrId(mixed $obj) : ObjectId
Parameters
- $obj : mixed
Return values
ObjectId —getStatus()
public
static getStatus(mixed $obj) : string
Parameters
- $obj : mixed
Return values
string —getUserId()
public
static getUserId(mixed $obj) : ObjectId
Parameters
- $obj : mixed
Return values
ObjectId —isExpired()
public
static isExpired(mixed $obj) : bool
Parameters
- $obj : mixed
Return values
bool —isStatusGreaterThan()
public
static isStatusGreaterThan(mixed $obj, mixed $status) : mixed
Parameters
- $obj : mixed
- $status : mixed
Return values
mixed —isStatusLessThan()
public
static isStatusLessThan(mixed $obj, mixed $status) : mixed
Parameters
- $obj : mixed
- $status : mixed
Return values
mixed —save()
public
static save(array<string|int, mixed> $objects) : bool
Parameters
- $objects : array<string|int, mixed>
Return values
bool —update()
public
static update(array<string|int, mixed> $filter, array<string|int, mixed> $query[, array<string|int, mixed> $options = [] ]) : bool
Parameters
- $filter : array<string|int, mixed>
- $query : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
bool —updateMany()
public
static updateMany(array<string|int, mixed> $filter, array<string|int, mixed> $query[, array<string|int, mixed> $options = [] ]) : bool
Parameters
- $filter : array<string|int, mixed>
- $query : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
bool —getCollection()
protected
static getCollection() : Collection
Return values
Collection —getConfig()
protected
static getConfig() : AirlayConfig
Return values
AirlayConfig —getMongoDbManager()
protected
static getMongoDbManager() : Manager