Service
in package
Uses
SearchBackendEventManagerTrait
Search service.
Tags
Table of Contents
- EVENT_ERROR = 'error'
- EVENT_POST = 'post'
- EVENT_PRE = 'pre'
- Event identifiers.
- EVENT_RESOLVE = 'resolve'
- $backends : array<string|int, mixed>
- Cache resolved backends.
- $events : EventManager
- Event manager.
- __construct() : void
- Constructor.
- getEventManager() : EventManagerInterface
- Return EventManager instance.
- invoke() : CommandInterface
- Invoke a command.
- setEventManager() : void
- Set EventManager instance.
- triggerError() : void
- Trigger the error event.
- resolve() : BackendInterface
- Resolve a backend.
- triggerPost() : void
- Trigger the post event.
- triggerPre() : void
- Trigger the pre event.
Constants
EVENT_ERROR
public
mixed
EVENT_ERROR
= 'error'
EVENT_POST
public
mixed
EVENT_POST
= 'post'
EVENT_PRE
Event identifiers.
public
string
EVENT_PRE
= 'pre'
EVENT_RESOLVE
public
mixed
EVENT_RESOLVE
= 'resolve'
Properties
$backends
Cache resolved backends.
protected
array<string|int, mixed>
$backends
$events
Event manager.
protected
EventManager
$events
Methods
__construct()
Constructor.
public
__construct([EventManagerInterface|null $events = null ]) : void
Parameters
- $events : EventManagerInterface|null = null
-
Event manager (optional)
Return values
void —getEventManager()
Return EventManager instance.
public
getEventManager() : EventManagerInterface
Lazy loads a new EventManager if none was set.
Return values
EventManagerInterface —invoke()
Invoke a command.
public
invoke(CommandInterface $command) : CommandInterface
Parameters
- $command : CommandInterface
-
Command
Return values
CommandInterface —setEventManager()
Set EventManager instance.
public
setEventManager(EventManagerInterface $events) : void
Parameters
- $events : EventManagerInterface
-
Event manager
Return values
void —triggerError()
Trigger the error event.
public
triggerError(mixed $target, array<string|int, mixed> $args) : void
Parameters
- $target : mixed
-
Service instance, or error exception for deprecated legacy events
- $args : array<string|int, mixed>
-
Event arguments
Return values
void —resolve()
Resolve a backend.
protected
resolve(string $backendId, array<string|int, mixed>|ArrayAccess $args) : BackendInterface
Parameters
- $backendId : string
-
Backend name
- $args : array<string|int, mixed>|ArrayAccess
-
Service function arguments
Tags
Return values
BackendInterface —triggerPost()
Trigger the post event.
protected
triggerPost(mixed $target, array<string|int, mixed> $args) : void
Parameters
- $target : mixed
-
Service instance, or backend response for deprecated legacy events
- $args : array<string|int, mixed>
-
Event arguments
Return values
void —triggerPre()
Trigger the pre event.
protected
triggerPre(mixed $target, array<string|int, mixed> $args) : void
Parameters
- $target : mixed
-
Service instance, or backend instance for deprecated legacy events
- $args : array<string|int, mixed>
-
Event arguments