Spec-Zone.ru › Wagtail 3

Модель справки

wagtail.models разделен на подмодули для удобства поддержки. Все определения, предназначенные для публичного доступа, должны импортироваться сюда (с комментариями «noqa», если необходимо), а внешний код должен продолжать импортировать их из wagtail.models (например, from wagtail.models import Site, а не from wagtail.models.sites import Site.)

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

Этот документ содержит справочную информацию по классам моделей внутри модуля wagtailcore.

Page

Поля базы данных

Методы и свойства

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

Примечание

См. также django-treebeard’s API узлов. Page является подклассом дерева пути с материализованным путем узлов.

Site

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

Функция find_for_request() возвращает объект Site, который будет обрабатывать данный HTTP-запрос.

Поля базы данных

Методы и свойства

Язык

Модель Locale определяет набор языков и/или локалей, которые могут использоваться на сайте. Каждый Locale соответствует «коду языка», определенному в настройке WAGTAIL_CONTENT_LANGUAGES.

Wagtail первоначально создаст один Locale в качестве языка по умолчанию для всего существующего контента. Эта первая локаль автоматически выбирает значение из WAGTAIL_CONTENT_LANGUAGES, которое наиболее точно соответствует коду языка сайта, определенному в LANGUAGE_CODE. Если код основного языка позже изменится, Wagtail не будет автоматически создавать новую запись Locale или обновлять существующую.

До включения интернационализации все страницы используют запись основного Locale. Это необходимо для удовлетворения ограничений базы данных и упрощает включение интернационализации в будущем.

Изменение WAGTAIL_CONTENT_LANGUAGES

Языки могут добавляться или удаляться из WAGTAIL_CONTENT_LANGUAGES со временем.

Перед удалением варианта из WAGTAIL_CONTENT_LANGUAGES, важно, чтобы запись Locale была обновлена для использования другого языка контента или была удалена. Любые экземпляры Locale, у которых неверные языки контента, автоматически отфильтровываются из всех запросов к базе данных, что делает их недоступными для редактирования или просмотра.

Методы и свойства

Mixin «Переводимый»

TranslatableMixin — это абстрактная модель, которую можно добавить к любой нестраничной модели Django, чтобы сделать ее переводимой. Страницы уже включают этот миксин, поэтому добавлять его не нужно.

Методы и свойства

Поля locale и translation_key имеют уникальное ограничение ключа, чтобы предотвратить перевод объекта на один и тот же язык более одного раза.

PageRevision

Каждый раз, когда страница редактируется, в базе данных создается и сохраняется новая PageRevision. Она может использоваться для поиска полной истории всех внесенных изменений на странице, а также предоставляет место для хранения новых изменений до их опубликования.

  • Ревизии могут быть созданы из любого объекта Page с помощью его метода save_revision()
  • Содержимое страницы сериализуется в формате JSON и хранится в поле content
  • Вы можете получить PageRevision как объект Page с помощью метода as_page_object()

Поля базы данных

Менеджеры

Методы и свойства

GroupPagePermission

Поля базы данных

PageViewRestriction

Поля базы данных

Orderable (абстрактный)

Поля базы данных

Workflow

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

Поля базы данных

Методы и свойства

WorkflowState

Состояния потоков работ представляют состояние запущенного потока работ на странице.

Поля базы данных

Методы и свойства

Task

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

Поля базы данных

Методы и свойства

TaskState

Состояния задач хранят информацию о состоянии выполнения задачи на определенной ревизии страницы.

Поля базы данных

Методы и свойства

WorkflowTask

Представляет порядок задачи в определенном потоке работ.

Поля базы данных

WorkflowPage

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

Поля базы данных

BaseLogEntry

Абстрактный базовый класс, представляющий запись о выполненном действии с объектом.

Поля базы данных

Методы и свойства

PageLogEntry

Представляет запись о выполненном действии со страницей Page, подклассы BaseLogEntry.

Поля базы данных

Comment

Представляет комментарий к странице.

Поля базы данных

CommentReply

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

Поля базы данных

PageSubscription

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

Поля базы данных

© 2014-present Torchbox Ltd and individual contributors.
All rights are reserved.
Licensed under the BSD License.
https://docs.wagtail.org/en/v3.0.3/reference/pages/model_reference.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API