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

Примечание: для создания копии статьи в текущем контенте достаточно:

прочитать статью методом Read, для Id задать значение 0, сохранить статью методом Save.

Свойство Visible

public bool Visible { get; set; }

Флаг видимости статьи. Значение по умолчанию – true.

Свойство Archive

public bool Archive { get; set; }

Флаг, определяющий, находится ли статья в архиве. Значение по умолчанию – false.

Свойство DelayedSchedule

public bool DelayedSchedule { get; set; }

Флаг отложенной публикации. По умолчанию – false.

Свойство LastModifiedBy

public int LastModifiedBy { get; set; }

Идентификатор пользователя, последним изменявшим статью. Значение по умолчанию – 1.

Примечание: для интеграции с пользовательскими действиями следует использовать метод LoadLastModifiedFromCustomTab.

Свойство StatusName

public string StatusName { get; set; }

Имя статуса. Значение по умолчанию зависит от использования Workflow:

если не используется, то Published, если используется, то None.

Свойство ContentId

public int ContentId { get; set; }

Идентификатор контента.

Примечание: при изменении статья будет перемещена.

Свойство Created

public DateTime Created { get; internal set; }

Дата создания статьи.

Свойство Modified

public DateTime Modified { get; internal set; }

Дата последнего изменения статьи.

Свойство Splitted

public bool Splitted { get; internal set; }

Флаг расщепления статьи. Значение меняется при изменении статуса.

Методы

Метод New

public static ContentItem New(int contentId, DBConnector cnn)

Создаёт новую статью в контенте с указанным идентификатором.

Примечание: если контент отсутствует, то выводится исключение.

Метод Read

public static ContentItem Read(int id, DBConnector cnn)

Получает данные существующей статьи с указанным идентификатором статьи.

Примечание: если статья отсутствует, то выводится исключение.

Метод Remove

public static void Remove(int id, DBConnector cnn)

Удаляет статью с указанным идентификатором статьи.

Примечание: нет реакции на событие, когда статья отсутствует.

Метод Save

public void Save()

Сохраняет статью после создания или изменения.

Примечание: в ходе работы:

вызывает метод AddFormToContent класса DBConnector, формирует уведомление.

Метод LoadLastModifiedFromCustomTab

public void LoadLastModifiedFromCustomTab()

Загружает свойство LastModifiedBy из сессионной переменной, которая устанавливается при аутентификации пользователя в пользовательской вкладке методом CheckCustomTabAuthentication. Если загрузка не выполнена, то значение свойства не меняется.

Пример:

ContentItem item = ContentItem. New(284, cnn);
item. FieldValues["Title"].Data = "Test";
item. FieldValues["Date"].Data = DateTime. Today. ToString();
item. FieldValues["Category"].LinkedItems. Add(1660);
item. LoadLastModifiedFromCustomTab();
item. Save();

Классы из пространства имён «Quantumart. QP8.BLL. Services. API»

Класс ContentService

Конструктор:

public ContentService(string connectionString, int userId)

Параметры:

Название	Описание
connectionString	Строка подключения.
userId	Идентификатор пользователя, от имени которого должны выполняться действия.

public Content Read(int id)

Выполняет чтение существующего контента.

public Content Save(Content content)

Выполняет сохранение нового или существующего контента.

public void Delete(int contentId)

Выполняет удаление существующего контента.

Класс FieldService

Конструктор:

public FieldService(string connectionString, int userId)

Параметры идентичны параметрам класса ContentService.

public Field Read(int id)

Выполняет чтение существующего поля.

public IEnumerable<Field> List(int contentId)

Получает список полей для контента.

public Field Save(Field field, bool explicitOrder)

Выполняет сохранение нового или существующего поля.

Параметр explicitOrder определяет, учитывается ли при сохранении значение поля Order. При значении false поле будет помещено на последнее место в контенте.

public void Delete(int id)

Удаляет существующее поле.

public IEnumerable<Field> ListRelated(int contentId)

Возвращает список полей «Связь», ссылающихся на текущий контент (типы O2M, M2M, M2O).

Пример использования для программного создания полей

FieldService service = new FieldService(connectionString, userId);

var fields = service. List(contentId);

var order = fields. Single(n => n. Name == "RegionValue1766").Order;

Field veField = fields. Single(n => n. Name == "RegionValue1822");

veField. Id = 0;

veField. Name = "RegionValue20000";

veField. FriendlyName = "Значение для тестового региона";

veField. Order = order;

service. Save(veField, true);

