AutoCompleteFilterEvent
extends Event
in package
Base event class for the event dispatcher service
Tags
Attributes
- #[Consumable]
- $since: '28.0.0'
Table of Contents
Properties
- $itemId : string|null
- $itemType : string|null
- $limit : int
- $results : array<string|int, mixed>
- $search : string
- $shareTypes : array<string|int, mixed>
- $sorter : string|null
Methods
- __construct() : mixed
- Compatibility constructor
- getItemId() : string|null
- getItemType() : string|null
- getLimit() : int
- getResults() : T
- getSearchTerm() : string
- getShareTypes() : array<string|int, int>
- getSorter() : string|null
- isPropagationStopped() : bool
- {@inheritDoc}
- setResults() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$itemId
protected
string|null
$itemId
$itemType
protected
string|null
$itemType
$limit
protected
int
$limit
$results
protected
array<string|int, mixed>
$results
$search
protected
string
$search
$shareTypes
protected
array<string|int, mixed>
$shareTypes
$sorter
protected
string|null
$sorter
Methods
__construct()
Compatibility constructor
public
__construct(T $results, string $search, string|null $itemType, string|null $itemId, string|null $sorter, array<string|int, mixed> $shareTypes, int $limit) : mixed
Parameters
- $results : T
- $search : string
- $itemType : string|null
- $itemId : string|null
- $sorter : string|null
- $shareTypes : array<string|int, mixed>
- $limit : int
Tags
getItemId()
public
getItemId() : string|null
Tags
Return values
string|nullgetItemType()
public
getItemType() : string|null
Tags
Return values
string|nullgetLimit()
public
getLimit() : int
Unused
Tags
Return values
intgetResults()
public
getResults() : T
Tags
Return values
TgetSearchTerm()
public
getSearchTerm() : string
Tags
Return values
stringgetShareTypes()
public
getShareTypes() : array<string|int, int>
Tags
Return values
array<string|int, int> —List of \OCP\Share\IShare::TYPE_* constants
getSorter()
public
getSorter() : string|null
Unused
Tags
Return values
string|null —List of desired sort identifiers, top priority first. When multiple are given they are joined with a pipe: commenters|share-recipients
isPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Attributes
- #[Override]
Return values
boolsetResults()
public
setResults(T $results) : void
Parameters
- $results : T
Tags
stopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void