FileAccess Orion

Handler
in package
implements SearchPlugin, ContentSearchIndex

Implement company search handler

This class provides interfaces for custom company search handling. It is the first class to be migrated to new solarium based solr connector

Tags
category

Plugin

author

Tobias Teichner webmaster@teichner.biz

since

File available since v0.144

Interfaces, Classes, Traits and Enums

SearchPlugin
Define a system search plugin
ContentSearchIndex

Table of Contents

BuildEntry()  : object
Build entry
DoSearch()  : Result
Do search for companies
OnAddOrUpdateContent()  : void
Hook on content creation or modification
OnCommandLineInterfaceCall()  : void
Cli to recreate a whole set of vimeo assets
OnDeleteContent()  : void
Hook on delete a content
OnGetEntityAttributes()  : void
OnIndex()  : void
OnNewIndex()  : void
OnSyncronize()  : void
RegisterHooks()  : mixed
SetupTemplate()  : mixed

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 company

DoSearch()

Do search for companies

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()

Hook on content creation or modification

public OnAddOrUpdateContent(HookArgument $reference) : void
Parameters
$reference : HookArgument
Return values
void

OnCommandLineInterfaceCall()

Cli to recreate a whole set of vimeo assets

public OnCommandLineInterfaceCall( $param) : void
Parameters
$param :

HookArgument

Return values
void

OnDeleteContent()

Hook on delete a content

public OnDeleteContent(HookArgument $reference) : void
Parameters
$reference : HookArgument
Return values
void

OnSyncronize()

public OnSyncronize(HookArgument $reference[, bool $is_full = false ]) : void
Parameters
$reference : HookArgument
$is_full : bool = false
Return values
void

RegisterHooks()

public RegisterHooks() : mixed
Tags
inheritDoc
Return values
mixed

SetupTemplate()

public SetupTemplate([mixed $data = null ]) : mixed
Parameters
$data : mixed = null
Return values
mixed

Search results