Класс Campaign

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

Открытые члены
	loadData ($id)
	getSiteId ()
	getSiteName ()
	getSubscriberCount ()
	activate ($isActivate=true)
	deactivate ()
	remove ()
Открытые члены унаследованные от 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	getList (array $parameters=array())
static	getDefaultId ($siteId=null)
static	getSites ()
static	removeById ($id)
Открытые статические члены унаследованные от Base
static	getPersonalizeList ()

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

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

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

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

Методы

activate()

activate

(

$isActivate = true

)

Activate.

Аргументы

bool

$isActivate

Is activate.

Возвращает

$this

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

deactivate()

deactivate

(

)

Deactivate.

Возвращает

$this

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

getDefaultData()

getDefaultData ( )

protected

Get default data.

Возвращает

array

Переопределяется в TriggerCampaign.

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

getDefaultId()

getDefaultId ( $siteId = null )

static

Get default campaign id.

Аргументы

null | string

$siteId

Site id.

Возвращает

int

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

getList()

getList ( array $parameters = array() )

static

Get list.

Аргументы

array

$parameters

Parameters.

Возвращает

\Bitrix\Main\DB\Result

Переопределяется в TriggerCampaign.

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

getSiteId()

getSiteId

(

)

Get site ID.

Возвращает

string

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

getSiteName()

getSiteName

(

)

Get site name.

Возвращает

string

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

getSites()

getSites ( )

static

Get sites.

Возвращает

array

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

getSubscriberCount()

getSubscriberCount

(

)

Get subscriber count.

Возвращает

int

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

loadData()

loadData

(

$id

)

Load data.

Аргументы

integer

$id

ID.

Возвращает

array|null

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

remove()

remove

(

)

Remove.

Возвращает

bool

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

removeById()

removeById ( $id )

static

Remove by contact ID.

Аргументы

integer

$id

Contact ID.

Возвращает

bool

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

saveData()

saveData ( $id, array $data )

protected

Save data.

Аргументы

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

Возвращает

integer|null

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

---

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

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