Bitrix API

Manager

Table of Contents

Methods

checkAdminNotification()  : void
Adds admin users notification about index rebuild.
createIndexer()  : Indexer
Creates and initializes new indexer instance.
deleteElementIndex()  : void
Deletes all related to element information if index exists.
deleteIndex()  : void
Deletes index and mark iblock as having none.
disableDeferredIndexing()  : void
Disable deferred indexing.
dropIfExists()  : void
Drops all related to index database structures.
enableDeferredIndexing()  : void
Enable deferred indexing.
markAsInvalid()  : void
Marks iblock as one who needs index rebuild.
onPropertyUpdate()  : void
Marks iblock as one who needs index rebuild when it is needed.
resolveElement()  : int
If elementId is an offer, then it's product identifier returned Otherwise $elementId returned.
resolveIblock()  : int
For offers iblock identifier returns it's products iblock.
runDeferredIndexing()  : void
Update iblock index if defered data exists.
updateElementIndex()  : void
Updates all related to element information if index exists.
usedDeferredIndexing()  : bool
Return true if allowed deferred indexing.

Methods

checkAdminNotification()

Adds admin users notification about index rebuild.

public static checkAdminNotification([bool $force = false ]) : void
Parameters
$force : bool = false

Whenever skip iblock check.

createIndexer()

Creates and initializes new indexer instance.

public static createIndexer(int $iblockId) : Indexer
Parameters
$iblockId : int

Information block identifier.

Return values
Indexer

deleteElementIndex()

Deletes all related to element information if index exists.

public static deleteElementIndex(int $iblockId, int $elementId) : void
Parameters
$iblockId : int

Information block identifier.

$elementId : int

Identifier of the element.

deleteIndex()

Deletes index and mark iblock as having none.

public static deleteIndex(int $iblockId) : void
Parameters
$iblockId : int

Information block identifier.

disableDeferredIndexing()

Disable deferred indexing.

public static disableDeferredIndexing() : void

dropIfExists()

Drops all related to index database structures.

public static dropIfExists(int $iblockId) : void
Parameters
$iblockId : int

Information block identifier.

enableDeferredIndexing()

Enable deferred indexing.

public static enableDeferredIndexing() : void

markAsInvalid()

Marks iblock as one who needs index rebuild.

public static markAsInvalid(int $iblockId) : void
Parameters
$iblockId : int

Information block identifier.

onPropertyUpdate()

Marks iblock as one who needs index rebuild when it is needed.

public static onPropertyUpdate(int $iblockId, array<string|int, mixed> $propertyOld, array<string|int, mixed> $propertyNew) : void
Parameters
$iblockId : int

Information block identifier.

$propertyOld : array<string|int, mixed>

Previos property fields.

$propertyNew : array<string|int, mixed>

New property fields.

resolveElement()

If elementId is an offer, then it's product identifier returned Otherwise $elementId returned.

public static resolveElement(int $iblockId, int $elementId) : int
Parameters
$iblockId : int

Information block identifier.

$elementId : int

Element identifier.

Return values
int

resolveIblock()

For offers iblock identifier returns it's products iblock.

public static resolveIblock(int $iblockId) : int

Otherwise $iblockId returned.

Parameters
$iblockId : int

Information block identifier.

Return values
int

runDeferredIndexing()

Update iblock index if defered data exists.

public static runDeferredIndexing(int $iblockId) : void
Parameters
$iblockId : int

Iblock.

updateElementIndex()

Updates all related to element information if index exists.

public static updateElementIndex(int $iblockId, int $elementId) : void
Parameters
$iblockId : int

Information block identifier.

$elementId : int

Identifier of the element.

usedDeferredIndexing()

Return true if allowed deferred indexing.

public static usedDeferredIndexing() : bool
Return values
bool

        
On this page

Search results