Result
extends Plugin
in package
implements
JsonSerializable, Countable
Uses
Searchable
Basic result class. This object is substituted for a CEO model if the content object isn't found. This can happen if the content hasn't been synced in some time.
Interfaces, Classes and Traits
- JsonSerializable
- Countable
Table of Contents
- $attrs : mixed
- __construct() : mixed
- count() : mixed
- fromSphinx() : self
- Build result from a Sphinx match.
- getPreview() : string
- Return searchPreview
- getSearchDate() : DateTime
- Return the published_at DateTime
- getSearchPreview() : string
- Determine the preview text
- getSearchPreviewUrl() : bool
- Return searchPreviewUrl Always returns false
- getSearchTitle() : string
- Determine the search title for an item
- getSearchType() : string
- Determine the model type
- getSearchUrl() : string
- Return searchUrl
- getTitle() : string
- Return searchTitle
- getType() : string
- Return searchType
- jsonSerialize() : array<string|int, mixed>
- Implements json_serialize for search results
Properties
$attrs
private
mixed
$attrs
Methods
__construct()
public
__construct([mixed $attrs = [] ]) : mixed
Parameters
- $attrs : mixed = []
Return values
mixed —count()
public
count() : mixed
Return values
mixed —fromSphinx()
Build result from a Sphinx match.
public
fromSphinx(array<string|int, mixed> $match) : self
Expected to be in the form of
array(
'attrs' => ...
)
Parameters
- $match : array<string|int, mixed>
Return values
self —getPreview()
Return searchPreview
public
getPreview() : string
Return values
string —getSearchDate()
Return the published_at DateTime
public
getSearchDate() : DateTime
Return values
DateTime —getSearchPreview()
Determine the preview text
public
getSearchPreview() : string
Return values
string —getSearchPreviewUrl()
Return searchPreviewUrl Always returns false
public
getSearchPreviewUrl() : bool
Return values
bool —getSearchTitle()
Determine the search title for an item
public
getSearchTitle() : string
Return values
string —getSearchType()
Determine the model type
public
getSearchType() : string
Return values
string —getSearchUrl()
Return searchUrl
public
getSearchUrl() : string
Return values
string —getTitle()
Return searchTitle
public
getTitle() : string
Return values
string —getType()
Return searchType
public
getType() : string
Return values
string —jsonSerialize()
Implements json_serialize for search results
public
jsonSerialize() : array<string|int, mixed>