include/SugarSearchEngine/Elastic/SugarSearchEngineElasticMapping.php

Show:

inherited

Table of Contents

\SugarSearchEngineElasticMapping
jump to top

Package: SugarCRM

Module mapping for Elastica

\SugarSearchEngineElastic
                 $sse= ''

Details

__construct(
           $sse
          )
        
        :
          void

Parameters

Name	Type	Description
$sse

constructMappingProperties(
          \$fieldDefs $fieldDefs
          )
        
        :
          \an

This function returns an array of properties given a field definition array.

Parameters

Name	Type	Description
$fieldDefs	\$fieldDefs	array of field definitions

Returns

Type	Description
\an	array of properties

setFieldMapping(
          \$module $module, \$fieldDefs $fieldDefs
          )
        
        :
          boolean

This function creates the mapping on particular type/module and field.

Ths can be used when user changes the field settings (like boost level) in Studio. index must exist before calling this function.

Parameters

Name	Type	Description
$module	\$module	module name
$fieldDefs	\$fieldDefs	field name of the module

Returns

Type	Description
boolean	true if mapping successfully created, false otherwise

setFullMapping(
          
          )
        
        :
          void

This function creates a full mapping for all modules.

index must exist before calling this function.

setModuleMapping(
          \$module $module
          )
        
        :
          boolean

This function creates the mapping for particular module/type.

index must exist before calling this function.

Parameters

Name	Type	Description
$module	\$module	module name

Returns

Type	Description
boolean	true if mapping successfully created, false otherwise