Bitrix API

SegmentDataBuilder

Table of Contents

Constants

FILTER_COUNTER_TAG  = 'senderGroupFilterCounter'

Methods

__construct()  : mixed
SegmentDataBuilder constructor.
actualize()  : mixed
addToDB()  : mixed
buildData()  : bool
calculateCurrentFilterCount()  : DataCounter
calculateFilterCounts()  : array<string|int, DataCounter>
Calculate all current counters
checkBuild()  : void
checkIsSegmentPrepared()  : mixed
checkNotCompleted()  : string
clearBuilding()  : mixed
clearGroupBuilding()  : mixed
completeBuilding()  : mixed
createGroupState()  : array<string|int, mixed>|null
getAllStates()  : array<string|int, mixed>|bool|false
getCurrentGroupState()  : array<string|int, mixed>|bool|false
getData()  : Result
getDataCount()  : int
getPreparedData()  : Result
getQuery()  : Query
haltBuilding()  : mixed
isBuildingCompleted()  : bool
prepareForAgent()  : bool
resetGroupState()  : array<string|int, mixed>
run()  : string
setDataFilter()  : SegmentDataBuilder
setEndpoint()  : SegmentDataBuilder
updateGroupStateOffset()  : mixed

Constants

Methods

__construct()

SegmentDataBuilder constructor.

public __construct(int $groupId, string $filterId[, array<string|int, mixed> $endpoint = [] ][, int|null $groupStateId = null ]) : mixed
Parameters
$groupId : int
$filterId : string
$endpoint : array<string|int, mixed> = []
$groupStateId : int|null = null

actualize()

public static actualize(int $groupId[, bool $rebuild = false ]) : mixed
Parameters
$groupId : int
$rebuild : bool = false
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

addToDB()

public addToDB(Result $data) : mixed
Parameters
$data : Result
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

buildData()

public buildData([mixed $perPage = null ]) : bool
Parameters
$perPage : mixed = null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

calculateCurrentFilterCount()

public calculateCurrentFilterCount() : DataCounter
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
DataCounter

calculateFilterCounts()

Calculate all current counters

public calculateFilterCounts() : array<string|int, DataCounter>
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, DataCounter>

checkIsSegmentPrepared()

public static checkIsSegmentPrepared(int $groupId) : mixed
Parameters
$groupId : int
Tags
throws
ArgumentException
throws
SqlQueryException
throws
ObjectPropertyException
throws
SystemException

checkNotCompleted()

public static checkNotCompleted() : string
Return values
string

clearBuilding()

public clearBuilding(int $groupStateId) : mixed
Parameters
$groupStateId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

clearGroupBuilding()

public static clearGroupBuilding(int $groupId) : mixed
Parameters
$groupId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

completeBuilding()

public completeBuilding() : mixed
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

createGroupState()

public createGroupState() : array<string|int, mixed>|null
Tags
throws
Exception
Return values
array<string|int, mixed>|null

getAllStates()

public getAllStates() : array<string|int, mixed>|bool|false
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|bool|false

getCurrentGroupState()

public getCurrentGroupState() : array<string|int, mixed>|bool|false
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|bool|false

getDataCount()

public getDataCount([bool $useFilterId = true ]) : int
Parameters
$useFilterId : bool = true
Tags
throws
Exception
Return values
int

haltBuilding()

public haltBuilding() : mixed
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

isBuildingCompleted()

public isBuildingCompleted() : bool
Tags
throws
Exception
Return values
bool

prepareForAgent()

public prepareForAgent([mixed $rebuild = false ]) : bool
Parameters
$rebuild : mixed = false
Tags
throws
Exception
Return values
bool

resetGroupState()

public resetGroupState(int $id) : array<string|int, mixed>
Parameters
$id : int
Tags
throws
Exception
Return values
array<string|int, mixed>

run()

public static run(mixed $groupStateId[, null $perPage = null ]) : string
Parameters
$groupStateId : mixed
$perPage : null = null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
string

updateGroupStateOffset()

public updateGroupStateOffset(int $offset) : mixed
Parameters
$offset : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results