VuFind API Documentation

IndexFactory
in package
implements FactoryInterface

Index-based generator plugin factory

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link

Wiki

Interfaces, Classes, Traits and Enums

FactoryInterface

Table of Contents

__invoke()  : object
Create an object
getBackendSettings()  : array<string|int, mixed>
Process backend configuration into a convenient array.
getIdFetcher()  : AbstractIdFetcher
Get the helper object for generating sitemaps through the search service.

Methods

__invoke()

Create an object

public __invoke(ContainerInterface $container, string $requestedName[, null|array<string|int, mixed> $options = null ]) : object
Parameters
$container : ContainerInterface

Service manager

$requestedName : string

Service being created

$options : null|array<string|int, mixed> = null

Extra options (optional)

Tags
throws
ServiceNotFoundException

if unable to resolve the service.

throws
ServiceNotCreatedException

if an exception is raised when creating a service.

throws
ContainerExceptionInterface|Throwable

if any other error occurs

Return values
object

getBackendSettings()

Process backend configuration into a convenient array.

protected getBackendSettings(Config $config) : array<string|int, mixed>
Parameters
$config : Config

Sitemap config

Return values
array<string|int, mixed>

getIdFetcher()

Get the helper object for generating sitemaps through the search service.

protected getIdFetcher(ContainerInterface $container, string $retrievalMode) : AbstractIdFetcher
Parameters
$container : ContainerInterface

Service manager

$retrievalMode : string

Retrieval mode ('terms' or 'search')

Return values
AbstractIdFetcher

Search results