Bitrix API

PathIndexCollection extends EO_PathIndex_Collection

Tags
see
Collection

Table of Contents

Properties

$verbose  : bool

Methods

arrangeTree()  : self
Rearrange tree as nested set structure.
collect()  : int
Collect path structure.
collectAssignment()  : self
Collect file asssignment.
collectModuleAssignment()  : self
Collect sssignment file to module.
constructAncestorsByPath()  : array<string|int, mixed>|null
Searchs or creates ancestor index by path.
countItemsToProcess()  : int
Counts items to process.
purge()  : self
Drop index.
unvalidate()  : self
Unvalidate index.
validate()  : self
Unvalidate index.

Properties

Methods

arrangeTree()

Rearrange tree as nested set structure.

public arrangeTree() : self
Return values
self

collect()

Collect path structure.

public collect([Filter|null $filter = null ][, ITimeLimit|null $timer = null ][, Filter|null $seek = null ]) : int
Parameters
$filter : Filter|null = null

Params to filter file list.

$timer : ITimeLimit|null = null

Time counter.

$seek : Filter|null = null

Params to seek position.

Return values
int

collectAssignment()

Collect file asssignment.

public collectAssignment([Filter|null $filter = null ]) : self
Parameters
$filter : Filter|null = null

Params to filter file list.

Return values
self

collectModuleAssignment()

Collect sssignment file to module.

public collectModuleAssignment([Filter|null $filter = null ]) : self
Parameters
$filter : Filter|null = null

Params to filter file list.

Return values
self

constructAncestorsByPath()

Searchs or creates ancestor index by path.

public constructAncestorsByPath(string $path) : array<string|int, mixed>|null
Parameters
$path : string

Path to search.

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

countItemsToProcess()

Counts items to process.

public countItemsToProcess([Filter|null $filter = null ]) : int
Parameters
$filter : Filter|null = null

Params to filter file list.

Return values
int

purge()

Drop index.

public purge([Filter|null $filter = null ]) : self
Parameters
$filter : Filter|null = null

Params to filter file list.

Return values
self

unvalidate()

Unvalidate index.

public unvalidate([Filter|null $filter = null ][, bool $recursively = true ]) : self
Parameters
$filter : Filter|null = null

Params to filter file list.

$recursively : bool = true

Drop index recursively.

Return values
self

validate()

Unvalidate index.

public validate([Filter|null $filter = null ][, bool $recursively = true ]) : self
Parameters
$filter : Filter|null = null

Params to filter file list.

$recursively : bool = true

Drop index recursively.

Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results