EmbargoService
in package
Embargo Service.
Manages embargoes on objects.
Table of Contents
Methods
- create() : int
- Create embargo.
- getActiveEmbargoes() : array<string|int, mixed>
- Get all active embargoes.
- getEmbargo() : object|null
- Get embargo for object.
- getExpiringEmbargoes() : Collection
- Get expiring embargoes.
- getStats() : array<string|int, mixed>
- Get embargo statistics.
- isEmbargoed() : bool
- Check if object is embargoed.
- processExpiredEmbargoes() : int
- Process auto-releasing expired embargoes.
- remove() : bool
- Remove embargo.
- update() : bool
- Update embargo.
Methods
create()
Create embargo.
public
create(array<string|int, mixed> $data) : int
Parameters
- $data : array<string|int, mixed>
Return values
intgetActiveEmbargoes()
Get all active embargoes.
public
getActiveEmbargoes([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>getEmbargo()
Get embargo for object.
public
getEmbargo(int $objectId) : object|null
Parameters
- $objectId : int
Return values
object|nullgetExpiringEmbargoes()
Get expiring embargoes.
public
getExpiringEmbargoes([int $days = 30 ]) : Collection
Parameters
- $days : int = 30
Return values
CollectiongetStats()
Get embargo statistics.
public
getStats() : array<string|int, mixed>
Return values
array<string|int, mixed>isEmbargoed()
Check if object is embargoed.
public
isEmbargoed(int $objectId) : bool
Parameters
- $objectId : int
Return values
boolprocessExpiredEmbargoes()
Process auto-releasing expired embargoes.
public
processExpiredEmbargoes() : int
Return values
intremove()
Remove embargo.
public
remove(int $id) : bool
Parameters
- $id : int
Return values
boolupdate()
Update embargo.
public
update(int $id, array<string|int, mixed> $data) : bool
Parameters
- $id : int
- $data : array<string|int, mixed>