AirLay backend

SubscriptionEntity extends DatabaseEntity
in package

Table of Contents

ALLOWED_PERIOD  = ['day', 'week', 'month']
ALLOWED_REPORT_TYPE  = ['ReportByObjectWithFilter', 'ReportByObjectWithValues', 'TemplateWithFilter', 'TemplateWithValues']
$_id  : ObjectId
$dataSetIds  : array<string|int, mixed>
$invitedUsers  : array<string|int, mixed>
$lastSend  : int
$name  : string
$organizationId  : ObjectId
$ownerId  : ObjectId
$period  : string
$report  : array<string|int, mixed>
$users  : array<string|int, mixed>
__construct()  : mixed
__toString()  : string
addInvitedUser()  : self
addUser()  : self
bsonSerialize()  : array<string|int, mixed>
bsonUnserialize()  : void
getDataSetIds()  : array<string|int, ObjectId>
getId()  : ObjectId
getInvitedUsers()  : array<string|int, ObjectId>
getLastSend()  : int
getName()  : string
getOrganizationId()  : ObjectId
getPeriod()  : string
getReport()  : array<string|int, mixed>
getUsers()  : array<string|int, mixed>
jsonSerialize()  : array<string|int, mixed>
parseObjectId()  : ObjectId|null
removeInvitedUser()  : self
removeUser()  : self
setDataSetIds()  : self
setId()  : self
setInvitedUsers()  : $this
setLastSend()  : self
setName()  : self
setOrganizationId()  : self
setPeriod()  : self
setReport()  : self
setUsers()  : $this
toArray()  : array<string|int, mixed>

Constants

ALLOWED_REPORT_TYPE

private mixed ALLOWED_REPORT_TYPE = ['ReportByObjectWithFilter', 'ReportByObjectWithValues', 'TemplateWithFilter', 'TemplateWithValues']

Properties

Methods

__construct()

public __construct(string $name, array<string|int, mixed> $dataSetIds, ObjectId $organizationId, ObjectId $ownerId, string $period[, ObjectId|null $id = null ]) : mixed
Parameters
$name : string
$dataSetIds : array<string|int, mixed>
$organizationId : ObjectId
$ownerId : ObjectId
$period : string
$id : ObjectId|null = null
Return values
mixed —

__toString()

public __toString() : string
Return values
string —

addInvitedUser()

public addInvitedUser(ObjectId $userId) : self
Parameters
$userId : ObjectId
Return values
self —

addUser()

public addUser(ObjectId $userId) : self
Parameters
$userId : ObjectId
Return values
self —

bsonSerialize()

public bsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —

bsonUnserialize()

public bsonUnserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

getDataSetIds()

public getDataSetIds() : array<string|int, ObjectId>
Return values
array<string|int, ObjectId> —

getInvitedUsers()

public getInvitedUsers() : array<string|int, ObjectId>
Return values
array<string|int, ObjectId> —

getOrganizationId()

public getOrganizationId() : ObjectId
Return values
ObjectId —

getReport()

public getReport() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUsers()

public getUsers() : array<string|int, mixed>
Return values
array<string|int, mixed> —

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —

parseObjectId()

public static parseObjectId(mixed $objectId) : ObjectId|null
Parameters
$objectId : mixed
Return values
ObjectId|null —

removeInvitedUser()

public removeInvitedUser(ObjectId $userId) : self
Parameters
$userId : ObjectId
Return values
self —

removeUser()

public removeUser(ObjectId $userId) : self
Parameters
$userId : ObjectId
Return values
self —

setDataSetIds()

public setDataSetIds(array<string|int, mixed> $dataSetIds) : self
Parameters
$dataSetIds : array<string|int, mixed>
Return values
self —

setId()

public setId(ObjectId $id) : self
Parameters
$id : ObjectId
Return values
self —

setInvitedUsers()

public setInvitedUsers(array<string|int, ObjectId> $invitedUsers) : $this
Parameters
$invitedUsers : array<string|int, ObjectId>
Return values
$this —

setLastSend()

public setLastSend(int $lastSend) : self
Parameters
$lastSend : int
Return values
self —

setName()

public setName(string $name) : self
Parameters
$name : string
Return values
self —

setOrganizationId()

public setOrganizationId(ObjectId $organizationId) : self
Parameters
$organizationId : ObjectId
Return values
self —

setPeriod()

public setPeriod(string $period) : self
Parameters
$period : string
Return values
self —

setReport()

public setReport(array<string|int, mixed> $report) : self
Parameters
$report : array<string|int, mixed>
Return values
self —

setUsers()

public setUsers(array<string|int, ObjectId> $users) : $this
Parameters
$users : array<string|int, ObjectId>
Return values
$this —

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results