\FAA\Plugin\GeneralSearchHandler

Summary

Methods

Properties

Constants

SetupTemplate()
RegisterHooks()
OnBeforeAddOrUpdateContent()
OnRenameFolder()
RegisterPublicAssetBasePath()
OnGetEntityAttributes()
OnIndex()
OnNewIndex()
OnSyncronize()
OnLoadEntityFormPreset()
OnAddOrUpdateContent()
OnConvertContent()
OnDeleteContent()
DoSearch()
BuildEntry()
AssignableTypes()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

handlesType()
updateLinkedRelations()
getRelationsByContent()

$assignable_types

N/A

Properties

$assignable_types

$assignable_types :

Type

Methods

SetupTemplate()

SetupTemplate(  $data = null)

Parameters

$data

RegisterHooks()

RegisterHooks(): array

register system hooks Register a set of handler functions to be called in certain positions.

Returns

array —

A array with hooks

OnBeforeAddOrUpdateContent()

OnBeforeAddOrUpdateContent(\FAA\Obj\Sys\HookArgument  $reference)

Hook to set changer and changed date

When save some contents it should set the changed date and the changer from current session It will set server to null for system user context.

Parameters

\FAA\Obj\Sys\HookArgument

$reference

A hook argument

OnRenameFolder()

OnRenameFolder(  $reference)

Handle rename operations

Parameters

$reference

HookArgument

RegisterPublicAssetBasePath()

RegisterPublicAssetBasePath(  $reference)

Parameters

$reference

OnGetEntityAttributes()

OnGetEntityAttributes(  $reference)

Parameters

$reference

OnIndex()

OnIndex(  $reference)

Parameters

$reference

OnNewIndex()

OnNewIndex(  $reference)

Parameters

$reference

OnSyncronize()

OnSyncronize(  $reference,  $is_full = false)

Parameters

	$reference
	$is_full

OnLoadEntityFormPreset()

OnLoadEntityFormPreset(  $reference)

Parameters

$reference

OnAddOrUpdateContent()

OnAddOrUpdateContent(  $reference)

Call on update of element This hook is called on update of contents and save of them to file system

Parameters

$reference

HookArgument

OnConvertContent()

OnConvertContent(  $reference)

Parameters

$reference

HookArgument

OnDeleteContent()

OnDeleteContent(  $reference)

Parameters

$reference

DoSearch()

DoSearch(string  $language,array  $payload): \FAA\Obj\Result

Do search Execute the search by given arguments

Parameters

string	$language	The language to search in
array	$payload	The search request

Returns

\FAA\Obj\Result —

A system result

BuildEntry()

BuildEntry(\stdClass  $doc,string  $language,array|null  $extra = null): \FAA\Obj\Search\Response\General

Build entry Convert the search result to frontend object row

Parameters

\stdClass	$doc	The search response
string	$language	The request language
array\|null	$extra	Additional fields

Returns

\FAA\Obj\Search\Response\General —

A general search response object

AssignableTypes()

AssignableTypes(): array|null

Get list of assignable types that are handled in general

Returns

array|null

handlesType()

handlesType(  $type)

Parameters

$type

updateLinkedRelations()

updateLinkedRelations(\FAA\Obj\Sys\HookArgument  $reference,\FAA\Interfaces\Search  $client)

Update relations Update all the known linked relations of the updated content

Parameters

\FAA\Obj\Sys\HookArgument	$reference	The hook argument
\FAA\Interfaces\Search	$client	The search interface

getRelationsByContent()

getRelationsByContent(string|integer  $id,string  $type): array<mixed,\FAA\Obj\Search\Response\General>

Parameters

string\|integer	$id	An system object id
string	$type	The relation type

Returns

array<mixed,\FAA\Obj\Search\Response\General> —

List of linked relations