SubscriptionService
extends AirlayService
in package
Class SubscriptionService
Table of Contents
- $ : AirlayConfig
- $collection : SubscriptionCollection
- $rabbitmq : AMQPStreamConnection
- $user : UserEntity
- $collection : mixed
- __construct() : mixed
- confirmUser() : void
- create() : SubscriptionEntity
- getCollection() : mixed
- invite() : void
- rejectUser() : void
- removeUser() : void
- unsubscribe() : void
- update() : void
- parseReport() : array<string|int, mixed>
Properties
$
public
AirlayConfig
$
config
$collection
public
SubscriptionCollection
$collection
$rabbitmq
public
AMQPStreamConnection
$rabbitmq
$user
public
UserEntity
$user
$collection
protected
mixed
$collection
Methods
__construct()
public
__construct(mixed $collection) : mixed
Parameters
- $collection : mixed
Return values
mixed —confirmUser()
public
confirmUser(ObjectId $id, ObjectId $userId, ObjectId|null $organizationId) : void
Parameters
- $id : ObjectId
- $userId : ObjectId
- $organizationId : ObjectId|null
Return values
void —create()
public
create(ObjectId $ownerId, ObjectId $organizationId, array<string|int, mixed> $dataSetIds, array<string|int, mixed> $report, string $period) : SubscriptionEntity
Parameters
- $ownerId : ObjectId
- $organizationId : ObjectId
- $dataSetIds : array<string|int, mixed>
- $report : array<string|int, mixed>
- $period : string
Return values
SubscriptionEntity —getCollection()
public
getCollection() : mixed
Return values
mixed —invite()
public
invite(ObjectId $id, ObjectId $ownerId, ObjectId $userId, ObjectId $organizationId) : void
Parameters
- $id : ObjectId
- $ownerId : ObjectId
- $userId : ObjectId
- $organizationId : ObjectId
Return values
void —rejectUser()
public
rejectUser(ObjectId $id, ObjectId $userId, ObjectId|null $organizationId) : void
Parameters
- $id : ObjectId
- $userId : ObjectId
- $organizationId : ObjectId|null
Return values
void —removeUser()
public
removeUser(ObjectId $id, ObjectId $ownerId, ObjectId $userId[, ObjectId|null $organizationId = null ]) : void
Parameters
- $id : ObjectId
- $ownerId : ObjectId
- $userId : ObjectId
- $organizationId : ObjectId|null = null
Return values
void —unsubscribe()
public
unsubscribe(ObjectId $id, ObjectId $userId[, ObjectId|null $organizationId = null ]) : void
Parameters
- $id : ObjectId
- $userId : ObjectId
- $organizationId : ObjectId|null = null
Return values
void —update()
public
update(ObjectId $id, ObjectId $ownerId[, ObjectId|null $organizationId = null ][, string|null $name = null ][, string|null $period = null ]) : void
Parameters
- $id : ObjectId
- $ownerId : ObjectId
- $organizationId : ObjectId|null = null
- $name : string|null = null
- $period : string|null = null
Return values
void —parseReport()
private
parseReport(array<string|int, mixed> $report) : array<string|int, mixed>
Parameters
- $report : array<string|int, mixed>