Memory
in package
Wrapper class to handle search memory
Tags
Table of Contents
- $active : bool
- Is memory currently active? (i.e. will we save new URLs?)
- $request : Request
- $resultsManager : PluginManager
- $searchCache : array<string|int, mixed>
- Cached searches
- $searchService : SearchServiceInterface
- $session : Container
- $sessionId : string
- __construct() : mixed
- Constructor
- disable() : void
- Stop updating the URL in memory -- used in combined search to prevent multiple search URLs from overwriting one another.
- forgetSearch() : void
- Clear the last accessed search URL in the session.
- getCurrentSearch() : Results|null
- Get current search
- getCurrentSearchId() : int|null
- Get current search id
- getLastSearch() : Results|null
- Get latest search from current request or session
- getLastSearchId() : int|null
- Get latest search id from current request or session
- rememberLastSettings() : void
- Remember a user's last search parameters.
- rememberParams() : void
- Wrapper around rememberLastSettings() to extract key values from a search Params object.
- rememberSearch() : void
- Store the last accessed search URL in the session for future reference.
- retrieveLastSetting() : mixed
- Retrieve a previous user parameter, if available. Return $default if not found.
- retrieveSearch() : string|null
- Retrieve last accessed search URL, if available. Returns null if no URL is available.
- getSearchById() : Results|null
- Get a search by id
Properties
$active
Is memory currently active? (i.e. will we save new URLs?)
protected
bool
$active
= true
$request
protected
Request
$request
$resultsManager
protected
PluginManager
$resultsManager
$searchCache
Cached searches
protected
array<string|int, mixed>
$searchCache
= []
$searchService
protected
SearchServiceInterface
$searchService
$session
protected
Container
$session
$sessionId
protected
string
$sessionId
Methods
__construct()
Constructor
public
__construct(Container $session, string $sessionId, Request $request, SearchServiceInterface $searchService, PluginManager $resultsManager) : mixed
Parameters
- $session : Container
-
Session container for storing URLs
- $sessionId : string
-
Current session ID
- $request : Request
-
Request
- $searchService : SearchServiceInterface
-
Search service
- $resultsManager : PluginManager
-
Results plugin manager
Return values
mixed —disable()
Stop updating the URL in memory -- used in combined search to prevent multiple search URLs from overwriting one another.
public
disable() : void
Return values
void —forgetSearch()
Clear the last accessed search URL in the session.
public
forgetSearch() : void
Return values
void —getCurrentSearch()
Get current search
public
getCurrentSearch() : Results|null
Return values
Results|null —getCurrentSearchId()
Get current search id
public
getCurrentSearchId() : int|null
Return values
int|null —getLastSearch()
Get latest search from current request or session
public
getLastSearch() : Results|null
Return values
Results|null —getLastSearchId()
Get latest search id from current request or session
public
getLastSearchId() : int|null
Return values
int|null —rememberLastSettings()
Remember a user's last search parameters.
public
rememberLastSettings(string $context, array<string|int, mixed> $params) : void
Parameters
- $context : string
-
Context of search (usually search class ID).
- $params : array<string|int, mixed>
-
Associative array of keys/values to store.
Return values
void —rememberParams()
Wrapper around rememberLastSettings() to extract key values from a search Params object.
public
rememberParams(Params $params) : void
Parameters
- $params : Params
-
Parameter object
Return values
void —rememberSearch()
Store the last accessed search URL in the session for future reference.
public
rememberSearch(string $url[, int $id = null ]) : void
Parameters
- $url : string
-
URL to remember
- $id : int = null
-
Search ID to remember
Return values
void —retrieveLastSetting()
Retrieve a previous user parameter, if available. Return $default if not found.
public
retrieveLastSetting(string $context, string $setting[, mixed $default = null ]) : mixed
Parameters
- $context : string
-
Context of search (usually search class ID).
- $setting : string
-
Name of setting to retrieve.
- $default : mixed = null
-
Default value if setting is absent.
Return values
mixed —retrieveSearch()
Retrieve last accessed search URL, if available. Returns null if no URL is available.
public
retrieveSearch() : string|null
Return values
string|null —getSearchById()
Get a search by id
protected
getSearchById(int $id) : Results|null
Parameters
- $id : int
-
Search ID