VuFind API Documentation

TermsCommand extends CallMethodCommand
in package

Fetch terms from the backend (currently only supported by Solr)

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link
https://vufind.org

Table of Contents

$backendId  : string
Search backend identifier
$context  : mixed
Command context
$executed  : bool
Was the command executed?
$extraRequestDetails  : array<string|int, mixed>|null
Optional search details.
$field  : string
Index field.
$interface  : string
Search backend interface
$limit  : int
Maximum number of terms.
$method  : string
Search backend interface method
$params  : ParamBag
Search backend parameters
$result  : mixed
Result of executed operation
$start  : string
Starting term.
__construct()  : mixed
Constructor.
execute()  : CommandInterface
Execute command on backend.
getArguments()  : array<string|int, mixed>
Return search backend interface method arguments.
getContext()  : mixed
Return command context.
getExtraRequestDetails()  : array<string|int, mixed>|null
Get extra request details.
getField()  : string
Return index field.
getLimit()  : int
Return maximum number of terms.
getResult()  : mixed
Return result of executed operation.
getSearchParameters()  : ParamBag
Return search parameters.
getStart()  : string
Return starting term.
getTargetIdentifier()  : string
Return target backend identifier.
isExecuted()  : bool
Was the command executed?
setContext()  : void
Set command context.
setSearchParameters()  : void
Set search parameters.
setTargetIdentifier()  : void
Set target backend identifier.
finalizeExecution()  : CommandInterface
Save a result, flag the command as executed, and return the command object; useful as the final step in execute() implementations.
validateBackend()  : void
Validate that the provided backend matches the expected target identifier.

Properties

$backendId

Search backend identifier

protected string $backendId

$executed

Was the command executed?

protected bool $executed = false

$extraRequestDetails

Optional search details.

protected array<string|int, mixed>|null $extraRequestDetails = null

$result

Result of executed operation

protected mixed $result

Methods

__construct()

Constructor.

public __construct(string $backendId, string $field, string $start, int $limit[, ParamBag|null $params = null ]) : mixed
Parameters
$backendId : string

Search backend identifier

$field : string

Index field

$start : string

Starting term (blank for beginning of list)

$limit : int

Maximum number of terms

$params : ParamBag|null = null

Search backend parameters

Return values
mixed

getArguments()

Return search backend interface method arguments.

public getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>

getContext()

Return command context.

public getContext() : mixed
Return values
mixed

getExtraRequestDetails()

Get extra request details.

public getExtraRequestDetails() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getField()

Return index field.

public getField() : string
Return values
string

getLimit()

Return maximum number of terms.

public getLimit() : int
Return values
int

getResult()

Return result of executed operation.

public getResult() : mixed
Tags
throws
LogicException

Command was not yet executed

Return values
mixed

getStart()

Return starting term.

public getStart() : string
Return values
string

getTargetIdentifier()

Return target backend identifier.

public getTargetIdentifier() : string
Return values
string

isExecuted()

Was the command executed?

public isExecuted() : bool
Return values
bool

setContext()

Set command context.

public setContext(mixed $context) : void
Parameters
$context : mixed

Context

Return values
void

setSearchParameters()

Set search parameters.

public setSearchParameters(ParamBag $params) : void
Parameters
$params : ParamBag

Params

Return values
void

setTargetIdentifier()

Set target backend identifier.

public setTargetIdentifier(string $identifier) : void
Parameters
$identifier : string

New identifier

Return values
void

finalizeExecution()

Save a result, flag the command as executed, and return the command object; useful as the final step in execute() implementations.

protected finalizeExecution(mixed $result) : CommandInterface
Parameters
$result : mixed

Result of execution.

Return values
CommandInterface

Search results