class Types/entity:Model

Абстрактная модель.

Модели обеспечивают доступ к данным и поведению объектов предметной области (сущностям).

Такими сущностями могут быть, например, товары, пользователи, документы - и другие предметы окружающего мира, которые вы моделируете в своем приложении.

class Types/_entity/Model<T>

Примечание

В основе абстрактной модели лежит запись.

Основные аспекты модели (дополнительно к аспектам записи):

определение собственных свойств сущности;

уникальный идентификатор сущности среди ей подобных.

Поведенческие аспекты каждой сущности реализуются ее прикладным модулем в виде публичных методов.

Прикладные модели могут внедряться в порождающие их объекты, такие как источники данных или рекордсеты.

Для реализации конкретной модели используется наследование от абстрактной либо промежуточной.

Для корректной сериализации и клонирования моделей необходимо выносить их в отдельные модули и указывать имя модуля в свойстве _moduleName каждого наследника:

    //My/Awesome/Model.ts
    import {Model} from 'Types/entity';
    export default class AwesomeModel extends Model {
        protected _moduleName: string = 'My/Awesome/Model';
        //...
    });

    return AwesomeModel;

Определим модель пользователя:

    //My/Awesome/Model.ts
    import {Salt} from 'Application/Lib';
    import {Model, format} from 'Types/entity';

   export default class User extends Model{
      protected _$format: format.FormatDeclaration = [
         {name: 'login', type: 'string'},
         {name: 'salt', type: 'string'}
      ];
      protected _$keyProperty: string = 'login';
      authenticate(password: string): boolean {
         return Salt.encode(this.get('login') + ':' + password) === this.get('salt');
      }
    });

Создадим модель пользователя:

    //Application/Controller/Test/Auth.ts
    import User from 'Application/Model/User';

    const user = new User();
    user.set({
        login: 'i.c.wiener',
        salt: 'grhS2Nys345fsSW3mL9'
    });
    const testOk = user.authenticate('its pizza time!');

Модели могут объединяться по принципу "матрёшки" - сырыми данными одной модели является другая модель. Для организации такой структуры следует использовать адаптер рекордсета:

    import {Model, adapter} from 'Types/entity';

    class MyEngine extends Model {
        protected _$properties = {
            fuelType: {
                get() {
                    return 'Diesel';
                }
            }
        }
    }

    class MyTransmission extends Model {
        protected _$properties = {
            transmissionType: {
                get() {
                    return 'Manual';
                }
            }
        }
    }

    const myCar = new MyEngine({
        rawData: new MyTransmission({
            rawData: {
                color: 'Red',
                fuelType: '',
                transmissionType: ''
            }
        }),
        adapter: new adapter.RecordSet()
    });

    console.log(myCar.get('fuelType')); // 'Diesel'
    console.log(myCar.get('transmissionType')); // 'Manual'
    console.log(myCar.get('color')); // 'Red'

Опции

adapterprotected

Адаптер, обеспечивающий доступ к необработанным данным определенного формата. По умолчанию поддерживаются необработанные данные в формате Types/entity:adapter.Json.

FormattableMixin

cacheModeprotected

Режим кеширования (по умолчанию - только объекты)

class Types/entity:Model

Примечание

Опции

Поля

Методы

События

Тайпдефы

FAQ