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

Позволяет работать в режиме OnScreen вне объекта «Publishing Container».

Параметры:

Название	Описание
Value	Текст, который должен быть отредактирован.
ItemID	Идентификатор статьи.
FieldName	Имя поля.

Метод OnScreen

Внимание: режим OnScreen существует только в предыдущих версиях продукта.

public string OnScreen(string Value, int ItemID)

Аналогичен методу OnScreenFlyEdit. Отличие – при использовании метода Разработчик может изменить статью только с переходом в свойства статьи, а не непосредственно в режиме OnScreen.

Методы для работы с виртуальными путями

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

Метод GetSiteUrl

public string GetSiteUrl()

Возвращает URL корневой директории страниц сайта.

Внимание: результат зависит от того, в каком режиме была собрана страница (Live или Stage).

Примечание: реализован с помощью метода GetSiteUrl класса DBConnector.

Метод GetActualSiteUrl

public string GetActualSiteUrl()

Возвращает URI корневой директории страниц сайта.

Внимание: результат зависит от того, в каком режиме была собрана страница.

Примечание: реализован с помощью метода GetActualSiteUrl класса DBConnector.

Метод GetContentUploadUrl

public string GetContentUploadUrl(string content_name)

Возвращает URI Библиотеки контента для указанного контента.

Примечание: поддерживается имя контента в формате SiteName. ContentName.

Примечание: реализован с помощью метода GetContentUploadUrl класса DBConnector.

Метод GetFieldUploadUrl

public string GetFieldUploadUrl(string contentName, string fieldName)

Возвращает URL корневой директории поля.

Учитывает настройки «Использовать библиотеку сайта» (Use Site Library) и «Подпапка для файлов» (File Subfolder) уровня поля, а также директории для динамических изображений.

Примечание: поддерживается имя контента в формате SiteName. ContentName.

Примечание: реализован с помощью метода GetUrlForFileAttribute класса DBConnector.

При использовании внутри объекта «Publishing Container» рекомендуется использовать версию метода из класса QPublishControl, в которой контент уже определён.

Методы для работы с контентами

Метод GetContentID

public int GetContentID(string content_name)

Возвращает идентификатор указанного контента.

Примечание: поддерживается имя контента в формате SiteName. ContentName.

Примечание: реализован с помощью метода GetContentId класса DBConnector.

Метод GetContentData

public DataTable GetContentData(string siteName, string contentName, string whereExpression, string orderExpression, long startRow, long pageSize, ref long totalRecords, byte useSchedule, string statusName, byte showSplittedArticle, byte includeArchive)

Возвращает данные статьи.

Примечание: реализован с помощью метода GetContentData класса DBConnector. Логика работы и назначение параметров совпадают.

Метод GetContentItemLinkIDs

public string GetContentItemLinkIDs(string linkFieldName, long itemID)
public string GetContentItemLinkIDs(string linkFieldName, string itemID)

В первом варианте использования возвращает значения указанного названия поля M2M (параметр linkFieldName) для указанного идентификатора статьи (параметр itemID) в виде списка идентификаторов связанных статей, разделённых запятыми.

Во втором варианте использования в качестве параметра itemID может быть передан список идентификаторов статей, разделённых запятыми.

Примечание: реализован с помощью метода GetContentItemLinkIDs класса DBConnector.

Пример:

GetContentItemLinkIDs("Authors", Field(Data. Rows[e. Item. ItemIndex], "content_item_id"));

Метод GetContentItemLinkQuery

public string GetContentItemLinkQuery(string linkFieldName, string itemID)

Аналог метода GetContentItemLinkIDs. В данном случае запрос не выполняется, а возвращается в виде текста.

Примечание: реализован с помощью метода GetContentItemLinkQuery класса DBConnector.

Методы для обработки форм

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

Метод AddFormToContent

Метод используется для создания новой статьи:

public int AddFormToContent(string content_name, string status_name)

и изменения существующей:

public int AddFormToContent(string content_name, string status_name, int content_item_id)

Возвращает идентификатор статьи. Также этот ID записывается в коллекцию Values c ключом new_content_item_id.

Метод поддерживает отправку уведомлений. Если такое поведение нежелательно, то следует использовать метод AddFormToContentWithoutNotification.

В методе производятся следующие проверки на сохраняемые поля:

тип поля («Числовой», «Дата»), обязательность, уникальность, допустимая длина и маска ввода (для поля типа «Строка»).

