Solarium
in package
implements
Search
Define solarium system search
Define the interface for search using the filesystem server
Tags
Interfaces, Classes, Traits and Enums
- Search
Table of Contents
- $interface : Client|null
- Connection instance
- $setup : stdClass|null
- Settings buffer
- AddDocument() : Result
- Add a document Add a document to search index.
- client() : Client|null
- Cached connection
- DeleteDocument() : Result
- DeleteDocumentList() : Result
- DistinctValues() : Result
- Execute() : Result
- GetServerVersion() : string|null
- GetVersion() : string
- IndexList() : Result
- fillDocument() : void
- getEntry() : BaseContent|null
- Resolve a single entry
- settings() : stdClass|null
- setupFilter() : string
- To search string
- toId() : string
Properties
$interface
Connection instance
private
Client|null
$interface
= null
$setup
Settings buffer
private
stdClass|null
$setup
Methods
AddDocument()
Add a document Add a document to search index.
public
AddDocument(int|string $id, string $type, mixed $data[, BufferedAdd|null $buffer = null ]) : Result
Parameters
- $id : int|string
-
A object id
- $type : string
-
The type of object
- $data : mixed
-
The document data with key value pairs or a solr document instance
- $buffer : BufferedAdd|null = null
-
On buffered add additional plugin
Return values
Result —client()
Cached connection
public
client() : Client|null
Return values
Client|null —DeleteDocument()
public
DeleteDocument(int|string|array<string|int, mixed> $id, string $type) : Result
Parameters
- $id : int|string|array<string|int, mixed>
- $type : string
Tags
Return values
Result —DeleteDocumentList()
public
DeleteDocumentList(string|null $type) : Result
Parameters
- $type : string|null
Tags
Return values
Result —DistinctValues()
public
DistinctValues(string $type, string $field) : Result
Parameters
- $type : string
- $field : string
Return values
Result —Execute()
public
Execute(array<string|int, mixed> $filter, array<string|int, mixed> $order, array<string|int, mixed> $payload, string|null $language, null|object $handler) : Result
Parameters
- $filter : array<string|int, mixed>
- $order : array<string|int, mixed>
- $payload : array<string|int, mixed>
- $language : string|null
- $handler : null|object
Tags
Return values
Result —GetServerVersion()
public
GetServerVersion() : string|null
Tags
Return values
string|null —GetVersion()
public
GetVersion() : string
Tags
Return values
string —IndexList()
public
IndexList(string $type, array<string|int, mixed> $list[, bool $is_full = false ][, int|string|object $correct_count = -1 ]) : Result
Parameters
- $type : string
- $list : array<string|int, mixed>
- $is_full : bool = false
- $correct_count : int|string|object = -1
Tags
Return values
Result —fillDocument()
private
fillDocument(DocumentInterface $doc, int|string $id, string $type, mixed $data) : void
Parameters
- $doc : DocumentInterface
- $id : int|string
- $type : string
- $data : mixed
Return values
void —getEntry()
Resolve a single entry
private
getEntry(string|int $id, string $type[, string|null $source = null ]) : BaseContent|null
Parameters
- $id : string|int
- $type : string
- $source : string|null = null
Return values
BaseContent|null —settings()
private
settings() : stdClass|null
Return values
stdClass|null —setupFilter()
To search string
private
setupFilter(array<string|int, SearchFilter> $filters, string $search) : string
Add the given filters to the search string.
Parameters
- $filters : array<string|int, SearchFilter>
-
A list of search filters
- $search : string
-
The search string
Return values
string —The search string with filters
toId()
private
toId(int|string $id, string $type) : string
Parameters
- $id : int|string
- $type : string