1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Search
  7. \
  8. Hook
  9. \
  10. Base
  11. \
  12. SearchIntegration

SearchIntegration

abstract class SearchIntegration extends BaseHook

Abstract Class for Search Adapters

Properties

Controller $mod

Instance providing the hook

 from  BaseHook
array $_hook_info

Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => ""

 from  BaseHook

Methods

int
getDocumentCountBySearch(string|null $searchterm, array $facetedSearchFilters = [])

Gets the maximum available hits count for this search-term

array
getDocumentsBySearch(string|null $searchterm, array $limit = [], array $facetedSearchFilters = [])

Search for "Documents"

array
getFacetedFilters()

Return facets for the search sidebar.

string
getHookDescription()

No description

from  BaseHook
string
getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

from  BaseHook
array
getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

from  BaseHook
string
getHookInstance()

No description

from  BaseHook
string
getHookName()

No description

from  BaseHook
string
getHookTitle()

No description

from  BaseHook
getMinLength()

Returns the min length of a single search word

getObject()

No description

from  BaseHook
mixed
getOption(string $key)

Returns the option with $key set in the config.yml

from  BaseHook
string
getTabTitle()

No description

bool
isAvailable()

We assume, that this hook is available per default.

Details

at line 35
abstract int getDocumentCountBySearch(string|null $searchterm, array $facetedSearchFilters = [])

Gets the maximum available hits count for this search-term

Parameters

string|null $searchterm
array $facetedSearchFilters

[['facet_key' => ['value' => 'selected facet key', 'field' => 'facet_key']]]

Return Value

int

[LOCALE > int count]

at line 23
abstract array getDocumentsBySearch(string|null $searchterm, array $limit = [], array $facetedSearchFilters = [])

Search for "Documents"

Parameters

string|null $searchterm
array $limit

[limit] or [offset,limit]
array $facetedSearchFilters

[['facet_key' => ['value' => 'selected facet key', 'field' => 'facet_key']]]

Return Value

array

Search Result

at line 72
array getFacetedFilters()

Return facets for the search sidebar.

Return Value

array

[ 'facet_key' => [ 'label' => 'label for the facet', 'values' => [ 'key for facet option' => 'label for facet option', ... ], 'default' => '(optional) key for facet option which is active when nothing is selected' ], ... ]

in BaseHook at line 76
string getHookDescription()

No description

Return Value

string

in BaseHook at line 55
string getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

Return Value

string

in BaseHook at line 45
array getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

Parameters

bool $key

Return Value

array

in BaseHook at line 69
string getHookInstance()

No description

Return Value

string

in BaseHook at line 62
string getHookName()

No description

Return Value

string

in BaseHook at line 83
string getHookTitle()

No description

Return Value

string

at line 40
abstract getMinLength()

Returns the min length of a single search word

in BaseHook at line 88
getObject()

No description

in BaseHook at line 97
mixed getOption(string $key)

Returns the option with $key set in the config.yml

Parameters

string $key

Return Value

mixed

at line 52
string getTabTitle()

No description

Return Value

string

at line 45
bool isAvailable()

We assume, that this hook is available per default.

Return Value

bool