VuFind API Documentation

CommandInterface
in

Command interface definition.

Tags
category

VuFind

author

David Maus maus@hab.de

author

Aleksi Peebles aleksi.peebles@helsinki.fi

license

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

link
https://vufind.org

Table of Contents

execute()  : CommandInterface
Execute command on backend.
getContext()  : mixed
Return command context.
getResult()  : mixed
Return result of executed operation.
getSearchParameters()  : ParamBag
Return search parameters.
getTargetIdentifier()  : string
Return target backend identifier.
isExecuted()  : bool
Was the command executed?

Methods

getContext()

Return command context.

public getContext() : mixed
Return values
mixed

getResult()

Return result of executed operation.

public getResult() : mixed
Tags
throws
LogicException

Command was not yet executed

Return values
mixed

getTargetIdentifier()

Return target backend identifier.

public getTargetIdentifier() : string
Return values
string

isExecuted()

Was the command executed?

public isExecuted() : bool
Return values
bool

Search results