VuFind API Documentation

History
in package

VuFind Search History Helper

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

author

Sebastian Böttger boettger@hebis.uni-frankfurt.de

license

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

link

Main Page

Table of Contents

$config  : Config|null
$resultsManager  : PluginManager
$searchService  : SearchServiceInterface
$sessionId  : string
__construct()  : mixed
History constructor
getScheduleOptions()  : array<string|int, mixed>
Get a list of scheduling options (empty list if scheduling disabled).
getSearchHistory()  : array<string|int, mixed>
Get the user's saved and temporary search histories.
purgeSearchHistory()  : void
Purge the user's unsaved search history.

Properties

$config

protected Config|null $config = null

$sessionId

protected string $sessionId

Methods

__construct()

History constructor

public __construct(SearchServiceInterface $searchService, string $sessionId, PluginManager $resultsManager[, Config|null $config = null ]) : mixed
Parameters
$searchService : SearchServiceInterface

Search table

$sessionId : string

Session ID

$resultsManager : PluginManager

Results manager

$config : Config|null = null

Configuration

Return values
mixed —

getScheduleOptions()

Get a list of scheduling options (empty list if scheduling disabled).

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

getSearchHistory()

Get the user's saved and temporary search histories.

public getSearchHistory([int $userId = null ]) : array<string|int, mixed>
Parameters
$userId : int = null

User ID (null if logged out)

Return values
array<string|int, mixed> —

purgeSearchHistory()

Purge the user's unsaved search history.

public purgeSearchHistory([int $userId = null ]) : void
Parameters
$userId : int = null

User ID (null if logged out)

Return values
void —

Search results