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

Название	Описание
backend_sid	Используется для аутентификации.
Параметр контекста	Зависит от типа сущности, указанного в свойствах пользовательского действия. Имя параметра определяется полем CONTEXT_NAME в таблице ENTITY_TYPE. Примеры: site_id – для сайта; content_id – для контента; attribute_id – для поля; content_item_id – для статьи; user_id – для пользователя; usergroup_id – для группы пользователей.
customer_code	Значение Customer Code.

Неинтерфейсное пользовательское действие

Неинтерфейсное пользовательское действие позволяет выполнить какую-либо операцию без вызова ГПИ. Например, можно реализовать, пользовательскую групповую операцию над выбранными статьями – вместо открытия некоторого ГПИ выполняется AJAX-запрос методом POST к заданному URL. В качестве данных должны возвращаться:

Результат	Описание результата
Успех	null
Ошибка	{Type: “Error”, Text: “Текст сообщения об ошибке”}

Вызов неинтерфейсного пользовательского действия осуществляется через проксирование на локальном сервере. Это позволяет получать данные о неуспешном выполнении сразу, а не по истечении таймаута, как в случае JSONP. Таким образом, внешнее неинтерфейсное действие должно возвращать ответ в формате JSON (без JSONP-обёртки).  Кроме того, URL неинтерфейсного действия должен быть доступен на веб-сервере, на котором запущен бекэнд (из-за локального проксирования запроса).

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

Подтверждение на выполнение пользовательского действия

В неинтерфейсных пользовательских действиях используется механизм подтверждений. Он позволяет перед выполнением действия запросить у пользователя подтверждение, действительно ли следует выполнить это действие. Подтверждение может быть безусловным и условным.

Безусловное подтверждение используется при любом выполнении действия. Например, при запросе подтверждения для любого действия удаления в ГПИ бекэнда. В качестве текста подтверждения используется значение свойства «Фраза подтверждения».

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

Условное подтверждение реализовано через механизм PreAction, поддерживается для URL в формате MVC, заканчивающихся символом /. Перед вызовом URL пользовательского действия формируется запрос к URL с суффиксом PreAction. Например, если для неинтерфейсного пользовательского действия задан URL http://Домен/cms/Custom/Import/, то запрос будет сформирован для URL http://Домен/cms/Custom/ImportPreAction/. В качестве данных должны возвращаться:

Результат	Описание результата
Подтверждение не нужно	null
Подтверждение нужно	{Type: “Confirm ”, Text: “Текст сообщения подтверждения”}

Стиль визуального редактора (Visual Editor Style)

Стиль визуального редактора позволяет управлять стилями, доступными к использованию при работе с данными в поле типа “Визуальный редактор”.

Управление стилями визуального редактора осуществляется в разделе «Стили визуального редактора» (Visual Editor Styles).

Добавление стиля возможно с помощью:

ГПИ бэкэнда (список стилей сущности «Стиль визуального редактора» → команда «Добавить новый стиль визуального редактора»); Команды «Создать новый стиль виз. редактора», вызванного для сущности «Стиль визуального редактора».

Контекстное меню, вызванное для определенного стиля, содержит команды:

«Удалить». Команда удаляет стиль визуального редактора после ее подтверждения; «Свойства». Команда открывает вкладку со свойствами стиля.

Свойства стиля визуального редактора

Основные параметры (Basic Parameters)

Название	Описание
Имя (Name)	Имя стиля визуального редактора.
Описание (Description)	Описание стиля.
Формат (Format)	Указатель, что элемент содержит форматирование.
Системный (System)	Указатель, что элемент является системным. Примечание: системные стили доступны только на чтение (создание, изменение, удаление не допускается).
Порядок (Order)	Приоритет вывода элемента в списке элементов. Примечание: используется сортировка по возрастанию значения.

Настройки стиля (Style Settings)

Название	Описание
Тег (Tag)	Тэг, который требуется использовать в визуальном редакторе.
Заменяет тег (Overrides Tag)	Тэг, который требуется заметить при использовании стиля.
HTML - атрибуты (HTML Attributes)	HTML-атрибуты, которые требуется указать в тэге. Для атрибута следует задать параметры: «Имя» (Name), «Значение» (Value).
Стили (Styles)	СSS-стили, которые требуется добавить к тэгу с помощью атрибута style. Для СSS-стиля следует задать параметры: «Имя» (Name), «Значение» (Value).

Плагин визуального редактора (Visual Editor Plugin)

Плагин визуального редактора позволяет добавлять функциональные возможности, доступные к использованию при работе с данными в поле типа «Визуальный редактор».

Управление плагинами визуального редактора осуществляется в разделе «Плагины визуального редактора» (Visual Editor Plugins). Обращение к плагину осуществляется по URL.

Добавление плагина возможно с помощью:

ГПИ бэкэнда (список стилей сущности «Плагин визуального редактора» → команда «Добавить новый плагин визуального редактора»); Команды «Новый плагин визуального редактора», вызванного для сущности «Плагин визуального редактора».

Контекстное меню, вызванное для определенного плагина, содержит команды:

«Удалить». Команда удаляет плагин визуального редактора после ее подтверждения; «Свойства». Команда открывает вкладку со свойствами плагина.

Свойства плагина визуального редактора

Название	Описание
Имя (Name)	Внимание: в качестве значения требуется задавать имя, использованное в коде плагина. Имя плагина визуального редактора.
Описание (Description)	Описание плагина
URL	URL для вызова плагина. В соответствии с требованиями используемого WYSIWYG-редактора «CKEditor» требуется указать URL директории, в которой размещён файл plugin. js. Допускается использование относительного пути до файла (без указания протокола и доменного имени). В этом случае для сайта QP требуется создать виртуальный каталог IIS, через который будет доступен код плагина.
Порядок (Order)	Приоритет вывода элемента в списке элементов. Примечание: используется сортировка по возрастанию значения.
Команды (Commands)	Для команды требуется указать параметры: «Имя» (Name), Внимание: в качестве значения «Имя» требуется задавать имя, использованное в коде плагина. «Алиас» (Alias).

Пользовательская валидация

В базовые возможности QP входят следующие способы валидации данных, вводимых пользователем:

ограничение ввода по типу поля, свойство поля «Обязательное», свойство поля «Уникальное», для поля типа «Строка»: маска ввода, длина значения.

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

Основные принципы

Пользовательская валидация может быть задана на уровне сайта (см. Свойства сайта) или на уровне контента (см. Свойства контента). Используется язык XAML. Валидатор состоит из следующих блоков:

описание полей, ресурсный словарь, условия валидации. Описание синтаксиса

Структура валидатора

<XamlValidator xmlns=http:///validation

  xmlns:x="http://schemas. /winfx/2006/xaml">

<!—Блок описания полей -->

<XamlValidator. Definitions> … </XamlValidator. Definitions>

<ForMember Definition="{x:Definition Name}"> … </ForMember>

<ForMember Definition="{x:Definition DuplicateName}"> … </ForMember>

<Must> … </Must>

</XamlValidator>

Правила

Название	Описание
Must	Создаёт правило валидации для всей модели (уровня ValidationSummary)
ForMember	Создаёт правило валидации для определённого свойства модели. Задаёт контекст для всех правил в дереве условий.

Логические операнды

Операнд «And»

Логическое «И». Внутрь можно помещать любые операнды, ветвления или условия в любом количестве. Пример:

<And>

<IsTrue Source="{x:Definition is_mobile}" />