Nextcloud PHP API (master)

AutoCompleteEvent extends GenericEvent
in package

Class GenericEvent

Tags
since
16.0.0
deprecated

Use AutoCompleteFilterEvent instead

Table of Contents

Properties

$arguments  : mixed
$subject  : mixed
$propagationStopped  : bool

Methods

__construct()  : mixed
Encapsulate an event with $subject and $args.
getArgument()  : mixed
Get argument by key.
getArguments()  : array<string|int, mixed>
Getter for all arguments.
getItemId()  : string
getItemType()  : string
getIterator()  : Traversable
Retrieve an external iterator
getLimit()  : int
getResults()  : array<string|int, mixed>
getSearchTerm()  : string
getShareTypes()  : array<string|int, int>
getSorter()  : string
getSubject()  : mixed
Getter for subject property.
hasArgument()  : bool
Has argument.
isPropagationStopped()  : bool
{@inheritDoc}
offsetExists()  : bool
Whether a offset exists
offsetGet()  : mixed
Offset to retrieve
offsetSet()  : void
Offset to set
offsetUnset()  : void
Offset to unset
setArgument()  : GenericEvent
Add argument to event.
setArguments()  : GenericEvent
Set args property.
setResults()  : void
stopPropagation()  : void
Stops the propagation of the event to further event listeners

Properties

$arguments

protected mixed $arguments
Tags
deprecated
22.0.0

$subject

protected mixed $subject
Tags
deprecated
22.0.0

$propagationStopped

private bool $propagationStopped = false
Tags
since
22.0.0

Methods

__construct()

Encapsulate an event with $subject and $args.

public __construct(array<string|int, mixed> $arguments) : mixed
Parameters
$arguments : array<string|int, mixed>
Tags
since
16.0.0

getArgument()

Get argument by key.

public getArgument(string $key) : mixed
Parameters
$key : string
Tags
throws
InvalidArgumentException

if key is not found

since
18.0.0
deprecated
22.0.0

getArguments()

Getter for all arguments.

public getArguments() : array<string|int, mixed>
Tags
since
18.0.0
deprecated
22.0.0
Return values
array<string|int, mixed>

getItemId()

public getItemId() : string
Tags
since
16.0.0
Return values
string

getItemType()

public getItemType() : string
Tags
since
16.0.0
Return values
string

getResults()

public getResults() : array<string|int, mixed>
Tags
since
16.0.0
Return values
array<string|int, mixed>

getSearchTerm()

public getSearchTerm() : string
Tags
since
16.0.0
Return values
string

getShareTypes()

public getShareTypes() : array<string|int, int>
Tags
since
16.0.0
Return values
array<string|int, int>

getSorter()

public getSorter() : string
Tags
since
16.0.0
Return values
string

getSubject()

Getter for subject property.

public getSubject() : mixed
Tags
since
18.0.0
deprecated
22.0.0

hasArgument()

Has argument.

public hasArgument(mixed $key) : bool
Parameters
$key : mixed
Tags
since
18.0.0
deprecated
22.0.0
Return values
bool

isPropagationStopped()

{@inheritDoc}

public isPropagationStopped() : bool
Tags
since
22.0.0
see
StoppableEventInterface
Return values
bool

setArgument()

Add argument to event.

public setArgument(mixed $key, mixed $value) : GenericEvent
Parameters
$key : mixed
$value : mixed
Tags
since
18.0.0
deprecated
22.0.0
Return values
GenericEvent

setArguments()

Set args property.

public setArguments([array<string|int, mixed> $args = [] ]) : GenericEvent
Parameters
$args : array<string|int, mixed> = []
Tags
since
18.0.0
deprecated
22.0.0
Return values
GenericEvent

setResults()

public setResults(array<string|int, mixed> $results) : void
Parameters
$results : array<string|int, mixed>
Tags
since
16.0.0

stopPropagation()

Stops the propagation of the event to further event listeners

public stopPropagation() : void
Tags
since
22.0.0

        
On this page

Search results