Minified
in package
A minified search object used exclusively for trimming a search object down to its barest minimum size before storage in a cookie or database.
It still contains enough data granularity to programmatically recreate search URLs.
This class isn't intended for general use, but simply a way of storing/retrieving data from a search object:
eg. Store $searchHistory[] = serialize($this->minify());
eg. Retrieve $searchObject = unserialize($search); $searchObject->deminify($manager);
Tags
Table of Contents
- $cl : string
- Search class
- $ex : array<string|int, mixed>
- Extra data (not used by default)
- $exp : array<string|int, mixed>
- Extra params data (not used by default)
- $f : array<string|int, mixed>
- Filters
- $hf : array<string|int, mixed>
- Hidden Filters
- $i : float
- Search start time
- $id : int
- Search ID
- $r : int
- Total result count
- $s : float
- Search duration
- $scp : array<string|int, mixed>
- Search context parameters
- $t : array<string|int, mixed>
- Search terms
- $ty : string
- Search type
- __construct() : mixed
- Constructor.
- deminify() : Results
- Turn the current object into search results.
- populateClassNames() : void
- Support method for deminify -- populate parameter class and results class if missing (for legacy compatibility).
Properties
$cl
Search class
public
string
$cl
$ex
Extra data (not used by default)
public
array<string|int, mixed>
$ex
= []
$exp
Extra params data (not used by default)
public
array<string|int, mixed>
$exp
= []
$f
Filters
public
array<string|int, mixed>
$f
= []
$hf
Hidden Filters
public
array<string|int, mixed>
$hf
= []
$i
Search start time
public
float
$i
$id
Search ID
public
int
$id
$r
Total result count
public
int
$r
$s
Search duration
public
float
$s
$scp
Search context parameters
public
array<string|int, mixed>
$scp
= []
$t
Search terms
public
array<string|int, mixed>
$t
= []
$ty
Search type
public
string
$ty
Methods
__construct()
Constructor.
public
__construct(Results $results) : mixed
Builds minified object from the Results passed in.
Parameters
- $results : Results
-
Results object to minify
Return values
mixed —deminify()
Turn the current object into search results.
public
deminify(PluginManager $manager) : Results
Parameters
- $manager : PluginManager
-
Search manager
Return values
Results —populateClassNames()
Support method for deminify -- populate parameter class and results class if missing (for legacy compatibility).
protected
populateClassNames() : void