GSUpstreamService
in package
Uses
TNCRequest
Class GSUpstreamService
Table of Contents
- $circlesRequest : DeprecatedCirclesRequest
- $configService : ConfigService
- $eventWrapperRequest : EventWrapperRequest
- $globalScaleService : GlobalScaleService
- $membersRequest : DeprecatedMembersRequest
- $miscService : MiscService
- $urlGenerator : IURLGenerator
- $userId : string
- __construct() : mixed
- GSUpstreamService constructor.
- broadcastEvent() : void
- broadcastWrapper() : void
- clientService() : IClientService
- confirmCircleStatus() : bool
- confirmEvent() : void
- doRequest() : void
- getEventsByToken() : array<string|int, GSWrapper>
- manageResults() : void
- should be used to manage results from events, like sending mails on user creation
- newEvent() : string
- retrieveJson() : array<string|int, mixed>
- setMaxDownloadSize() : mixed
- syncEvents() : mixed
- checkCircle() : void
- generationClientOptions() : mixed
- isLocalEvent() : bool
- We check that the event can be managed/checked locally or if the owner of the circle belongs to an other instance of Nextcloud
- removeDeprecatedCircles() : mixed
- removeDeprecatedEvents() : mixed
- signEvent() : mixed
- useClient() : IResponse
Properties
$circlesRequest
private
DeprecatedCirclesRequest
$circlesRequest
$configService
private
ConfigService
$configService
$eventWrapperRequest
private
EventWrapperRequest
$eventWrapperRequest
$globalScaleService
private
GlobalScaleService
$globalScaleService
$membersRequest
private
DeprecatedMembersRequest
$membersRequest
$miscService
private
MiscService
$miscService
$urlGenerator
private
IURLGenerator
$urlGenerator
$userId
private
string
$userId
= ''
Methods
__construct()
GSUpstreamService constructor.
public
__construct( $userId, IURLGenerator $urlGenerator, EventWrapperRequest $eventWrapperRequest, DeprecatedCirclesRequest $circlesRequest, DeprecatedMembersRequest $membersRequest, GlobalScaleService $globalScaleService, ConfigService $configService, MiscService $miscService) : mixed
Parameters
- $userId :
- $urlGenerator : IURLGenerator
- $eventWrapperRequest : EventWrapperRequest
- $circlesRequest : DeprecatedCirclesRequest
- $membersRequest : DeprecatedMembersRequest
- $globalScaleService : GlobalScaleService
- $configService : ConfigService
- $miscService : MiscService
Return values
mixed —broadcastEvent()
public
broadcastEvent(GSEvent $event, string $instance) : void
Parameters
- $event : GSEvent
- $instance : string
Tags
Return values
void —broadcastWrapper()
public
broadcastWrapper(GSWrapper $wrapper) : void
Parameters
- $wrapper : GSWrapper
Return values
void —clientService()
public
clientService() : IClientService
Return values
IClientService —confirmCircleStatus()
public
confirmCircleStatus(DeprecatedCircle $circle) : bool
Parameters
- $circle : DeprecatedCircle
Tags
Return values
bool —confirmEvent()
public
confirmEvent(GSEvent &$event) : void
Parameters
- $event : GSEvent
Tags
Return values
void —doRequest()
public
doRequest(NCRequest $request[, bool $exceptionOnIssue = true ]) : void
Parameters
- $request : NCRequest
- $exceptionOnIssue : bool = true
Tags
Return values
void —getEventsByToken()
public
getEventsByToken(string $token) : array<string|int, GSWrapper>
Parameters
- $token : string
Tags
Return values
array<string|int, GSWrapper> —manageResults()
should be used to manage results from events, like sending mails on user creation
public
manageResults(string $token) : void
Parameters
- $token : string
Return values
void —newEvent()
public
newEvent(GSEvent $event) : string
Parameters
- $event : GSEvent
Tags
Return values
string —retrieveJson()
public
retrieveJson(NCRequest $request) : array<string|int, mixed>
Parameters
- $request : NCRequest
Tags
Return values
array<string|int, mixed> —setMaxDownloadSize()
public
setMaxDownloadSize(int $size) : mixed
Parameters
- $size : int
Return values
mixed —syncEvents()
public
syncEvents() : mixed
Tags
Return values
mixed —checkCircle()
private
checkCircle(DeprecatedCircle $circle) : void
Parameters
- $circle : DeprecatedCircle
Tags
Return values
void —generationClientOptions()
private
generationClientOptions(NCRequest $request) : mixed
Parameters
- $request : NCRequest
Return values
mixed —isLocalEvent()
We check that the event can be managed/checked locally or if the owner of the circle belongs to an other instance of Nextcloud
private
isLocalEvent(GSEvent $event) : bool
Parameters
- $event : GSEvent
Return values
bool —removeDeprecatedCircles()
private
removeDeprecatedCircles() : mixed
Return values
mixed —removeDeprecatedEvents()
private
removeDeprecatedEvents() : mixed
Return values
mixed —signEvent()
private
signEvent(GSEvent $event) : mixed
Parameters
- $event : GSEvent
Return values
mixed —useClient()
private
useClient(NCRequest $request) : IResponse
Parameters
- $request : NCRequest