$interface
$interface :null|boolean|\SolrClient
The search interface Local solr client
AddDocument(integer|string $id,string $type,array|\SolrDocument $data): \FAA\Obj\Result
Add a document Add a document to search index.
| 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 |
A system result object
Execute(array $filter,array $order,array $payload,string $language,\FAA\Interfaces\SearchPlugin|mixed $handler): \FAA\Obj\Result
Do search Execute the search operation
| array | $filter | The search query |
| array | $order | The search order definition |
| array | $payload | The search response definition start integer The start index length integer The count of elements to fetch fields array A list of fields to include echo int The data tables echo counter |
| string | $language | The request language |
| \FAA\Interfaces\SearchPlugin|mixed | $handler | A search plugin instance or, a class wih method BuildEntry |
A system result object with data table conform response array
BuildEntry(\stdClass $doc,string $language,array|null $extra = null): \FAA\Obj\Search\Response\General
Build entry
Convert the search result to frontend object row
| \stdClass | $doc | The search response |
| string | $language | The request language |
| array|null | $extra | Additional fields |
A general search response object
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. Doeas a cleanup of storage on demand, when full is set to true.
| 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 |
A system result object
setupFilter(array<mixed,\FAA\Interfaces\SearchFilter> $filters,string $search): string
To search string Add the given filters to the search string.
| array<mixed,\FAA\Interfaces\SearchFilter> | $filters | A list of search filters |
| string | $search | The search string |
The search string with filters
buildDocument(integer|string $id,string $type,array $data): \SolrInputDocument
Create document Convert the given fields to sol search client document
| integer|string | $id | A object id |
| string | $type | Object type name |
| array | $data | A list of elements with fields: 'field', 'type' and 'value' |
A solr client input document