include/SugarSearchEngine/Elastic/SugarSeachEngineElasticResult.php

Show: inherited

• Classes
  • \SugarSeachEngineElasticResult

Table of Contents

\SugarSeachEngineElasticResult

jump to top

Package: SugarCRM

Adapter class to Elastica Result

Parent(s)

\SugarSearchEngineAbstractResult < \SugarSearchEngineResult

Properties

\SugarBean  $bean= ''

inherited

Inherited from: \SugarSearchEngineAbstractResult::$$bean

Details

Type

\SugarBean

Inherited_from

\SugarSearchEngineAbstractResult::$$bean  

\Elastica_Result  $elasticaResult= ''

Details

Type

\Elastica_Result

Methods

__construct(  $result ) : void

Parameters

Name	Type	Description
$result

__toString( ) : void

inherited

Inherited from: \SugarSearchEngineAbstractResult::__toString()

getHighlightedHitText( \maxFields $maxFields = 1 ) : array

This function returns an array of highlighted key-value pairs.

Parameters

Name	Type	Description
$maxFields	\maxFields	integer the maximum number of fields to return for each hit

Returns

Type	Description
array	of key value pairs

getId( ) : string

Return the id of the

Returns

Type	Description
string

getModule( ) : array

Returns

Type	Description
array

getModuleName( ) : void

inherited

Inherited from: \SugarSearchEngineAbstractResult::getModuleName()

getSummaryText( ) : void

inherited

Inherited from: \SugarSearchEngineAbstractResult::getSummaryText()