VuFind API Documentation

GetIlsStatus extends AbstractBase
in package

"Get ILS Status" AJAX handler

This will check the ILS for being online and will return the ils-offline template upon failure.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

author

André Lahmann lahmann@ub.uni-leipzig.de

license

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

link

Wiki

Table of Contents

$ils  : Connection
ILS connection
$renderer  : RendererInterface
View renderer
$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.

Properties

$renderer

View renderer

protected RendererInterface $renderer

Methods

__construct()

Constructor

public __construct(Settings $ss, Connection $ils, RendererInterface $renderer) : mixed
Parameters
$ss : Settings

Session settings

$ils : Connection

ILS connection

$renderer : RendererInterface

View renderer

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> —

Search results