Дополнительно:

при обновлении статьи создается её версия, вся работа с БД происходит в одной транзакции.

Параметры:

Название	Описание
content_name	Имя контента. Примечание: поддерживается динамическое изменение контента.
status_name	Имя статуса Workflow.
content_item_id	Идентификатор изменяемой статьи.

Перед вызовом метода значения полей статьи должны находиться в коллекции Values. Данные могут попасть в коллекцию:

автоматически при отправке на сервер HTML-формы (имена полей формы должны формироваться с помощью метода FieldName), вручную с помощью метода AddValue (ключи также должны быть созданы с помощью FieldName).

Примечание: если в форме есть поля типа «Файл» (имена полей должны быть сформированы с помощью метода FieldName), то полученные файлы будут сохранены в Библиотеку контента. Если файл с таким именем уже существует, то файл будет сохранен под изменённым именем с числовым индексом (например, image[1].jpg). Также, при необходимости, будут сгенерированы значения для полей «Динамическое изображение».

Примечание: Поддерживается режим расщепления статей, включая поля «Связь» типов M2M и M2O. Значения таких полей должны представлять собой строку идентификаторов связанных статей, разделенных запятыми.

Примечание: реализован с помощью метода AddFormToContent класса DBConnector.

Пример:

AddValue(FieldName("Users", "Login"), Login);
AddValue(FieldName("Users", "Password"), Password);
AddFormToContent("Users",  "Published");

Метод AddFormToContentWithoutNotification

public int AddFormToContentWithoutNotification(string content_name, string status_name)

public int AddFormToContentWithoutNotification(string content_name, string status_name, int content_item_id)

Аналог метода AddFormToContent. Отличие в том, что нет поддержки уведомлений.

Метод UpdateContentItem

public void UpdateContentItem()

Метод аналогичен методу AddFormToContent для изменения существующей статьи. В данном случае идентификатор статьи передаётся через коллекцию Values (ключ content_item_id). Имя контента вычисляется по идентификатору статьи.

Метод поддерживает отправку уведомлений. Если такое поведение нежелательно, то следует использовать метод UpdateContentItemWithoutNotification.

Если в коллекции Values будут присутствовать не все поля, то значения обнулятся. В случае, если это нежелательно, то необходимо использовать перегруженную версию метода:

public void UpdateContentItem(bool updateEmpty, string statusName)

Параметры:

Название	Описание
statusName	Статус Workflow для статьи. Примечание: если статус менять не нужно, то следует передать пустую строку.
updateEmpty	При updateEmpty = false позволяет изменить данные только в требуемых полях статьи. Примечание: данный вариант предпочтительнее, чем несколько вызовов UpdateContentItemField.

Примечание: реализован с помощью метода UpdateContentItem класса DBConnector.

Пример:

AddValue("content_item_id", 12345);
AddValue(FieldName("Users", "Login"), Login);
AddValue(FieldName("Users", "Password"), Password);
UpdateContentItem();

Метод UpdateContentItemWithoutNotification

public void UpdateContentItemWithoutNotification()

Аналог метода UpdateContentItem. Отличие в том, что нет поддержки уведомлений.

Метод UpdateContentItemField

public void UpdateContentItemField(string content_name, string field_name, int content_item_id)

Метод аналогичен методу AddFormToContent для изменения существующей статьи. Отличие в том, что метод предназначен для обновления только одного поля статьи.

Примечание: если необходимо обновление сразу нескольких определённых полей, то следует использовать метод UpdateContentItem с UpdateEmpty = false.

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

public void UpdateContentItemField(string content_name, string field_name, int content_item_id, bool with_notification)

Пример:

AddValue(FieldName("Users", "Login"), "newLogin");
UpdateContentItemField("Users", "Login", Value("cid"));

Примечание: реализован с помощью метода UpdateContentItemField класса DBConnector.

Метод AddUpdateContentItemLink

public int AddUpdateContentItemLink(string LinkFieldName, int ItemID, string LinkItems, string TargetLinkItems)

Добавляет или изменяет указанное поле “Связь” типа M2M (параметр LinkFieldName) для указанной статьи (параметр ItemID). Значение поля передается в параметре LinkItems, представляет собой строку идентификаторов связанных статей, разделённых запятыми. Параметр TargetLinkItems позволяет ограничить набор изменяемых статей (формат значения идентичен формату LinkItems).