include/SugarSearchEngine/SugarSearchEngineAbstractBase.php

Show: inherited
Table of Contents

\SugarSearchEngineAbstractBase

Package: SugarCRM

Base class for search engine drivers

Parent(s)
\SugarSearchEngineInterface
Children
\SugarSearchEngineElastic
Api
 

Constants

Constant  MAX_BULK_THRESHOLD = 100

The max number of documents to bulk insert at a time

Properties

Propertyprotectedarray  $_documents= 'array()'

Default valuearray()Details
Type
array

Methods

methodpublic__destruct( ) : void

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

methodpublic__wakeup( ) : void

This is needed to prevent unserialize vulnerability

methodprotectedaddRecordsToQueue( \$records $records ) : void

This function adds records to FTS queue.

Parameters
Name Type Description
$records \$records

array of records

methodprotecteddisableFTS( ) : void

Disable FTS and write to config.

methodprotectedisModuleFtsEnabled(  $module ) : bool

Determine if a module is FTS enabled.

Parameters
Name Type Description
$module
Returns
Type Description
bool
methodpublicisSearchEngineDown( ) : Boolean
static

This function checks config to see if search engine is down.

Returns
Type Description
Boolean
methodpublicmarkSearchEngineStatus( Boolean $isDown = true ) : void
static

This function marks config to indicate that search engine is up or down.

Parameters
Name Type Description
$isDown Boolean
Documentation was generated by DocBlox 0.18.1.