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

Открытые члены
	__construct (string $accountId=null)

	setAccountId (string $accountId)

	getAccountId ()

	getForm ($formId)

	getList ()

	getResult (WebHook\Payload\LeadItem $item)

	add (array $data)

	register ($formId)

	unlink (string $id)

	getRegisteredGroups ()

	unRegisterGroup (string $groupId)

	registerGroup (string $groupId)

	loadLeads ($formId)

	unregisterForms ()

	unregisterForm ($adsFormId)

	getGroupAuthAdapter ()

Открытые члены унаследованные от BaseApiObject
	__construct ()

	getRequest ()

	setRequest (Request $request)

	setService (IService $service)

Открытые статические члены
static	convertField (Field $field)

static	convertFields (array $fields)

static	getUrlFormList ()

static	isSupportAccount ()

static	getPrivacyPolicyUrl ()

static	isGroupAuthUsed ()

Открытые статические члены унаследованные от BaseApiObject
static	normalizeListRow (array $row)

static	create ($type, $parameters=null, IService $service=null)

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

const	USE_GROUP_AUTH = false

const	FIELD_MAP = []

Открытые атрибуты унаследованные от BaseApiObject
const	TYPE_CODE = ''

Защищенные члены
	registerFormWebHook ($adsFormId, array $parameters=[])

	registerForm ($adsFormId)

	removeFormWebHook ($adsFormId)

	getAuthParameters ()

Защищенные статические члены
static	getFieldMapper ()

Защищенные данные
	$accountId

	$formId

Защищенные данные унаследованные от BaseApiObject
	$request

	$service

Статические защищенные данные
static	$listRowMap

Статические защищенные данные унаследованные от BaseApiObject
static	$listRowMap = array()

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

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

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

◆ __construct()

__construct ( string $accountId = null )

Form constructor.

Аргументы

string | null $accountId Account ID.

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

Методы

◆ add()

add ( array $data )

abstract

Add.

Аргументы

array $data Data.

Возвращает: Response

Переопределяется в FormFacebook и FormVkontakte.

◆ convertField()

static convertField ( Field $field )

static

Convert field.

Аргументы

Field $field Field.

Возвращает: array

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

◆ convertFields()

static convertFields ( array $fields )

static

Convert fields.

Аргументы

Field[] $fields Fields.

Возвращает: array

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

◆ getAccountId()

getAccountId ( )

Возвращает: string|null

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

◆ getAuthParameters()

getAuthParameters ( )

protected

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

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

◆ getFieldMapper()

static getFieldMapper ( )

staticprotected

Возвращает: Mapper

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

◆ getForm()

getForm ( $formId )

abstract

Аргументы

$formId

Возвращает: LeadAds\Response\FormResponse

◆ getGroupAuthAdapter()

getGroupAuthAdapter ( )

Get group auth adapter.

Возвращает: Retargeting\AuthAdapter|null

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

◆ getList()

getList ( )

abstract

Get list.

Возвращает: LeadAds\Response\FormResponse

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

◆ getPrivacyPolicyUrl()

static getPrivacyPolicyUrl ( )

static

Get privacy policy url.

Возвращает: string

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

◆ getRegisteredGroups()

getRegisteredGroups ( )

Get registered groups.

Возвращает: string[]

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

◆ getResult()

getResult ( WebHook\Payload\LeadItem $item )

abstract

Get result.

Аргументы

WebHook\Payload\LeadItem $item Payload item instance.

Возвращает: Result

Переопределяется в FormFacebook и FormVkontakte.

◆ getUrlFormList()

static getUrlFormList ( )

static

Get form list url.

Возвращает: string

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

◆ isGroupAuthUsed()

static isGroupAuthUsed ( )

static

Return true if group auth used.

Возвращает: bool

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

◆ isSupportAccount()

static isSupportAccount ( )

static

Is account supported.

Возвращает: bool

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

◆ loadLeads()

loadLeads ( $formId )

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

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

◆ register()

register ( $formId )

abstract

Register WebHook

Аргументы

$formId

Возвращает: Retargeting\Response

Переопределяется в FormFacebook и FormVkontakte.

◆ registerForm()

registerForm ( $adsFormId )

protected

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

◆ registerFormWebHook()

registerFormWebHook	(		$adsFormId,
		array	$parameters = [] )

protected

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

◆ registerGroup()

registerGroup ( string $groupId )

Register group.

Аргументы

string $groupId Group ID.

Возвращает: bool

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

◆ removeFormWebHook()

removeFormWebHook ( $adsFormId )

protected

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

◆ setAccountId()

setAccountId ( string $accountId )

Set account id.

Аргументы

string $accountId Account ID.

Возвращает: self

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

◆ unlink()

unlink ( string $id )

abstract

Unlink.

Аргументы

string $id,.

Возвращает: bool

Переопределяется в FormFacebook и FormVkontakte.

◆ unregisterForm()

unregisterForm ( $adsFormId )

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

◆ unregisterForms()

unregisterForms ( )

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

◆ unRegisterGroup()

unRegisterGroup ( string $groupId )

Unregister group.

Аргументы

string $groupId Group ID.

Возвращает: bool

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

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

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

◆ $accountId

$accountId

protected

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

◆ $formId

$formId

protected

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

◆ $listRowMap

$listRowMap

staticprotected

Инициализатор

= array(
        'ID' => 'ID',
        'NAME' => 'NAME',
    )

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

◆ FIELD_MAP

const FIELD_MAP = []

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

◆ URL_FORM_LIST

const URL_FORM_LIST = ''

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

◆ USE_GROUP_AUTH

const USE_GROUP_AUTH = false

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

Bitrix-D7 23.9

Открытые члены

Открытые статические члены

Открытые атрибуты

Защищенные члены

Защищенные статические члены

Защищенные данные

Статические защищенные данные

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

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

◆ __construct()

Методы

◆ add()

◆ convertField()

◆ convertFields()

◆ getAccountId()

◆ getAuthParameters()

◆ getFieldMapper()

◆ getForm()

◆ getGroupAuthAdapter()

◆ getList()

◆ getPrivacyPolicyUrl()

◆ getRegisteredGroups()

◆ getResult()

◆ getUrlFormList()

◆ isGroupAuthUsed()

◆ isSupportAccount()

◆ loadLeads()

◆ register()

◆ registerForm()

◆ registerFormWebHook()

◆ registerGroup()

◆ removeFormWebHook()

◆ setAccountId()

◆ unlink()

◆ unregisterForm()

◆ unregisterForms()

◆ unRegisterGroup()

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

◆ $accountId

◆ $formId

◆ $listRowMap

◆ FIELD_MAP

◆ URL_FORM_LIST

◆ USE_GROUP_AUTH