SystemStatus
extends AbstractBase
in package
implements
LoggerAwareInterface
Uses
LoggerAwareTrait
"Keep Alive" AJAX handler
This is responsible for keeping the session alive whenever called (via JavaScript)
Tags
Interfaces, Classes, Traits and Enums
- LoggerAwareInterface
Table of Contents
- $config : Config
- $resultsManager : PluginManager
- $sessionManager : SessionManager
- $sessionService : SessionServiceInterface
- $sessionSettings : Settings
- Session settings
- __construct() : mixed
- Constructor
- handleRequest() : array<string|int, mixed>
- Handle a request.
- debug() : void
- Log a debug message.
- 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.
- log() : void
- Send a message to the logger.
- logError() : void
- Log an error message.
- logWarning() : void
- Log a warning message.
Properties
$config
protected
Config
$config
$resultsManager
protected
PluginManager
$resultsManager
$sessionManager
protected
SessionManager
$sessionManager
$sessionService
protected
SessionServiceInterface
$sessionService
$sessionSettings
Session settings
protected
Settings
$sessionSettings
= null
Methods
__construct()
Constructor
public
__construct(SessionManager $sessionManager, PluginManager $resultsManager, Config $config, SessionServiceInterface $sessionService) : mixed
Parameters
- $sessionManager : SessionManager
-
Session manager
- $resultsManager : PluginManager
-
Results manager
- $config : Config
-
Top-level VuFind configuration (config.ini)
- $sessionService : SessionServiceInterface
-
Session database service
Return values
mixed —handleRequest()
Handle a request.
public
handleRequest(Params $params) : array<string|int, mixed>
Parameters
- $params : Params
-
Parameter helper from controller
Tags
Return values
array<string|int, mixed> —[response data, HTTP status code]
debug()
Log a debug message.
protected
debug(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void
Parameters
- $msg : string
-
Log message
- $context : array<string|int, mixed> = []
-
Log context
- $prependClass : bool = true
-
Prepend class name to message?
Return values
void —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> —log()
Send a message to the logger.
protected
log(string $level, string $message[, array<string|int, mixed> $context = [] ][, bool $prependClass = false ]) : void
Parameters
- $level : string
-
Log level
- $message : string
-
Log message
- $context : array<string|int, mixed> = []
-
Log context
- $prependClass : bool = false
-
Prepend class name to message?
Return values
void —logError()
Log an error message.
protected
logError(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void
Parameters
- $msg : string
-
Log message
- $context : array<string|int, mixed> = []
-
Log context
- $prependClass : bool = true
-
Prepend class name to message?
Return values
void —logWarning()
Log a warning message.
protected
logWarning(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void
Parameters
- $msg : string
-
Log message
- $context : array<string|int, mixed> = []
-
Log context
- $prependClass : bool = true
-
Prepend class name to message?