Сущности

Добро пожаловать в документацию по сущностям Certis Platform — легковесной, но мощной системе, построенной на архитектуре расширяемых сущностей.

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

Обзор архитектуры

Certis Platform использует объектно-ориентированный подход, в котором все данные представлены в виде сущностей — экземпляров классов, унаследованных от базового класса Entity. Каждая сущность представляет собой логическую единицу информации, такую как пользователь, группа, настройка или кастомный объект, и обладает набором полей, методов и прав доступа.

Центральным элементом архитектуры является класс Entity, который определяет единый интерфейс для всех сущностей системы. Он обеспечивает базовые операции: инициализацию, чтение и запись полей, сохранение, удаление, а также интеграцию с системой контроля доступа. Все конкретные сущности (например, CrmUser, CrmGroup) наследуются от Entity, расширяя его функциональность под свои нужды.

Цель документации

Целью этой документации является:

• Дать четкое понимание структуры и поведения каждой сущности;
• Объяснить, как сущности взаимодействуют между собой через связи и права доступа;
• Предоставить примеры использования для разработчиков и администраторов;
• Служить справочным руководством при разработке модулей, интеграций и кастомизации системы.

Каждая сущность описана в отдельном файле в каталоге docs/models, где вы найдёте:

• Описание назначения и роли в системе;
• Список полей и их типов;
• Доступные методы и примеры их использования;
• Информацию о связях с другими сущностями;
• Рекомендации по безопасному и эффективному использованию.

Как читать эту документацию

Мы рекомендуем начать с изучения базовой сущности Entity, так как её понимание критически важно для работы с любой другой сущностью. После этого вы можете ознакомиться с:

• EntityTypes — как регистрируются и управляются типы сущностей;
• EntityTable — как создавать, читать, обновлять и удалять сущности;
• CrmUser и CrmGroup — ключевые сущности управления пользователями и правами;
• CrmPermissions и CrmDirectPermissions — как реализована система контроля доступа.

Для разработчиков, планирующих создавать свои сущности, особое внимание стоит уделить механизму регистрации типов и наследованию от Entity.

Дальнейшие шаги

После прочтения введения мы приглашаем вас перейти к изучению описания конкретных сущностей в каталоге docs/models. Если вы интересуетесь API системы, обратитесь к документу endpoints.md. Для настройки и установки системы используйте installation.md.

Certis Platform спроектирована так, чтобы быть гибкой, безопасной и простой в расширении. Мы надеемся, что эта документация поможет вам быстро освоиться и эффективно использовать все возможности системы.

Приятного чтения!