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

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

При удачном завершении возвращает значение 1, при неудаче возвращает -1.

Пример:

AddUpdateContentItemLink("Books", NumValue("AuthorID"), Value("12345,45678,7890,23415,8907"), "");

Метод RemoveContentItem

public void RemoveContentItem(int content_item_id)

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

Метод поддерживает уведомления.

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

Метод DeleteContentItem

public void DeleteContentItem()

Удаляет статью с идентификатором, который передается через коллекцию Values (ключ content_item_id).

Метод поддерживает уведомления.

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

Вспомогательные методы

Метод FieldName

public string FieldName(string content_name, string field_name)

Возвращает внутреннее имя поля (field_идентификатор поля).

Примечание: обычно используется в HTML-формах для наименования полей совместно с методами AddFormToContent или UpdateContentItem.

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

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

Метод FieldID

public int FieldID(string content_name, string field_name)

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

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

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

Метод ReplaceHTML

public string ReplaceHTML(string str)

Заменяет символы < и > на безопасные XML-сущности &lt; и &gt;.

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

Метод SendNotification

public void SendNotification(string notification_on, int content_item_id, string notification_email)

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

Параметры:

Название	Описание
notification_on	Тип события. Внимание: требуемый тип события должен быть задан в настройках уведомления. Допустимые значения: for_create, for_modify, for_remove, for_status_changed, for_frontend.
content_item_id	Идентификатор статьи.
notification_email	Адрес электронной почты, на который требуется сформировать уведомление. Внимание: указанное значение перекрывает стандартные настройки уведомления. Если это не нужно, то следует передать пустую строку.

Примечание: автоматически вызывается методами:

AddFormToContent, UpdateContentItem, RemoveContentItem.

Пример:

SendNotification("for_remove", 3657, "");

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

Класс QPublishControl

В разделе описаны дополнительные методы и свойства, доступные из кода объекта типа «Publishing Container». Кроме того, в таком объекте остаются доступными все методы и свойства класса QUserControl (например, методы для работы с полями).

Свойства

Свойство Data

public DataTable Data { get; set; }

Таблица результатов запроса, полученных в соответствии с настройками объекта «Publishing Container». По умолчанию генерируется код, привязывающий данную таблицу к объекту типа Repeater, но это не единственно возможный вариант и разработчик может использовать эту таблицу любым способом.

Свойство TotalRecords

public long TotalRecords { get; set; }

Возвращает общее число записей объекта «Publishing Container» с учётом фильтрации и деления на страницы (совпадает с Data. Rows. Count).

Свойство AbsoluteTotalRecords

public long AbsoluteTotalRecords { get; set; }

Возвращает общее число записей объекта «Publishing Container» с учетом фильтрации, но без учёта деления на страницы (т. е. может не совпадать с Data. Rows. Count).

Свойство ContentID

public long ContentID { get; set; }

Возвращает идентификатор текущего контента, к которому привязан объект «Publishing Container».

Свойство ContentName

public string ContentName { get; set; }

Возвращает имя текущего контента, к которому привязан объект «Publishing Container».

Свойство ContentUploadURL

public string ContentUploadURL { get; set; }

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

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

Пример:

<img src="<%#ContentUploadURL%>/<%#Field(CType(Container. DataItem, DataRowView), "Product Picture")%>">

Свойство RecordsPerPage

public long RecordsPerPage { get; set; }

Возвращает общее количество записей на странице в соответствии с настройками объекта «Publishing Container».

Методы

Метод GetFieldUploadUrl

public string GetFieldUploadUrl(string fieldName)

Возвращает путь к корневой директории указанного поля контента, с которым связан объект «Publishing Container».

Примечание: в базовом случае результат совпадает с ContentUploadURL. Отличия возможны в следующих случаях:

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

Классы LINQ to SQL

Использование классов LINQ to SQL упрощает работу с содержимым БД за счёт того, что:

доступ к полям контентов становится типизированным (с поддержкой IntelliSense в Visual Studio); LINQ to SQL предоставляет большое количество встроенных операций для работы с наборами данных. Единицами данных в этих наборах будут являться статьи. становится доступным поддержка декларативного связывания контентов с элементами управления (по DataSourceID) с помощью стандартного класса LinqDataSource; добавляется возможность изменения статей с помощью LINQ-классов. связанные таблицы становятся доступными, как свойства (включая поле «Связь» типа M2M).

Сборка контентов в классы LINQ to SQL

Внимание: процесс сборки с большой долей вероятности приведёт к перезагрузке веб-приложения, поэтому в production-окружении его следует применять с осторожностью.

Сборка контентов в классы LINQ to SQL может быть выполнена следующими способами:

Название	Описание
С использованием БД	Используются настройки LINQ to SQL (задаются в бекэнде в свойствах сайта, контента, поля).
С использованием пользовательского файла отображения	Файл может быть: сгенерирован через бекэнд (по умолчанию), составлен Разработчиком вручную.

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

Сборка выполняется с помощью опции «Собрать контенты» (Assemble Contents) из контекстного меню сайта. При этом в директории App_Code происходит полная перегенерация всех классов LINQ to SQL для сайта.

Опция «Импортировать файл отображения в базу данных» позволяет импортировать существующий пользовательский файл отображения в БД для последующей настройки через бекэнд и генерации файла отображения в автоматическом режиме. При успешном выполнении импорта:

данная опция автоматически отключается, опция «Использовать прямое отображение из базы данных» автоматически включается.

Опция «Импортировать файл отображения в базу данных» также может быть полезна для первичного заполнения настроек LINQ to SQL для существующего сайта с большим количеством контентов. Для этого сначала генерируется пользовательский файл отображения по умолчанию (при отключённой опции «Использовать прямое отображение из базы данных»), а затем выполняется его импорт.

Генерация классов LINQ to SQL и вспомогательных файлов осуществляется в директориях App_Data и App_Code веб-сайта. Их расположение вычисляется по пути директории bin сайта (директории App_Data и App_Code находятся на том же уровне, что и bin).

Настройка отображения с использованием БД

Режим используется при включённой опции «Использовать прямое отображение из базы данных».

Название	Описание
Настройки уровня сайта	Задаются в свойствах сайта (см. раздел Параметры сборки в LINQ-классы (LINQ Assembling Parameters))
Настройки уровня контента	Задаются в свойствах контента (см. раздел Параметры отображения в LINQ-классы (LINQ Mapping Parameters))
Настройки уровня поля	Задаются в свойствах поля (см. раздел Параметры отображения в LINQ-классы (LINQ Mapping Parameters))

Использование пользовательского файла отображения

Общие сведения

Пользовательский файл отображения — это XML-файл, на основании которого осуществляется генерация классов LINQ to SQL. Файл должен иметь имя Mapping. xml и находиться в директории App_Data веб-сайта.

Примечание: генерация классов LINQ to SQL в этом режиме осуществляется только при отключённой опции «Использовать прямое отображение из базы данных» на уровне сайта.

В текущей версии продукта файл Mapping. xml не генерируется автоматически. Вместо этого генерируется пользовательский файл отображения по умолчанию с именем DefaultMapping. xml, на основе которого вручную должен быть составлен файл Mapping. xml. В простейшем случае достаточно переименовать DefaultMapping. xml в Mapping. xml.

Примечание: автоматическая генерация файла Mapping. xml отсутствует из-за возможности случайной генерации классов LINQ to SQL на ненастроенном сайте, что может приводить к его неработоспособности.