Класс ArticleService

Конструктор:

public ArticleService(string connectionString, int userId)

Параметры идентичны параметрам класса ContentService.

public void LoadStructureCache()

Загружает кэш структуры данных (контенты, поля, статусы, пользователи).

Загружается в QPContext.

Рекомендуется использовать для ускорения получения списков и элементов по идентификатору для других методов API.

Есть возможность кэшировать структуру во внешнем контексте:

public void LoadStructureCache(IContextStorage st)

Есть возможность сбросить данные, кэшируемые во внешнем контексте:

public void LoadStructureCache(IContextStorage st, bool resetExternal)

public static bool IsLive

Свойство, влияющее на получение списков статей. Определяет, какие версии статей мы хотим получать: опубликованные или нет.

Хранит данные в QPContext.

public Article New(int contentId)

Создаёт новую статью в указанном контенте для последующего сохранения.

В статье заполнены только значения по умолчанию.

public Article Read(int id, bool forceLoadFieldValues = false)

Выполняет чтение указанной статьи.

Установка флага forceLoadFieldValues принудительно загружает коллекцию FieldValues и агрегированные статьи. По умолчанию используется шаблон «ленивая загрузка».

public IEnumerable<Article> List(int contentId, int[] ids)

Возвращает список статей контента.

Можно ограничить набор статей путём указания списка их идентификаторов в параметре ids. Если передать null, то возвращаются все статьи контента.

public string GetRelatedItems(int fieldId, int? id)

Возвращает список идентификаторов связанных статей (в виде строки через запятую) для поля «Связь» типа M2O.

Идентификатор поля передаётся в параметре fieldID.

public string GetLinkedItems(int linkId, int id)

Возвращает список идентификаторов связанных статей (в виде строки через запятую) для поля «Связь» типа M2M.

Идентификатор связи (не поля) передается в параметре linkId.

public Dictionary<int, string> GetRelatedItemsMultiple(int fieldId, IEnumerable<int> ids)

Возвращает коллекцию списков идентификаторов связанных статей (в виде строки через запятую) для поля «Связь» типа M2O по списку идентификаторов статей.

Идентификатор поля передается в параметре fieldID.

public Dictionary<int, string> GetLinkedItemsMultiple(int linkId, IEnumerable<int> ids)

Возвращает коллекцию списков идентификаторов связанных статей (в виде строки через запятую) для поля «Связь» типа M2М по списку идентификаторов статей.

Идентификатор связи (не поля) передается в параметре linkId.

public Article CopyAndRead(Article article)

Копирует указанную статью и возвращает статью-результат.

public CopyResult Copy(Article article)

Копирует указанную статью и возвращает результат копирования.

public Article Save(Article article)

Сохраняет или изменяет указанную статью (в зависимости от её идентификатора).

public MessageResult Delete(int articleId)

Удаляет статью по указанному идентификатору.

При удалении производится проверка прав, отправка уведомлений и т. д.

public MessageResult Delete(int contentId, int[] articleIds)

Удаляет статьи указанного контента по списку идентификаторов.

При удалении производится проверка прав, отправка уведомлений и т. д.

public void SimpleDelete(int[] articleIds)

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

public MessageResult SetArchiveFlag(int contentId, int[] articleIds, bool flag)

Добавляет в Архив статей или восстанавливает из Архива статей (в зависимости от параметра flag) статьи указанного контента по списку идентификаторов.

При восстановлении производится проверка прав, отправка уведомлений и т. д.

public void SimpleSetArchiveFlag(int[] articleIds, bool flag)

Добавляет в Архив статей или восстанавливает из Архива статей (в зависимости от параметра flag) по списку идентификаторов без выполнения дополнительных действий.

public MessageResult Publish(int contentId, int[] articleIds)

Публикует статьи указанного контента по списку идентификаторов.

При публикации производится проверка прав, отправка уведомлений, и т. д.

public void SimplePublish(int[] articleIds)

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

public string[] GetFieldValues(int[] ids, int contentId, int fieldId)

Получает данные из указанного контента с ограничением по списку идентификаторов статей и идентификатора поля.

public string[] GetFieldValues(int[] ids, int contentId, string fieldName)

Получает данные из указанного контента с ограничением по списку идентификаторов статей и имени поля.

Класс CustomActionService

Конструктор:

public CustomActionService(string connectionString, int userId)

Параметры идентичны параметрам класса ContentService.

public CustomAction ReadByCode(string code)

Выполняет чтение пользовательского действия по коду.