Модели

Общее описание

Это абстрактный js-экстеншн, содержащий только один класс.

Этот класс в паре с Service\Converter призван обеспечить "бесшовный" и прозрачный обмен данными между бекендом и фронтендом.

Жизненный цикл выглядит следующим образом:

• Данные загружаются из базы данных.
• На бекенде они преобразуются в json с помощью Service\Converter.
• На основе данных создается наследник crm.model, обеспечивающий удобный доступ к данным на стороне фронтенда.
• Данные могут быть изменены на фронтенде по аналогии с методами EntityObject на бекенде.
• После изменения данные могут быть сохранены вызовом метода save, который сделает ajax-запрос на соответствующий контроллер.
• Контроллер выполнит действие над элементом и вернет обратно актуальное состояние объекта снова в json формате.

Есть ещё вариант, когда на фронте есть только id и модель может получить актуальные данные с бекенда с помощью метода load().

Чтобы все эти действия работали, внутри модели должен быть способ получить название четырех ajax-действий:

• get;
• add;
• update;
• delete.

По умолчанию названия действий получаются как 'crm.api.' + this.getModelName() + '.' + action.

Модель можно сконфигурировать, передав дополнительные get-параметры для каждого действия

Но чтобы вся цепочка заработала как задумано, на каждый тип данных необходимо иметь:

• свою реализацию конвертера;
• свою реализацию модели;
• свой контроллер.

Пока что всё это есть только для настроек смарт-процесса (crm.type-model).

Методы

constructor(data: {}, params: {})

get actions()

compileActionString(action: string): string

getId(): ?number

getEntityTypeId(): ?number

isSaved(): boolean

isDeleted(): boolean

setData(data)

getData()

setGetParameters(action: string, 
parameters: getParameters)

getGetParameters(action: string): 
getParameters

getModelName(): string

setDataFromResponse(response: {data: {}})

load(): Promise<{data: {}},string[]>

save(): Promise<{data: {}},string[]>

delete(): Promise<{data: {}},string[]>

Наследники

TypeModel (crm.type-model)

Класс для работы с настройками смарт-процессов.

ajax-действия:

• get: crm.type.get
• add: crm.type.add
• update: crm.type.update
• delete: crm.type.delete

Позволяет полноценно работать с данными на стороне фронтенда.

Помимо методов базового класса обладает рядом именных методов для получения / изменения данных модели.

• getTitle / setTitle
• getCreatedBy
• getIsCategoriesEnabled / setIsCategoriesEnabled
• getIsStagesEnabled / setIsStagesEnabled
• getIsBeginCloseDatesEnabled / setIsBeginCloseDatesEnabled
• getIsClientEnabled / setIsClientEnabled
• getIsLinkWithProductsEnabled / setIsLinkWithProductsEnabled
• getIsCrmTrackingEnabled / setIsCrmTrackingEnabled
• getIsMycompanyEnabled / setIsMycompanyEnabled
• getIsDocumentsEnabled / setIsDocumentsEnabled
• getIsSourceEnabled / setIsSourceEnabled
• getIsUseInUserfieldEnabled / setIsUseInUserfieldEnabled
• getIsObserversEnabled / setIsObserversEnabled
• getIsRecyclebinEnabled / setIsRecyclebinEnabled
• getIsAutomationEnabled / setIsAutomationEnabled
• getIsBizProcEnabled / setIsBizProcEnabled
• getIsSetOpenPermissions / setIsSetOpenPermissions
• getLinkedUserFields / setLinkedUserFields
• getCustomSectionId / setCustomSectionId

Помимо этих полей есть методы управления сложными данными о настройках - настройки дополнительных разделов и настройки связей:

• getCustomSections / setCustomSections

  Данные о настройках дополнительных разделов имеют вид массива с элементами:

  {
  	id: number,
  	title: string,
  	isSelected: boolean
  }
  

• getRelations / setRelations

  Данные о настройках связей имеют вид RelationsMap[]:

  declare type RelationsMap = {
  	parent: Relation[],
  	child: Relation[],
  }
  
  declare type Relation = {
  	entityTypeId: number,
  	isChildrenListEnabled?: boolean|null,
  	isPredefined?: boolean,
  }
  

StageModel (crm.stage-model)

Модель данных о стадии. Не работает с ajax-действиями, работает только на фронтенде.

Имеет набор именованных методов для получения данных о стадии:

• getName / setName
• getEntityId
• getStatusId
• getSort / setSort
• getColor / setColor
• getSemantics
• getCategoryId
• isFinal
• isSuccess
• isFailure

CategoryModel (crm.category-model)

Модель данных о направлении произвольного типа сущности. Не работает с ajax-действиями, работает только на фронтенде.

Имеет набор именованных методов для получения данных о направлении:

• getName / setName
• getSort / setSort
• isDefault / setDefault

Примеры

$entityTypeId = 140;

$type = \Bitrix\Crm\Model\Dynamic\TypeTable::getByEntityTypeId($entityTypeId)->fetchObject();

\Bitrix\Main\UI\Extension::load(['crm.type-model']);

const typeModel = new BX.Crm.Models.TypeModel(jsonSerialize()) ?>);

typeModel.setTitle('newTitle);

typeModel.save().then(() => {
	console.log('typeModel updated');
});