Bitrix API

IndexManager

FinalYes

Table of Contents

Methods

__construct()  : mixed
Constructor IndexManager.
changeName()  : void
Changes index after rename.
disableUsingExtendedFullText()  : mixed
disableUsingSearchModule()  : $this
Disables using search module.
dropIndex()  : mixed
Delete information from Search by concrete file or folder.
dropIndexByModuleSearch()  : mixed
getStoredIndex()  : null|array<string|int, mixed>
Returns stored index in module search.
indexFile()  : void
Runs index by file.
indexFileByModuleSearch()  : mixed
indexFileWithExtendedIndex()  : mixed
indexFolder()  : void
Runs index by folder.
indexFolderByModuleSearch()  : mixed
indexFolderWithExtendedIndex()  : mixed
initDefaultConfiguration()  : mixed
onSearchGetUrl()  : string
Event listener which return url for resource by fields.
onSearchReindex()  : array<string|int, mixed>|bool
Search re-index handler.
recalculateRights()  : void
Recalculate rights in Search if it needs.
updateFileContent()  : mixed

Methods

__construct()

Constructor IndexManager.

public __construct() : mixed

changeName()

Changes index after rename.

public changeName(BaseObject $object) : void
Parameters
$object : BaseObject

Target file or folder.

Tags
throws
LoaderException

disableUsingExtendedFullText()

public disableUsingExtendedFullText() : mixed

disableUsingSearchModule()

Disables using search module.

public disableUsingSearchModule() : $this
Return values
$this

dropIndex()

Delete information from Search by concrete file or folder.

public dropIndex(BaseObject $object) : mixed
Parameters
$object : BaseObject

Target object.

Tags
throws
LoaderException

dropIndexByModuleSearch()

public dropIndexByModuleSearch(BaseObject $object) : mixed
Parameters
$object : BaseObject

getStoredIndex()

Returns stored index in module search.

public getStoredIndex(BaseObject $object) : null|array<string|int, mixed>
Parameters
$object : BaseObject

File or Folder.

Return values
null|array<string|int, mixed>

indexFile()

Runs index by file.

public indexFile(File $file[, array<string|int, mixed> $additionalData = array() ]) : void
Parameters
$file : File

Target file.

$additionalData : array<string|int, mixed> = array()
Tags
throws
ArgumentException
throws
LoaderException
throws
Exception

indexFileByModuleSearch()

public indexFileByModuleSearch(File $file) : mixed
Parameters
$file : File

indexFileWithExtendedIndex()

public indexFileWithExtendedIndex(File $file) : mixed
Parameters
$file : File

indexFolder()

Runs index by folder.

public indexFolder(Folder $folder) : void
Parameters
$folder : Folder

Target folder.

Tags
throws
LoaderException

indexFolderByModuleSearch()

public indexFolderByModuleSearch(Folder $folder) : mixed
Parameters
$folder : Folder

indexFolderWithExtendedIndex()

public indexFolderWithExtendedIndex(Folder $folder) : mixed
Parameters
$folder : Folder

initDefaultConfiguration()

public initDefaultConfiguration() : mixed

onSearchGetUrl()

Event listener which return url for resource by fields.

public static onSearchGetUrl(array<string|int, mixed> $fields) : string
Parameters
$fields : array<string|int, mixed>

Fields from search module.

Return values
string

onSearchReindex()

Search re-index handler.

public static onSearchReindex([array<string|int, mixed> $nextStepData = array() ][, null $searchObject = null ][, string $method = "" ]) : array<string|int, mixed>|bool
Parameters
$nextStepData : array<string|int, mixed> = array()

Array with data about step.

$searchObject : null = null

Search object.

$method : string = ""

Method.

Return values
array<string|int, mixed>|bool

recalculateRights()

Recalculate rights in Search if it needs.

public recalculateRights(BaseObject $object) : void
Parameters
$object : BaseObject

Target object (can be folder or file).

Tags
throws
LoaderException

updateFileContent()

public updateFileContent(File $file) : mixed
Parameters
$file : File 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results