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

Аналогичен методу AddFormToContent в режиме изменения существующей статьи.

Метод UpdateContentItemField

public void UpdateContentItemField(int site_id, string content_name, string field_name, int content_item_id, ref Hashtable Values, ref HttpFileCollection Files)
public void UpdateContentItemField(int site_id, string content_name, string field_name, int content_item_id, ref Hashtable Values)

Аналогичен методу AddFormToContent в режиме изменения одного поля (параметр field_name).

Метод DeleteContentItem

public void DeleteContentItem(int content_item_id)

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

Примечание: метод не поддерживает отправку уведомлений. Необходимо использовать метод SendNotification или использовать класс ContentItem.

Методы для массового создания и изменения статей

Метод MassUpdate

Массово создаёт новые статьи, изменяет существующие.

Примечание: используется при создании и изменении статей с использованием LINQ to SQL и EF. В LINQ to SQL вызывается для каждой статьи, в EF – для группы статей контента.

public void MassUpdate(int contentId, IEnumerable<Dictionary<string, string>> values, int lastModifiedBy)

public void MassUpdate(int contentId, IEnumerable<Dictionary<string, string>> values, int lastModifiedBy, MassUpdateOptions options)

public class MassUpdateOptions

{

public MassUpdateOptions()

{

CreateVersions = true;

ReturnModified = true;

ReplaceUrls = true;

}

public bool CreateVersions { get; set; }

public bool ReturnModified { get; set; }

public bool ReplaceUrls { get; set; }

}

Отличия MassUpdate от ImportToContent:

создаётся версия (опция СreateVersions), возвращается дата модификации статьи (опция ReturnModified), заменяются URL (опция ReplaceUrls), создаются динамические изображения, создаются версии файлов для полей типа «Файл» и «Изображение», выполняется базовая валидация полей.

Метод ImportToContent

public void ImportToContent(int contentId, IEnumerable<Dictionary<string, string>> values, int lastModifiedBy = 1, int[] attrIds = null)

Массово создаёт новые статьи, изменяет существующие.

Примечание: метод можно рассматривать, как облегчённую версию метода MassUpdate.

Примечание: можно использовать для импорта данных в QP.

Параметры:

Название	Описание
contentId	Идентификатор контента, в который осуществляется импорт.
values	Импортируемые в контент данные. Примечание: Каждая коллекция соответствует статье контента. Ключ коллекции – имя поля (поддерживаются как системные, так и пользовательские поля), значение в коллекции – значение соответствующего ключу поля статьи в виде строки.
lastModifiedBy	Идентификатор пользователя, от имени которого выполняется импорт.
attrIds	Ограничитель набора полей, в которых необходимо выполнить изменения. В качестве значения следует передавать массив идентификаторов полей контента.

Внимание: ограничения метода:

не поддерживается поле «Связь» типа M2O, не создаются версии статьи, не генерируются объекты «Динамическое изображение», не формируются уведомления, не фиксируется аудит, не производится валидация форм.

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

Методы для выполнения произвольных SQL-запросов

Метод GetRealData

public DataTable GetRealData(string queryString)

Выводит данные из БД по SQL-запросу queryString в виде DataTable.

Примечание: метод не использует кэш. Если необходимо использовать кэш, то рекомендуется метод GetCachedData.

Метод GetData

public DataTable GetData(string queryString)

Аналогичен методу GetRealData. Отличие в том, что поведение метода зависит от значения параметра CacheGetData конфигурационного файла веб-сайта. При значении 1 метод работает, как GetCachedData c интервалом кэширования по умолчанию, в противном случае – как GetRealData.

Примечание: параметр CacheGetData нужен для быстрого решения проблем с большим количеством SQL-запросов на старых веб-сайтах. При написании нового кода для предсказуемости поведения Системы рекомендуется использовать методы GetCachedData и GetRealData.

Метод ProcessData

public void ProcessData(string queryString)

Формирует к БД UPDATE - и DELETE-запросы queryString.

