include/SugarSearchEngine/Elastic/SugarSearchEngineElastic.php

Show:

inherited

Classes
- \SugarSearchEngineElastic

Table of Contents

\SugarSearchEngineElastic
jump to top

Package:

Parent(s): \SugarSearchEngineAbstractBase < \SugarSearchEngineInterface

Constants

 
                DEFAULT_INDEX_TYPE
                = 'SugarBean'

 
                WILDCARD_CHAR
                = '*'

 
                MAX_BULK_THRESHOLD
                = 100

inherited

The max number of documents to bulk insert at a time

Inherited from: \SugarSearchEngineAbstractBase::MAX_BULK_THRESHOLD

Inherited_from: \SugarSearchEngineAbstractBase::MAX_BULK_THRESHOLD

Properties


                 $_client= 'null'

Default valuenullDetails

Type: n/a


                 $_config= 'array()'

Default valuearray()Details

Type: n/a

array
                 $_documents= 'array()'

inherited

Inherited from: \SugarSearchEngineAbstractBase::$$_documents

Default valuearray()Details

Type: array
Inherited_from: \SugarSearchEngineAbstractBase::$$_documents


                 $_indexName= '""'

Default value""Details

Type: n/a


                 $_indexType= ''SugarBean''

Default value'SugarBean'Details

Type: n/a

Methods

__construct(
           $params
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$params

__destruct(
          
          )
        
        :
          void

inherited

Bulk insert any documents that have been marked for bulk insertion.

Inherited from: \SugarSearchEngineAbstractBase::__destruct()

addRecordsToQueue(
           $records
          )
        
        :
          void

inherited

Inherited from: \SugarSearchEngineAbstractBase::addRecordsToQueue()

Parameters

Name	Type	Description
$records

bulkInsert(
           $docs
          )
        
        :
          void

Parameters

Name	Type	Description
$docs

canAppendWildcard(
           $queryString
          )
        
        :
          void

Parameters

Name	Type	Description
$queryString

checkException(
           $e
          )
        
        :
          void

inherited

Inherited from: \SugarSearchEngineAbstractBase::checkException()

Parameters

Name	Type	Description
$e

cleanTeamSetID(
           $teamSetID
          )
        
        :
          mixed

Remove the '-' from our team sets.

Parameters

Name	Type	Description
$teamSetID

Returns

Type	Description
mixed

constructHighlightArray(
           $fields,  $options
          )
        
        :
          void

Parameters

Name	Type	Description
$fields
$options

constructMainFilter(
           $finalTypes
          )
        
        :
          void

Parameters

Name	Type	Description
$finalTypes

constructModuleLevelFilter(
           $module
          )
        
        :
          void

Parameters

Name	Type	Description
$module

constructTeamFilter(
          
          )
        
        :
          void

createIndex(
          boolean $recreate
              =
              false
          )
        
        :
          void

Create the index and mapping.

Parameters

Name	Type	Description
$recreate	boolean	OPTIONAL Deletes index first if already exists (default = false)

createIndexDocument(
          \SugarBean $bean,  $searchFields
              =
              null
          )
        
        :
          \Elastica_Document | null

Parameters

Name	Type	Description
$bean	\SugarBean
$searchFields

Returns

Type	Description
\Elastica_Document \| null

delete(
           $bean
          )
        
        :
          void

Parameters

Name	Type	Description
$bean

disableFTS(
          
          )
        
        :
          void

inherited

Inherited from: \SugarSearchEngineAbstractBase::disableFTS()

getClient(
          
          )
        
        :
          void

getIndexName(
          
          )
        
        :
          void

getIndexType(
           $bean
          )
        
        :
          string

Return the 'type' for the index. By using the bean type we can specify mappings on a per bean basis if we need to in the future.

Parameters

Name	Type	Description
$bean

Returns

Type	Description
string

getOwnerField(
           $bean
          )
        
        :
          void

Parameters

Name	Type	Description
$bean

getOwnerTermFilter(
          
          )
        
        :
          void

getRecordsFromDocs(
           $docs
          )
        
        :
          void

Parameters

Name	Type	Description
$docs

getSearchFields(
           $options
          )
        
        :
          void

Parameters

Name	Type	Description
$options

getServerStatus(
          
          )
        
        :
          void

Check the server status

getTypeTermFilter(
           $module
          )
        
        :
          void

Parameters

Name	Type	Description
$module

indexBean(
           $bean,  $batch
              =
              TRUE
          )
        
        :
          void

Parameters

Name	Type	Description
$bean
$batch

indexSingleBean(
           $bean
          )
        
        :
          void

Parameters

Name	Type	Description
$bean

isModuleFtsEnabled(
           $module
          )
        
        :
          bool

inherited

Determine if a module is FTS enabled.

Inherited from: \SugarSearchEngineAbstractBase::isModuleFtsEnabled()

Parameters

Name	Type	Description
$module

Returns

Type	Description
bool

loader(
           $className
          )
        
        :
          void

Parameters

Name	Type	Description
$className

search(
           $queryString, int $offset
              =
              0, int $limit
              =
              20,  $options
              =
              array()
          )
        
        :
          null | \SugarSeachEngineElasticResultSet

Parameters

Name	Type	Description
$queryString
$offset	int
$limit	int
$options

Returns

Type	Description
null \| \SugarSeachEngineElasticResultSet

include/SugarSearchEngine/Elastic/SugarSearchEngineElastic.php

\SugarSearchEngineElasticjump to top

Constants

Properties

Methods

\SugarSearchEngineElastic
jump to top