\FAA\InterfacesSearch

Summary

Methods
Constants
GetVersion()
DeleteDocument()
DeleteDocumentList()
AddDocument()
Execute()
IndexList()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

GetVersion()

GetVersion(): string

Check if is connected Get the version of the search server.

Returns

string —

Connection possible

DeleteDocument()

DeleteDocument(integer|string  $id,string  $type): \FAA\Obj\Result

Delete a document Delete a document from search index.

Parameters

integer|string $id

A object id

string $type

The type of object

Returns

\FAA\Obj\Result —

A system result object

DeleteDocumentList()

DeleteDocumentList(string  $type): \FAA\Obj\Result

Delete a document list Delete a document list from search index.

Parameters

string $type

The type of object

Returns

\FAA\Obj\Result —

A system result object

AddDocument()

AddDocument(integer|string  $id,string  $type,array|\SolrDocument  $data): \FAA\Obj\Result

Add a document Add a document to search index.

Parameters

integer|string $id

A object id

string $type

The type of object

array|\SolrDocument $data

The document data with key value pairs or a solr document instance

Returns

\FAA\Obj\Result —

A system result object

Execute()

Execute(array  $filter,array  $order,array  $payload,string  $language,\FAA\Interfaces\SearchPlugin|mixed  $handler): \FAA\Obj\Result

Do search Execute the search operation

Parameters

array $filter

The search query

array $order

The search order definition

array $payload

The search response definition

string $language

The request language

\FAA\Interfaces\SearchPlugin|mixed $handler

A search plugin instance or other class that implements method BuildEntry

Returns

\FAA\Obj\Result —

A system result object with data table conform response array

IndexList()

IndexList(string  $type,array  $list,\FAA\Obj\CronJob  $cron,boolean  $is_full = false): \FAA\Obj\Result

Index list Handler to index a list of files

Parameters

string $type

The system type name

array $list

A list of files

\FAA\Obj\CronJob $cron

A cron job instance

boolean $is_full

When set to true the update will do an diff check of the attribute set

Returns

\FAA\Obj\Result —

A system result object