Bitrix API

BaseScenario

Table of Contents

Constants

SCENARIO_CALLBACK  = 'callback'

SCENARIO_CONTACTS  = 'contacts'

SCENARIO_DELIVERY_ADDRESS  = 'delivery_address'

SCENARIO_DELIVERY_AND_PAY  = 'delivery_and_pay'

SCENARIO_DEPENDENCY_EXCLUDING  = 'dependency_excluding'

SCENARIO_DEPENDENCY_RELATED  = 'dependency_related'

SCENARIO_DEPENDENCY_UNRELATED  = 'dependency_unrelated'

SCENARIO_EVENT_REGISTRATION  = 'event_registration'

SCENARIO_EXPERT  = 'expert'

SCENARIO_FACEBOOK  = 'facebook'

SCENARIO_FEEDBACK  = 'feedback'

SCENARIO_FILLING_DATA  = 'filling_data'

SCENARIO_FORM_IN_BUTTON  = 'form_in_button'

SCENARIO_FORM_IN_LINK  = 'form_in_link'

SCENARIO_FORM_IN_WIDGET  = 'form_in_widget'

SCENARIO_FORM_ON_PAGE  = 'form_on_page'

SCENARIO_FORM_ON_SITE  = 'form_on_site'

SCENARIO_FORM_ON_TIMER  = 'form_on_timer'

SCENARIO_MULTI_PAGE  = 'multi_page'

SCENARIO_OFFLINE_EVENT  = 'offline_event'

SCENARIO_OFFLINE_REGISTRATION_EVENT  = 'offline_registration_event'

SCENARIO_ONLINE_EVENT  = 'online_event'

SCENARIO_PERSONALISATION  = 'personalisation'

SCENARIO_PRODUCT1  = 'product1'

SCENARIO_PRODUCT2  = 'product2'

SCENARIO_PRODUCT3  = 'product3'

SCENARIO_PRODUCT4  = 'product4'

SCENARIO_VK  = 'vk'

SCENARIO_WHATSAPP  = 'whatsapp'

SCENARIOS  = [ self::SCENARIO_CALLBACK => '/bitrix/images/crm/webform/icons/revertcall.svg', self::SCENARIO_CONTACTS => '/bitrix/images/crm/webform/icons/contacts.svg', self::SCENARIO_EXPERT => '/bitrix/images/crm/webform/icons/service.svg', self::SCENARIO_FACEBOOK => '/bitrix/images/crm/webform/icons/facebook.svg', self::SCENARIO_FEEDBACK => '/bitrix/images/crm/webform/icons/feedback.svg', self::SCENARIO_PERSONALISATION => '/bitrix/images/crm/webform/icons/personalization.svg', self::SCENARIO_PRODUCT1 => '/bitrix/images/crm/webform/icons/products1.svg', self::SCENARIO_PRODUCT2 => '/bitrix/images/crm/webform/icons/products2.svg', self::SCENARIO_PRODUCT3 => '/bitrix/images/crm/webform/icons/products3.svg', self::SCENARIO_PRODUCT4 => '/bitrix/images/crm/webform/icons/products4.svg', self::SCENARIO_VK => '/bitrix/images/crm/webform/icons/vk.svg', self::SCENARIO_DELIVERY_ADDRESS => '/bitrix/images/crm/webform/icons/deliveryaddress.svg', self::SCENARIO_DELIVERY_AND_PAY => '/bitrix/images/crm/webform/icons/deliveryandpay.svg', // self::SCENARIO_WHATSAPP => '/bitrix/images/crm/webform/icons/revertcall.svg', self::SCENARIO_EVENT_REGISTRATION => '/bitrix/images/crm/webform/icons/online.svg', self::SCENARIO_OFFLINE_EVENT => '/bitrix/images/crm/webform/icons/offlineevent.svg', self::SCENARIO_OFFLINE_REGISTRATION_EVENT => '/bitrix/images/crm/webform/icons/eventregistration.svg', // self::SCENARIO_FORM_IN_BUTTON => '/bitrix/images/crm/webform/icons/smart.svg', // self::SCENARIO_FORM_ON_TIMER => '/bitrix/images/crm/webform/icons/smart.svg', // self::SCENARIO_FORM_IN_LINK => '/bitrix/images/crm/webform/icons/smart.svg', // self::SCENARIO_FORM_IN_WIDGET => '/bitrix/images/crm/webform/icons/smart.svg', // self::SCENARIO_FORM_ON_PAGE => '/bitrix/images/crm/webform/icons/smart.svg', // self::SCENARIO_FORM_ON_SITE => '/bitrix/images/crm/webform/icons/smart.svg', self::SCENARIO_DEPENDENCY_UNRELATED => '/bitrix/images/crm/webform/icons/dependencyunrelated.svg', self::SCENARIO_DEPENDENCY_RELATED => '/bitrix/images/crm/webform/icons/dependencyrelated.svg', self::SCENARIO_DEPENDENCY_EXCLUDING => '/bitrix/images/crm/webform/icons/dependencyexcluding.svg', self::SCENARIO_FILLING_DATA => '/bitrix/images/crm/webform/icons/filldata.svg', self::SCENARIO_MULTI_PAGE => '/bitrix/images/crm/webform/icons/multipage.svg', ]

Methods

__construct()  : mixed

Base scenario constructor. Load messages for all scenarios.

canUse()  : bool

check()  : array<string|int, mixed>

checkFields()  : array<string|int, mixed>

Check available scenario fields.

fieldsToCheck()  : $this

getActions()  : mixed

getCategory()  : mixed

getConfiguration()  : array<string|int, mixed>

Create configuration for scenario

getDefaultSection()  : mixed

getDescription()  : string

get scenario description

getExpertModeMenuItems()  : array<string|int, mixed>|null

getIcon()  : string

getId()  : string

getMenuItems()  : array<string|int, mixed>

getTitle()  : string

get scenario title

isActive()  : bool

isOpenable()  : bool

isSoon()  : bool

prepare()  : array<string|int, mixed>

Preparing scenario behaviour

prepareBuilder()  : BaseScenario

setActions()  : BaseScenario

setActive()  : BaseScenario

setCanUse()  : BaseScenario

setCategory()  : BaseScenario

setCreateDateInTitle()  : $this

setDefaultSection()  : BaseScenario

setExpertModeMenuItems()  : BaseScenario

Set available exprert mode menu items of the scenario.

setIcon()  : BaseScenario

setId()  : BaseScenario

setMenuItems()  : BaseScenario

Set available menu items of the scenario.

setOpenable()  : BaseScenario

setSoon()  : BaseScenario

setTitle()  : BaseScenario