include/SugarSearchEngine/SugarSearchEngineMetadataHelper.php

Show:

inherited

Table of Contents

\SugarSearchEngineMetadataHelper
jump to top

Package: SugarCRM

Class dealing with searchable modules

 
                ENABLE_MODULE_CACHE_KEY
                = 'ftsEnabledModules'

Cache key for enabled modules

 
                DISABLED_MODULE_CACHE_KEY
                = 'ftsDisabledModules'

Cache key for disabled modules

getSystemEnabledFTSModules(
          
          )
        
        :
          mixed | \The

static

Return all of the modules disabled for FTS by the administrator

Returns

Type	Description
mixed \| \The

getUserEnabledFTSModules(
          null | \User $user
              =
              null
          )
        
        :
          array

static

Return all of the FTS enabled modules for a specific user

Parameters

Name	Type	Description
$user	null \| \User

Returns

Type	Description
array

Details

isModuleFtsEnabled(
           $module
          )
        
        :
          bool

static

Determine if a module is FTS enabled.

Parameters

Name	Type	Description
$module

Returns

Type	Description
bool

retrieveFtsEnabledFieldsForAllModules(
          
          )
        
        :
          array

static

Retrieve all FTS fields for all FTS enabled modules.

Returns

Type	Description
array

retrieveFtsEnabledFieldsPerModule(
           $module
          )
        
        :
          void

static

For a given module, return all of the full text search enabled fields.

Parameters

Name	Type	Description
$module