Программный продукт «QP8.Framework» (стр. 21 )

Название	Описание
Использование Виджетной платформы	Рекомендуемое решение (см. Использование Виджетной платформы)
Использование исключительно объектов QP (объекты ветви «Шаблон»)	Подход устарел, не рекомендуется для разработки новых Систем (см. Использование объектов QP)
Использование собственной архитектуры	-

Способы разработки кода:

Название	Описание
QP8 API	Нетипизированный доступ к данным (см. QP8 API)
Классы LINQ to SQL	Типизированный доступ к данным (см. Классы LINQ to SQL)
Entity Framework	См. Использование Entity Framework

Существует механизм JS-интеграции для организации двустороннего взаимодействия бекэнда и веб-приложения для пользовательского действия (см. JS-интеграция для веб-приложений пользовательских действий).

Установка NuGet-пакетов

Для работы с NuGet-пакетами используется репозиторий, который доступен по адресу http://nuget. dev. qsupport. ru/nuget.

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

Для установки с помощью библиотеки, необходимо:

Вызвать в Solution Explorer контекстное меню для пункта References; Выбрать пункт Manage NuGet Packages for Solution.  В настройках библиотеки пакетов задать адрес репозитория. В открывшейся вкладке отобразятся доступные пакеты. Для того чтобы установить пакет, необходимо нажать на кнопку Install. Описание пакета выводится в поле Description, зависимости в поле Dependencies.

Для установки с помощью командной строки менеджера пакетов, необходимо:

Вызвать консоль Package Manager Console; В выпадающем списке Default project выбрать проект, в который требуется добавить пакет; Установить пакет с помощью команды Install-Package: Install-Package <имя пакета>;

Пакеты, описанные в руководстве:

QA. Validation. Xaml. Extensions (см. Порядок разработки валидатора); Quantumart. QP8.BLL (см. Классы из пространства имён «Quantumart. QP8.BLL. Services. API»); Quantumart (см. QP8 API (кроме подраздела «Классы из пространства имён „Quantumart. QP8.BLL. Services. API“»), Классы LINQ to SQL, Использование Entity Framework); QP8.EntityFramework6 (см. Использование Entity Framework); QP8BackendApi. Interaction (см. JS-интеграция для веб-приложений пользовательских действий); QA. Core. Engine (см. Процедура создания и добавления нового типа страницы в Систему, Процедура создания и добавления нового типа виджета в Систему Разработка кода веб-приложенияПроцедура создания и добавления нового типа страницы в Систему); Использование Виджетной платформы Архитектура платформы

В продукте используются понятия «Страница» и «Виджет».

Под страницей понимается объект, который требуется использовать для работы с данными на странице веб-сайта. Экземпляр страницы обладает URL.

Виджет предназначен для использования на различных страницах веб-сайта в качестве одной из её составляющих. Экземпляр виджета не обладает URL.

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

Название	Описание
Контент «ItemDefinition»	Данные о типах элементов (страницы веб-сайта, виджеты). Контент содержит базовые поля, общие для всех типов виджетов и страниц веб-сайта.
Группа контентов «Pages and widgets»	Контенты-расширения для страниц и виджетов. Контент-расширение содержит поля, уникальные для типа страницы или виджета (отсутствующие в контенте «ItemDefinition»).
Контент «AbstractItem»	Данные обо всех экземплярах страниц и виджетов, созданных в Системе

Структура контентов

Поля контента «ItemDefinition»

Название	Тип	Описание
Title	String	Название страницы или виджета
Name	String	Идентификатор страницы или виджета
PreferredContentId	Numeric	Идентификатор контента-расширения
FriendlyDescription	String	Уникальное описание страницы или виджета. Примечание: в качестве значения допускаются только латиница и цифры.
CategoryName	String	Название категории виджета. Используется для группировки виджетов при выводе их в ГПИ виджетной платформы.
Description	String	Описание страницы или виджета
IconUrl	Image	Файл с пиктограммой для виджета. Примечание: используется в ГПИ виджетной платформы.
IsPage	Boolean	Указатель, что статья содержит данные о странице, а не виджете

Поля контента «AbstractItem»

Название	Тип	Описание
Title	String	Имя элемента
Name	String	URI для страницы. Примечание: используется только для страниц. Примечание: применяется в URL страницы.
Parent	One-to-Many Relation	Родительский элемент
IsVisible	Boolean	Флаг доступности для отображения
IsPage	Boolean	Флаг, является ли данный элемент страницей
Regions	Many-to-Many Relation	Регионы, для которых отображается данный элемент
ZoneName	String	Имя зоны, в которой находится виджет. Примечание: используется только для виджетов.
Description	String	Описание
Discriminator	One-to-Many Relation	Тип страницы или виджета
VersionOf	One-to-Many Relation	Оригинальная страница (страница, для которой создается версия)
Culture	One-to-Many Relation	Языковая культура
ExtensionId	Numeric	Идентификатор контента присоединённой статьи

Создание экземпляра страницы

Для управления страницами продукт содержит пользовательское действие «Manage Pages».

Пользовательское действие «Manage Pages» содержит ГПИ, в котором Разработчику доступны следующие возможности:

управление (CRUD) структурой страниц, получение данных по интересующей странице.

Рисунок 9. ГПИ пользовательского действия «Manage Pages».

Структура страниц представлена в виде дерева статей из контента «AbstractItem». Для добавления новой страницы требуется:

выбрать в дереве статей страницу, которая должна стать родительской страницей для новой страницы; нажать «Добавить подраздел».

После этого Разработчику потребуется указать основные данные для экземпляра страницы:

Название	Описание
Заголовок	Значение поля «Title»
Название	Значение поля «Name»
Тип страницы	Выбор типа страницы из списка существующих. Значение поля «Discriminator».

Затем c помощью формы создания статьи Разработчику предлагается завершить создание статьи в контенте «AbstractItem» с заполнением прочих полей данными, которые должен использовать экземпляр.

Примечание: в форме создания статьи часть полей автоматически заполняется данными, заданными Разработчиком изначально.

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

(добавить что-то ещё?)

В случае, когда существующие в Системе типы страницы не подходят для решения существующей задачи, требуется создать новый тип страницы.

Процедура создания и добавления нового типа страницы в Систему В бекэнде в контенте «ItemDefinition» создать новый элемент для типа страницы. При необходимости использования на страницах данного типа дополнительных полей создать в бекэнде контент-расширение. В контенте создать все необходимые дополнительные поля для использования на странице. Затем необходимо указать идентификатор нового контента в созданной ранее статье в контенте «ItemDefinition». В бекэнде выполнить генерацию классов LINQ to SQL. В случае использования Visual Studio скопировать созданные файлы в проект в Visual Studio.

Примечание: для генерации классов используется шаблон ItemDefinitions. tt (содержится в дистрибутиве продукта в исходном проекте).

Создать модель для страницы.

В атрибутах класса следует указать PageDefinitionAttribute. Пример:

[PageDefinition("Страница новостей", Discriminator = ItemDefinitions. NewsPageExtension)]

Класс требуется наследовать от AbstractPage.

Создать контроллер.

У класса контроллера следует указать ControlsAttribute. Пример:

[Controls(typeof(NewsPage))].

Класс контроллера требуется наследовать от ContentControllerBase<T>, где T – класс страницы.

Создать представление.

Внимание: для использования на странице ГПИ Виджетной платформы в разметку страницы следует добавить код для вызова ГПИ.

Создание экземпляра виджета

Для создания экземпляра виджета рекомендуется использовать пользовательское действие «Manage widgets».