Класс Segment

Граф наследования:Segment:

Открытые члены
	isHidden ()
	isSystem ()
	isFilterOnly ()
	setFilterOnlyMode ($mode=true)
	appendContactSetConnector ($contactSetId=null)
	upload (array $list)
	remove ()
	copy ()
Открытые члены унаследованные от Base
	setModuleId ($moduleId)
	getModuleId ()
	getDataTypeId ()
	setDataTypeId ($dataTypeId)
	setFieldFormName ($fieldFormName)
	getFieldFormName ()
	setFieldPrefix ($fieldPrefix)
	getFieldPrefix ()
	setFieldPrefixExtended ($fieldPrefixExtended)
	getFieldPrefixExtended ()
	setFieldValues (array $fieldValues=null)
	getFieldValues ()
	hasFieldValues ()
	getFieldId ($id)
	getFieldName ($name)
	getFieldValue ($name, $defaultValue=null)
	getId ()
	getDataCount ()
	getDataCounter ()
	getResult ()
	isResultViewable ()
	getResultView ()
	setResultView ($resultView)
	requireConfigure ()
	getName ()
	getCode ()
	getData ()
	buildData ()
	getForm ()
	getStatFields ()
	isCheckAccessRights ()
	setCheckAccessRights (bool $checkAccessRights)

Открытые статические члены
static	getDefaultIds ()
static	getIdByCode ($code)
static	getList (array $parameters=array())
static	updateAddressCounters ($segmentId, array $counters)
static	getAddressCounter ($segmentId)
static	getAddressCounters (array $list)
static	updateUseCounters (array $list, $isInclude=true)
static	removeById ($id)
Открытые статические члены унаследованные от Base
static	getPersonalizeList ()

Поля данных
const	CODE_ALL = 'all'

Защищенные члены
	getDefaultData ()
	loadData ($id)
	saveData ($id, array $data)
	getFirstContactSetId ()
Защищенные члены унаследованные от Base
	getDataCountByType ()
	onInitResultView ()

Защищенные данные
	$isFilterOnly = false
Защищенные данные унаследованные от Base
	$fieldPrefix
	$fieldPrefixExtended
	$fieldValues
	$fieldFormName
	$moduleId
	$resultView
	$dataTypeId = Recipient\Type::EMAIL
bool	$checkAccessRights = true

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

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

Методы

appendContactSetConnector()

appendContactSetConnector

(

$contactSetId = null

)

Append contact set connector.

Аргументы

int | null

$contactSetId

Contact set ID.

Возвращает

$this

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

copy()

copy

(

)

Copy.

Возвращает

bool

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

getAddressCounter()

getAddressCounter ( $segmentId )

static

Get segment address counter.

Аргументы

integer

$segmentId

Segment ID.

Возвращает

Connector\DataCounter

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

getAddressCounters()

getAddressCounters ( array $list )

static

Get segment address counters.

Аргументы

integer[]

$list

List of ID.

Возвращает

array

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

getDefaultData()

getDefaultData ( )

protected

Get default data.

Возвращает

array

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

getDefaultIds()

getDefaultIds ( )

static

Get default segments.

Возвращает

array

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

getFirstContactSetId()

getFirstContactSetId ( )

protected

Return fisrt contact set ID from in segment.

Возвращает

int|null

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

getIdByCode()

getIdByCode ( $code )

static

Get segment ID by code.

Аргументы

string | string[]

$code

Code.

Возвращает

integer|null

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

getList()

getList ( array $parameters = array() )

static

Get list.

Аргументы

array

$parameters

Parameters.

Возвращает

\Bitrix\Main\DB\Result

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

isFilterOnly()

isFilterOnly

(

)

Is save filters only.

Возвращает

bool

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

isHidden()

isHidden

(

)

Return true if segment is hidden.

Возвращает

bool

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

isSystem()

isSystem

(

)

Return true if segment is system.

Возвращает

bool

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

loadData()

loadData ( $id )

protected

Load data.

Аргументы

integer

$id

ID.

Возвращает

array|null

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

remove()

remove

(

)

Remove.

Возвращает

bool

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

removeById()

removeById ( $id )

static

Remove by letter ID.

Аргументы

integer

$id

Letter ID.

Возвращает

bool

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

saveData()

saveData ( $id, array $data )

protected

Save data.

Аргументы

integer | null	$id	ID.
array	$data	Data.

Возвращает

integer|null

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

setFilterOnlyMode()

setFilterOnlyMode

(

$mode = true

)

Set save filter only mode.

Аргументы

bool

$mode

Mode.

Возвращает

$this

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

updateAddressCounters()

updateAddressCounters ( $segmentId, array $counters )

static

Update segment address counters.

Аргументы

integer	$segmentId	Segment ID.
Connector\DataCounter[]	$counters	Counters.

Возвращает

bool

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

updateUseCounters()

updateUseCounters ( array $list, $isInclude = true )

static

Update segment use counter.

Аргументы

integer[]	$list	Segment ID list.
bool	$isInclude	Update include counters.

Возвращает

void

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

upload()

upload

(

array

$list

)

Upload.

Аргументы

array

$list

List of emails and phones.

Возвращает

$this

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

Поля

$isFilterOnly

$isFilterOnly = false

protected

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

CODE_ALL

const CODE_ALL = 'all'

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

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/sender/lib/entity/segment.php