Открытые члены
	__construct ()

	getErrors ()

	addSubscribe (array $subscribeData)

	deleteManySubscriptions (array $listSubscribeId, $itemId=0)

	checkAccessToSubscription ($subscribeId)

	runSubscriberIdentification (array $subscriberData, $sendLetter=true)

	authorizeSubscriber (array $authorizationData)

	unSubscribe (array $data)

	activateSubscription (array $listSubscribeId, $timePeriod=0)

	deactivateSubscription (array $listSubscribeId)

	checkSubscriptionActivity ($dateTo)

	setSessionOfSibscribedProducts ($itemId)

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

const	ERROR_ADD_SUBSCRIBE = 'ERROR_ADD_SUBSCRIBE_12002'

const	ERROR_VALIDATE_FIELDS = 'ERROR_VALIDATE_FIELDS_12003'

const	ERROR_SUBSCRIBER_IDENTIFICATION = 'ERROR_SUBSCRIBER_IDENTIFICATION_12004'

const	ERROR_AUTHORIZATION = 'ERROR_AUTHORIZATION_12005'

const	ERROR_DELETE_SUBSCRIBE = 'ERROR_ADD_SUBSCRIBE_12006'

const	ERROR_ADD_SUBSCRIBE_ALREADY_EXISTS = 'ERROR_ADD_SUBSCRIBE_ALREADY_EXISTS_12007'

const	ERROR_ACTIVITY_CHANGE = 'ERROR_ACTIVITY_CHANGE_12008'

const	ERROR_UNSUBSCRIBE = 'ERROR_UNSUBSCRIBE_12009'

	$contactTypes = array()

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

	$userId = 0

	$isAdmin = false

	$fields = array()

	$listAvailableFields

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

Class SubscribeManager manages subscriptions.

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

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

◆ __construct()

__construct ( )

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

Методы

◆ activateSubscription()

activateSubscription	(	array	$listSubscribeId,
			$timePeriod = `0`
	)

The method activates the subscription clearing a field DATE_TO or writing the subscription term.

Аргументы

array	$listSubscribeId	List subscribe id.
int	$timePeriod	Subscription period in seconds.

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

Исключения

Exception

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

◆ addSubscribe()

addSubscribe ( array $subscribeData )

The method creates a new subscription.

Аргументы

array $subscribeData An array containing the data of a new subscription.

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

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ArgumentNullException

Исключения

Exception

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

◆ authorizeSubscriber()

authorizeSubscriber ( array $authorizationData )

The method authenticates an anonymous subscriber.

Аргументы

array $authorizationData The authentication information.

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

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

◆ checkAccessToSubscription()

checkAccessToSubscription ( $subscribeId )

The method checks the access to subscription by using the userId or token. Administrators subscription is always available.

Аргументы

integer $subscribeId Subscribe id.

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

Исключения

Bitrix\Main\ArgumentException

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

◆ checkSubscriptionActivity()

checkSubscriptionActivity ( $dateTo )

The method checks the subscription activity field value DATE_TO.

Аргументы

mixed $dateTo An empty value or an instance DateTime.

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

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

◆ deactivateSubscription()

deactivateSubscription ( array $listSubscribeId )

The method deactivates the subscription by writing the current date.

Аргументы

array $listSubscribeId List subscribe id.

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

Исключения

Exception

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

◆ deleteManySubscriptions()

deleteManySubscriptions	(	array	$listSubscribeId,
			$itemId = `0`
	)

The method removes a lot of subscriptions received subscribeId list with the account permissions.

Аргументы

array	$listSubscribeId	List subscribe id.
integer	$itemId	If this parameter is passed, cleaned write to the session.

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

Исключения

Exception

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

◆ getErrors()

getErrors ( )

Возвращает: array An array containing Error objects.

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

◆ runSubscriberIdentification()

runSubscriberIdentification	(	array	$subscriberData,
			$sendLetter = `true`
	)

The method begins the process of identification of the anonymous subscriber.

Аргументы

