GetRecordRating
extends AbstractBase
in package
AJAX handler to get the rating for a record.
Tags
Table of Contents
- $ratingsService : RatingsService
- $recordHelper : Record
- $recordLoader : Loader
- $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
$ratingsService
protected
RatingsService
$ratingsService
$recordHelper
protected
Record
$recordHelper
$recordLoader
protected
Loader
$recordLoader
$sessionSettings
Session settings
protected
Settings
$sessionSettings
= null
Methods
__construct()
Constructor
public
__construct(Loader $recordLoader, Record $recordHelper, RatingsService $ratingsService) : mixed
Parameters
- $recordLoader : Loader
-
Record loader
- $recordHelper : Record
-
Record helper
- $ratingsService : RatingsService
-
Ratings service
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)