GetTaskProcessingProvidersEvent
extends Event
in package
Event dispatched by the server to collect Task Processing Providers and custom Task Types from listeners (like AppAPI).
Listeners should add their providers and task types using the addProvider() and addTaskType() methods.
Tags
Table of Contents
Properties
- $propagationStopped : bool
- $providers : array<string|int, IProvider>
- $taskTypes : array<string|int, ITaskType>
Methods
- __construct() : mixed
- Compatibility constructor
- addProvider() : void
- Add a Task Processing Provider.
- addTaskType() : void
- Add a custom Task Processing Task Type.
- getProviders() : array<string|int, IProvider>
- Get all collected Task Processing Providers.
- getTaskTypes() : array<string|int, ITaskType>
- Get all collected custom Task Processing Task Types.
- isPropagationStopped() : bool
- {@inheritDoc}
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$propagationStopped
private
bool
$propagationStopped
= false
Tags
$providers
private
array<string|int, IProvider>
$providers
= []
$taskTypes
private
array<string|int, ITaskType>
$taskTypes
= []
Methods
__construct()
Compatibility constructor
public
__construct() : mixed
In Nextcloud 17.0.0 this event class used a now deprecated/removed Symfony base class that had a constructor (with default arguments). To lower the risk of a breaking change (PHP won't allow parent constructor calls if there is none), this empty constructor's only purpose is to hopefully not break existing sub- classes of this class.
Tags
addProvider()
Add a Task Processing Provider.
public
addProvider(IProvider $provider) : void
Parameters
- $provider : IProvider
-
The provider instance to add.
Tags
addTaskType()
Add a custom Task Processing Task Type.
public
addTaskType(ITaskType $taskType) : void
Parameters
- $taskType : ITaskType
-
The task type instance to add.
Tags
getProviders()
Get all collected Task Processing Providers.
public
getProviders() : array<string|int, IProvider>
Tags
Return values
array<string|int, IProvider>getTaskTypes()
Get all collected custom Task Processing Task Types.
public
getTaskTypes() : array<string|int, ITaskType>
Tags
Return values
array<string|int, ITaskType>isPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Return values
boolstopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void