SearchMetaData
abstract class SearchMetaData extends BaseHook implements SearchMetaDataInterface
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
No description
No description
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
No description
No description
No description
Returns the search query for the given key and value.
No description
No description
Details
at line 103
array|null
getAggregation()
No description
at line 15
abstract array
getFields()
No description
in
BaseHook at line 76
string
getHookDescription()
No description
in
BaseHook at line 55
string
getHookIdentifier()
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
in
BaseHook at line 45
array
getHookInfoValue(bool $key = false)
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
in
BaseHook at line 69
string
getHookInstance()
No description
in
BaseHook at line 62
string
getHookName()
No description
in
BaseHook at line 83
string
getHookTitle()
No description
at line 20
array
getKeys()
No description
at line 33
string
getLabelForKey(string $key)
No description
at line 47
abstract string
getLabelForValue(string $key, string $value)
No description
in
BaseHook at line 88
getObject()
No description
at line 66
array
getSearchQuery(string $instanceId, string $key, string $value)
Returns the search query for the given key and value.
The provided query uses term queries to provide exact matches of the selected value.
at line 110
array
getValuesForKey(string $key, array $values, array $aggregation)
No description
at line 52
bool
isAvailable()
No description