\FAA\Handler\SearchDoctrine

Summary

Methods

Properties

Constants

__construct()
GetVersion()
DirectQuery()
DeleteDocument()
DeleteDocumentList()
AddDocument()
Execute()
IndexList()

No public properties found

No constants found

client()

No protected properties found

N/A

setupFilters()

$interface
$charset

N/A

Properties

$interface

$interface :null|boolean|\Doctrine\DBAL\Connection

The search interface

Type

null|boolean|\Doctrine\DBAL\Connection—A client instance

$charset

$charset :string

Type

string—The charset for the connection

Methods

__construct()

__construct()

GetVersion()

GetVersion(): string

Get the server version Get the version string of the related and configured solr search server

Returns

string —

The version number

DirectQuery()

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

Parameters

string

$sql

The query to execute

Returns

\FAA\Obj\Result —

A system result object

DeleteDocument()

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

Delete a document Delete a document from search index.

Parameters

integer\|string\|array	$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

Throws

Returns

\FAA\Obj\Result —

A system result object

AddDocument()

AddDocument(integer|string  $id,string  $type,array  $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	$data	The document data with key value pairs

Returns

\FAA\Obj\Result —

A system result object

Execute()

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

Do search Execute the search operation

Parameters

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

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

client()

client(): boolean|null|\Doctrine\DBAL\Connection

Setup client

Connect to local database server and return instance. This method is cached

Returns

boolean|null|\Doctrine\DBAL\Connection

setupFilters()

setupFilters(array<mixed,\FAA\Obj\Search\Filter>  $filters,\Doctrine\DBAL\Query\QueryBuilder  $queryBuilder,\Doctrine\DBAL\Query\QueryBuilder  $queryBuilderCount)

Parameters

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