Handler
in package
implements
SearchPlugin, SearchIndex
Uses
PluginIsInContext
Implement task search handler This class provides interfaces for custom task and project search handling
Tags
Interfaces, Classes, Traits and Enums
- SearchPlugin
- Define a system search plugin
- SearchIndex
Table of Contents
- BuildEntry() : object
- Build entry
- DoSearch() : Result
- Do search for tasks
- OnAddOrUpdateContent() : mixed
- OnBeforeRelationAttributeSearch() : void
- OnDeleteContent() : mixed
- OnEmployeeAssignmentStatusChange() : void
- OnIndex() : void
- The hook on new index must follow this interface
- OnNewIndex() : void
- On full new index
- OnRegisterWidgetIncludes() : mixed
- OnRenameFolder() : mixed
- Handle rename operations
- OnSyncronize() : void
- Called after a sync operation
- RegisterHooks() : array<string|int, mixed>
- register system hooks Register a set of handler functions to be called in certain positions.
- SetupTemplate() : Result
- Setup getter and setter
- isInContext() : bool
- Is in certain context?
Methods
BuildEntry()
Build entry
public
BuildEntry(object $doc[, string|null $language = null ][, array<string|int, mixed>|null $extra = null ]) : object
Convert the search result to frontend object row
Parameters
- $doc : object
-
The search response
- $language : string|null = null
-
The request language
- $extra : array<string|int, mixed>|null = null
-
Additional fields
Return values
object —A result object of type task
DoSearch()
Do search for tasks
public
DoSearch(string|null $language, array<string|int, mixed> $payload) : Result
Execute the search by given arguments
Parameters
- $language : string|null
-
The language to search in
- $payload : array<string|int, mixed>
-
The search request
Return values
Result —A system result
OnAddOrUpdateContent()
public
OnAddOrUpdateContent( $reference) : mixed
Parameters
Return values
mixed —OnBeforeRelationAttributeSearch()
public
OnBeforeRelationAttributeSearch(HookArgument $reference) : void
Parameters
- $reference : HookArgument
Return values
void —OnDeleteContent()
public
OnDeleteContent( $reference) : mixed
Parameters
Return values
mixed —OnEmployeeAssignmentStatusChange()
public
OnEmployeeAssignmentStatusChange(HookArgument $reference) : void
Parameters
- $reference : HookArgument
Return values
void —OnIndex()
The hook on new index must follow this interface
public
OnIndex(HookArgument $reference) : void
Parameters
- $reference : HookArgument
Tags
Return values
void —OnNewIndex()
On full new index
public
OnNewIndex(HookArgument $reference) : void
Parameters
- $reference : HookArgument
Tags
Return values
void —OnRegisterWidgetIncludes()
public
OnRegisterWidgetIncludes(HookArgument $param) : mixed
Parameters
- $param : HookArgument
Return values
mixed —OnRenameFolder()
Handle rename operations
public
OnRenameFolder( $reference) : mixed
Parameters
Return values
mixed —OnSyncronize()
Called after a sync operation
public
OnSyncronize(HookArgument $reference) : void
Parameters
- $reference : HookArgument
Tags
Return values
void —RegisterHooks()
register system hooks Register a set of handler functions to be called in certain positions.
public
RegisterHooks() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of registered hooks
SetupTemplate()
Setup getter and setter
public
SetupTemplate([array<string|int, mixed>|null $data = null ]) : Result
The setter is just an interface and not active
Parameters
- $data : array<string|int, mixed>|null = null
-
New configuration values
Return values
Result —The template fetch result
isInContext()
Is in certain context?
protected
isInContext(HookArgument $param, string $type, string $widget) : bool
Parameters
- $param : HookArgument
-
The hook argument
- $type : string
-
The type can be scss, css and js to search in widgets or _ to search in global includes
- $widget : string
-
The widget to search for