VuFind API Documentation

BackendManager
in package

Manager for search backends.

Tags
category

VuFind

author

David Maus maus@hab.de

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Main Site

Table of Contents

$listeners  : SplObjectStorage
Attached listeners.
$registry  : ServiceLocatorInterface
Backend registry.
__construct()  : void
Constructor.
attachShared()  : void
Attach to shared event manager.
detachShared()  : void
Detach from shared event manager.
get()  : BackendInterface
Return named backend.
getBackendRegistry()  : ServiceLocatorInterface
Return backend registry.
has()  : bool
Return true if named backend is available.
onResolve()  : BackendInterface|null
Listener for search system event `resolve`.

Properties

$listeners

Attached listeners.

protected SplObjectStorage $listeners

$registry

Backend registry.

protected ServiceLocatorInterface $registry

Methods

__construct()

Constructor.

public __construct(ServiceLocatorInterface $registry) : void
Parameters
$registry : ServiceLocatorInterface

Backend registry

Return values
void

attachShared()

Attach to shared event manager.

public attachShared(SharedEventManagerInterface $events) : void
Parameters
$events : SharedEventManagerInterface

Shared event manager

Return values
void

detachShared()

Detach from shared event manager.

public detachShared(SharedEventManagerInterface $events) : void
Parameters
$events : SharedEventManagerInterface

Shared event manager

Return values
void

get()

Return named backend.

public get(string $name) : BackendInterface
Parameters
$name : string

Backend name

Tags
throws
UnexpectedValueException

Retrieved backend is not an object

throws
UnexpectedValueException

Retrieved backend does not implement BackendInterface

Return values
BackendInterface

getBackendRegistry()

Return backend registry.

public getBackendRegistry() : ServiceLocatorInterface
Return values
ServiceLocatorInterface

has()

Return true if named backend is available.

public has(string $name) : bool
Parameters
$name : string

Backend name

Return values
bool

Search results