Методы для работы с файлом отображения

Метод GetMapFileContents

public string GetMapFileContents(int site_id, string fileName)

Ищет MAP-файл и выводит его содержимое в виде строки.

Примечание: результат кэшируется до первого изменения с помощью метода GetCachedFileContents.

Параметры:

Название	Описание
site_id	Задаёт сайт в рамках текущей БД. Для сайта определяется путь к директории App_Data. Примечание: для определения требуемого режима работы веб-сайта (Live или Stage) проверяется свойство IsStage.
fileName	Определяет имя MAP-файла. Файл ищется в директории App_Data сайта.

Метод GetDefaultMapFileContents

Внимание: метод доступен в NuGet-пакете Quantumart версии 2.1.0 и выше (см. Установка пакетов NuGet для QP).

public string GetDefaultMapFileContents(int site_id)

public string GetDefaultMapFileContents(int siteId, string contextName)

Метод аналогичен методу GetMapFileContents. Позволяет получать MAP-файл программно при наличии Connection String, Id сайта и имени контекстного класса (без учёта регистра).

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

Пример использования:

var dbc = new DBConnector(Global. ConnectionString);

var map1 = dbc. GetDefaultMapFileContents(Global. SiteId, "qpcontext");

dbc. IsStage = true;

var map2 = dbc. GetDefaultMapFileContents(Global. SiteId, "qpcontext");

По умолчанию в директории App_Data сайта ищется уже сгенерированный MAP-файл (для обратной совместимости). Если файл не найден, то выполняется программная генерация MAP-файла (без создания промежуточных файлов на диске). Результат возвращается в виде строки.

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

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

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

Метод GetImagesUploadUrl

public string GetImagesUploadUrl(int site_id)
public string GetImagesUploadUrl(int site_id, bool asShortAsPossible)

Возвращает URI Библиотеки сайта.

Параметры:

Название	Описание
site_id	Идентификатор сайта
asShortAsPossible	Указатель, требуется ли вернуть результат в виде URL. Значение по умолчанию – false. Примечание: если для сайта активировано свойство «Использовать абсолютный виртуальный путь», то к результату добавляется значение свойства «Префикс виртуального пути».

Метод GetSiteLibraryDirectory

public string GetSiteLibraryDirectory(int site_id)

Возвращает физический путь к Библиотеке сайта.

Метод GetActualSiteUrl

public string GetActualSiteUrl(int site_id)

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

Примечание: учитывается режим работы сайта.

Метод GetSiteUrl

public string GetSiteUrl(int site_id, bool isLive)

Возвращает URL корневой директории страниц сайта. Значение параметра isLive определяет требуемый режим работы сайта.

Метод GetSiteUrlRel

public string GetSiteUrlRel(int site_id, bool isLive)

Возвращает URI корневой директории страниц сайта. Значение параметра isLive определяет требуемый режим работы сайта.

Метод GetSiteDirectory

public string GetSiteDirectory(int site_id, bool isLive)

Возвращает физический путь корневой директории страниц сайта. Значение параметра isLive определяет требуемый режим работы сайта.

Метод GetContentUploadUrl

public string GetContentUploadUrl(int site_id, string content_name)

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

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

Метод GetContentLibraryDirectory

public string GetContentLibraryDirectory(int site_id, int content_id)

Возвращает физический путь к Библиотеке контента для указанного контента.

Метод GetDirectoryForFileAttribute

public string GetDirectoryForFileAttribute(int attrId)

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

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

Метод GetUrlForFileAttribute

public string GetUrlForFileAttribute(int fieldId)
public string GetUrlForFileAttribute(int fieldId, bool asShortAsPossible)

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

Параметры:

Название	Описание
fieldId	Идентификатор поля.
asShortAsPossible	Указатель, требуется ли вернуть результат в виде URL. Значение по умолчанию – true. Примечание: если для сайта активировано свойство «Использовать абсолютный виртуальный путь» к результату добавляется значение свойства «Префикс виртуального пути».

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