$TABLE
$TABLE :
DirectQuery(string $sql) : \FAA\Obj\Result
Direct execute query Execute a given query, use with care and ommit using external arguments in this cases as the wont be ascapet
| string | $sql | The query to execute |
A system result object
DeleteDocument(integer|string|array $id, string $type) : \FAA\Obj\Result
Delete a document Delete a document from search index.
| integer|string|array | $id | A object id |
| string | $type | The type of object |
A system result object
DeleteDocumentList(string $type) : \FAA\Obj\Result
Delete a document list Delete a document list from search index.
| string | $type | The type of object |
A system result object
AddDocument(integer|string $id, string $type, array $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 | $data | The document data with key value pairs |
A system result object
Execute(array $filters, array $orders, array $payload, string $language, \FAA\Interfaces\SearchPlugin|mixed $handler) : \FAA\Obj\Result
Do search Execute the search operation
| array | $filters | The search query |
| array | $orders | 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 search string A search term |
| string | $language | The request language |
| \FAA\Interfaces\SearchPlugin|mixed | $handler | A search plugin instance |
A system result object with data table conform response array
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
| 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
WriteList(integer $id, string $type, array $data) : \FAA\Obj\Result
Add a document set Add a list of documents to search index.
| integer | $id | A object id, this field is mandatory |
| string | $type | A object type name, this field is mandatory |
| array | $data | The document data with key value pairs |
A system result object
Fetch(integer|string $id) : \FAA\Obj\Result
Get a document Get a document from database index.
| integer|string | $id | A object id |
A system result object
Drop(integer|string $id) : \FAA\Obj\Result
Delete a document Delete a document from database index.
| integer|string | $id | A object id |
A system result object
Write(integer|string|null $id, array $data) : \FAA\Obj\Result
Add a document Add a document to search index.
| integer|string|null | $id | A object id or, null for new entries |
| array | $data | The document data with key value pairs |
A system result object
setupFilters(array<mixed,\FAA\Obj\Search\Filter> $filters, \Doctrine\DBAL\Query\QueryBuilder $queryBuilder, \Doctrine\DBAL\Query\QueryBuilder $queryBuilderCount)
| array<mixed,\FAA\Obj\Search\Filter> | $filters | A set of filters |
| \Doctrine\DBAL\Query\QueryBuilder | $queryBuilder | A doctrine query builder for search |
| \Doctrine\DBAL\Query\QueryBuilder | $queryBuilderCount | A doctrine query builder for count |