VuFind API Documentation

GetVisData extends AbstractBase
in package

"Get Visualization Data" AJAX handler

AJAX for timeline feature (PubDateVisAjax)

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

author

Chris Hallberg crhallberg@gmail.com

author

Till Kinstler kinstler@gbv.de

license

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

link

Wiki

Table of Contents

$results  : Results
Solr search results object
$sessionSettings  : Settings
Session settings
__construct()  : mixed
Constructor
handleRequest()  : array<string|int, mixed>
Handle a request.
disableSessionWrites()  : void
Prevent session writes -- this is designed to be called prior to time- consuming AJAX operations to help reduce the odds of a timing-related bug that causes the wrong version of session data to be written to disk (see VUFIND-716 for more details).
formatResponse()  : array<string|int, mixed>
Format a response array.
processDateFacets()  : array<string|int, mixed>
Extract details from applied filters.
processFacetValues()  : array<string|int, mixed>
Filter bad values from facet lists and add useful data fields.

Properties

Methods

__construct()

Constructor

public __construct(Settings $ss, Results $results) : mixed
Parameters
$ss : Settings

Session settings

$results : Results

Solr search results object

Return values
mixed —

handleRequest()

Handle a request.

public handleRequest(Params $params) : array<string|int, mixed>
Parameters
$params : Params

Parameter helper from controller

Return values
array<string|int, mixed> —

[response data, HTTP status code]

disableSessionWrites()

Prevent session writes -- this is designed to be called prior to time- consuming AJAX operations to help reduce the odds of a timing-related bug that causes the wrong version of session data to be written to disk (see VUFIND-716 for more details).

protected disableSessionWrites() : void
Return values
void —

formatResponse()

Format a response array.

protected formatResponse(mixed $response[, int $httpCode = null ]) : array<string|int, mixed>
Parameters
$response : mixed

Response data

$httpCode : int = null

HTTP status code (omit for default)

Return values
array<string|int, mixed> —

processDateFacets()

Extract details from applied filters.

protected processDateFacets(array<string|int, mixed> $filters, array<string|int, mixed> $dateFacets) : array<string|int, mixed>
Parameters
$filters : array<string|int, mixed>

Current filter list

$dateFacets : array<string|int, mixed>

Objects containing the date ranges

Return values
array<string|int, mixed> —

processFacetValues()

Filter bad values from facet lists and add useful data fields.

protected processFacetValues(array<string|int, mixed> $filters, array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$filters : array<string|int, mixed>

Current filter list

$fields : array<string|int, mixed>

Processed date information from processDateFacets

Return values
array<string|int, mixed> —

Search results