Класс SegmentDataBuilder

Открытые члены
	__construct (int $groupId, string $filterId, array $endpoint=[], ?int $groupStateId=null)
	getCurrentGroupState ()
	getAllStates ()
	isBuildingCompleted ()
	createGroupState ()
	resetGroupState (int $id)
	updateGroupStateOffset (int $offset)
	completeBuilding ()
	haltBuilding ()
	clearBuilding (int $groupStateId)
	addToDB (?Result $data)
	prepareForAgent ($rebuild=false)
	getQuery ()
	setDataFilter (array $filter=[])
	getData (PageNavigation $nav=null, bool $useFilterId=true)
	getPreparedData ()
	getDataCount (bool $useFilterId=true)
	calculateCurrentFilterCount ()
	calculateFilterCounts ()
	setEndpoint (array $endpoint)

Открытые статические члены
static	checkIsSegmentPrepared (int $groupId)
static	clearGroupBuilding (int $groupId)
static	run ($groupStateId, $perPage=null)
static	actualize (int $groupId, bool $rebuild=false)
static	checkBuild ()
static	checkNotCompleted ()

Открытые атрибуты
const	FILTER_COUNTER_TAG = 'senderGroupFilterCounter'

Подробное описание

См. определение в файле segmentdatabuilder.php строка 30

Конструктор(ы)

__construct()

__construct	(	int	$groupId,
		string	$filterId,
		array	$endpoint = [],
		?int	$groupStateId = null )

SegmentDataBuilder constructor.

Аргументы

int	$groupId
string	$filterId
array	$endpoint

См. определение в файле segmentdatabuilder.php строка 68

Методы

actualize()

static actualize ( int $groupId, bool $rebuild = false )

static

Аргументы

int	$groupId
bool	$rebuild

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 946

addToDB()

addToDB

(

?Result

$data

)

Аргументы

Result

$data

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 412

calculateCurrentFilterCount()

calculateCurrentFilterCount

(

)

Возвращает

Connector\DataCounter

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 836

calculateFilterCounts()

calculateFilterCounts

(

)

Calculate all current counters

Возвращает

Connector\DataCounter[]

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 890

checkBuild()

static checkBuild ( )

static

См. определение в файле segmentdatabuilder.php строка 1048

checkIsSegmentPrepared()

static checkIsSegmentPrepared ( int $groupId )

static

Аргументы

int

$groupId

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\DB\SqlQueryException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 262

checkNotCompleted()

static checkNotCompleted ( )

static

См. определение в файле segmentdatabuilder.php строка 1077

clearBuilding()

clearBuilding

(

int

$groupStateId

)

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 374

clearGroupBuilding()

static clearGroupBuilding ( int $groupId )

static

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 392

completeBuilding()

completeBuilding

(

)

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 235

createGroupState()

createGroupState

(

)

Возвращает

?array

Исключения

Exception

См. определение в файле segmentdatabuilder.php строка 166

getAllStates()

getAllStates

(

)

Возвращает

array|bool|false

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 139

getCurrentGroupState()

getCurrentGroupState

(

)

Возвращает

array|bool|false

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 115

getData()

getData	(	PageNavigation	$nav = null,
		bool	$useFilterId = true )

Возвращает

Result

Исключения

Exception

См. определение в файле segmentdatabuilder.php строка 699

getDataCount()

getDataCount

(

bool

$useFilterId = true

)

Возвращает

int

Исключения

Exception

См. определение в файле segmentdatabuilder.php строка 774

getPreparedData()

getPreparedData

(

)

Возвращает

Connector\Result

Исключения

Exception

См. определение в файле segmentdatabuilder.php строка 741

getQuery()

getQuery

(

)

Возвращает

\Bitrix\Main\ORM\Query\Query

Исключения

Exception

См. определение в файле segmentdatabuilder.php строка 610

haltBuilding()

haltBuilding

(

)

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 355

isBuildingCompleted()

isBuildingCompleted

(

)

Возвращает

bool

Исключения

Exception

См. определение в файле segmentdatabuilder.php строка 154

prepareForAgent()

prepareForAgent

(

$rebuild = false

)

Возвращает

bool

Исключения

Exception

См. определение в файле segmentdatabuilder.php строка 572

resetGroupState()

resetGroupState

(

int

$id

)

Возвращает

array

Исключения

Exception

См. определение в файле segmentdatabuilder.php строка 191

run()

static run ( $groupStateId, $perPage = null )

static

Аргументы

	$groupStateId
null	$perPage

Возвращает

string

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 795

setDataFilter()

setDataFilter

(

array

$filter = []

)

См. определение в файле segmentdatabuilder.php строка 660

setEndpoint()

setEndpoint

(

array

$endpoint

)

Аргументы

array

$endpoint

Возвращает

SegmentDataBuilder

См. определение в файле segmentdatabuilder.php строка 931

updateGroupStateOffset()

updateGroupStateOffset

(

int

$offset

)

Аргументы

int

$offset

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле segmentdatabuilder.php строка 213

Данные класса

FILTER_COUNTER_TAG

const FILTER_COUNTER_TAG = 'senderGroupFilterCounter'

См. определение в файле segmentdatabuilder.php строка 58