VuFind API Documentation

GetRecordVersions extends AbstractBase
in package

AJAX handler for fetching versions link

Tags
category

VuFind

author

Ere Maijala ere.maijala@helsinki.fi

license

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

link

Wiki

Table of Contents

$recordLoader  : Loader
Record loader
$recordPlugin  : Record
Record plugin
$sessionSettings  : Settings
Session settings
$tabManager  : TabManager
Tab manager
__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.
getVersionsLinkForRecord()  : string
Load a single record and render the link template

Properties

Methods

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>

getVersionsLinkForRecord()

Load a single record and render the link template

protected getVersionsLinkForRecord(string $id, string $source, string $searchId) : string
Parameters
$id : string

Record id

$source : string

Record source

$searchId : string

Search ID

Return values
string

Search results