array	$subscriberData	An array containing the data necessary for identification.
bool	$sendLetter	Marker, checks whether to send a letter.

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

Исключения

Bitrix\Main\ArgumentNullException

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

◆ setSessionOfSibscribedProducts()

setSessionOfSibscribedProducts ( $itemId )

Write product id to the session to check that the user has subscribed.

Аргументы

integer $itemId Product id.

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

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

◆ unSubscribe()

unSubscribe ( array $data )

Method unsubscribe subscribers with fixed input data.

Аргументы

array $data Input data.

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

Исключения

Bitrix\Main\ArgumentException

Исключения

Exception

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

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

◆ $contactTypes

$contactTypes = array()

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

◆ $errorCollection

$errorCollection

protected

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

◆ $fields

$fields = array()

protected

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

◆ $isAdmin

$isAdmin = false

protected

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

◆ $listAvailableFields

$listAvailableFields

protected

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

= array(
        'DATE_TO',
        'USER_CONTACT',
        'CONTACT_TYPE',
        'USER_ID',
        'ITEM_ID',
        'NEED_SENDING',
        'SITE_ID',
        'LANDING_SITE_ID'
    )

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

◆ $userId

$userId = 0

protected

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

◆ ERROR_ACTIVITY_CHANGE

const ERROR_ACTIVITY_CHANGE = 'ERROR_ACTIVITY_CHANGE_12008'

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

◆ ERROR_ADD_SUBSCRIBE

const ERROR_ADD_SUBSCRIBE = 'ERROR_ADD_SUBSCRIBE_12002'

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

◆ ERROR_ADD_SUBSCRIBE_ALREADY_EXISTS

const ERROR_ADD_SUBSCRIBE_ALREADY_EXISTS = 'ERROR_ADD_SUBSCRIBE_ALREADY_EXISTS_12007'

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

◆ ERROR_AUTHORIZATION

const ERROR_AUTHORIZATION = 'ERROR_AUTHORIZATION_12005'

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

◆ ERROR_DELETE_SUBSCRIBE

const ERROR_DELETE_SUBSCRIBE = 'ERROR_ADD_SUBSCRIBE_12006'

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

◆ ERROR_REQUIRED_PARAMATERS

const ERROR_REQUIRED_PARAMATERS = 'ERROR_REQUIRED_PARAMATERS_12001'

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

◆ ERROR_SUBSCRIBER_IDENTIFICATION

const ERROR_SUBSCRIBER_IDENTIFICATION = 'ERROR_SUBSCRIBER_IDENTIFICATION_12004'

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

◆ ERROR_UNSUBSCRIBE

const ERROR_UNSUBSCRIBE = 'ERROR_UNSUBSCRIBE_12009'

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

◆ ERROR_VALIDATE_FIELDS

const ERROR_VALIDATE_FIELDS = 'ERROR_VALIDATE_FIELDS_12003'

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

Bitrix-D7 22.6

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

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

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

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

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

◆ __construct()

Методы

◆ activateSubscription()

◆ addSubscribe()

◆ authorizeSubscriber()

◆ checkAccessToSubscription()

◆ checkSubscriptionActivity()

◆ deactivateSubscription()

◆ deleteManySubscriptions()

◆ getErrors()

◆ runSubscriberIdentification()

◆ setSessionOfSibscribedProducts()

◆ unSubscribe()

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

◆ $contactTypes

◆ $errorCollection

◆ $fields

◆ $isAdmin

◆ $listAvailableFields

◆ $userId

◆ ERROR_ACTIVITY_CHANGE

◆ ERROR_ADD_SUBSCRIBE

◆ ERROR_ADD_SUBSCRIBE_ALREADY_EXISTS

◆ ERROR_AUTHORIZATION

◆ ERROR_DELETE_SUBSCRIBE

◆ ERROR_REQUIRED_PARAMATERS

◆ ERROR_SUBSCRIBER_IDENTIFICATION

◆ ERROR_UNSUBSCRIBE

◆ ERROR_VALIDATE_FIELDS