Модели страниц

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

Каждый тип страницы Wagtail — это модель Django, представленная в базе данных как отдельная таблица.

У каждого типа страницы может быть свой набор полей. Например, новостная статья может иметь текст тела и дату публикации, в то время как страница события может потребовать отдельных полей для места проведения и времени начала/окончания.

В Wagtail вы можете использовать любой класс поля Django. Большинство классов полей, предоставляемых приложениями сторонних разработчиков, также должны работать.

Wagtail также предоставляет несколько собственных классов полей:

• RichTextField — для форматированного текста
• StreamField — поле контента на основе блоков (см.: Динамический контент страницы с помощью StreamField)

Для тегирования Wagtail полностью поддерживает django-taggit, поэтому мы рекомендуем использовать его.

Поиск

Атрибут search_fields определяет, какие поля добавляются в индекс поиска и как они индексируются.

Это должен быть список SearchField и FilterField объектов. SearchField добавляет поле для полнотекстового поиска. FilterField добавляет поле для фильтрации результатов. Одно поле может быть индексировано как с помощью SearchField, так и с помощью FilterField одновременно (но только по одному экземпляру каждого).

В приведенном выше примере мы проиндексировали body для полнотекстового поиска и date для фильтрации.

Аргументы, которые принимают эти типы полей, описаны в дополнительных полях индексирования.

Панели редактора

Есть несколько атрибутов для определения того, как поля страницы будут организованы в интерфейсе редактора страницы:

• content_panels — для контента, такого как основной текст
• promote_panels — для метаданных, таких как теги, миниатюрное изображение и SEO-заголовок
• settings_panels — для настроек, таких как дата публикации

Каждый из этих атрибутов устанавливается в список Panel объектов, определяющих, какие поля отображаются на каких вкладках и как они структурированы на каждой вкладке.

Вот краткое описание Panel классов, которые Wagtail предоставляет "из коробки". Полные описания см. в Типы панелей.

Основные

Эти классы позволяют редактировать поля модели. Класс FieldPanel выберет правильный виджет на основе типа поля, например, редактор форматированного текста для RichTextField, или выбор изображения для ForeignKey к модели изображения. FieldPanel также предоставляет интерфейс выбора страницы для ForeignKey к моделям страниц, но для более точного управления типами страниц, которые можно выбрать, PageChooserPanel предоставляет дополнительные параметры настройки.

• FieldPanel
• PageChooserPanel

Структурные

Они используются для структурирования полей в интерфейсе.

• MultiFieldPanel
• InlinePanel
• FieldRowPanel

Правила типа родительской страницы / дочерней страницы

Эти два атрибута позволяют управлять тем, где типы страниц могут быть использованы на вашем сайте. Это позволяет задавать правила, например, «записи блога могут создаваться только под индексом блога».

Оба принимают список классов моделей или имен моделей. Имена моделей имеют формат app_label.ModelName. Если app_label опущено, предполагается то же приложение.

• parent_page_types ограничивает типы страниц, под которыми можно создать данный тип
• subpage_types ограничивает типы страниц, которые можно создать под этим типом

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

Установка parent_page_types в пустой список — хороший способ предотвратить создание определенного типа страницы в интерфейсе редактора.

Описания страниц

В каждой модели страницы Wagtail вы можете добавить полезный текст описания, похожий на атрибут модели help_text. Добавление page_description к вашей модели страницы добавит краткое описание, которое можно увидеть при создании новой страницы, редактировании существующей страницы или при запросе выбора типа дочерней страницы.

class LandingPage(Page):

    page_description = "Use this page for converting users"

URL-адреса страниц

Наиболее распространенный метод получения URL-адресов страниц — использование тега шаблона {% pageurl %}. Поскольку он вызывается из шаблона, pageurl автоматически включает указанные ниже оптимизации. Дополнительную информацию см. в pageurl.

Модели страниц также включают несколько методов низкого уровня для переопределения или доступа к URL-адресам страниц.

def get_url_parts(self, *args, **kwargs):

super().get_url_parts(*args, **kwargs)

Добавление шаблона для модели страницы

Wagtail автоматически выбирает имя шаблона на основе метки приложения и имени класса модели.

Формат: <app_label>/<model_name (snake cased)>.html

Например, шаблон для страницы блога выше будет: blog/blog_page.html

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

Контекст шаблона

Wagtail рендерит шаблоны с переменной page, привязанной к экземпляру страницы, который рендерится. Используйте её для доступа к содержимому страницы. Например, чтобы получить заголовок текущей страницы, используйте {{ page.title }}. Также доступны все переменные, предоставляемые обработчиками контекста.

class BlogIndexPage(Page):
    ...

    def get_context(self, request, *args, **kwargs):
        context = super().get_context(request, *args, **kwargs)

        # Add extra variables and return the updated context
        context['blog_entries'] = BlogPage.objects.child_of(self).live()
        return context

{{ page.title }}

{% for entry in blog_entries %}
    {{ entry.title }}
{% endfor %}

Динамический выбор шаблона

Шаблон можно изменить на уровне экземпляра, определив метод get_template в классе страницы. Этот метод вызывается каждый раз при рендеринге страницы:

class BlogPage(Page):
    ...

    use_other_template = models.BooleanField()

    def get_template(self, request, *args, **kwargs):
        if self.use_other_template:
            return 'blog/other_blog_page.html'

        return 'blog/blog_page.html'

В этом примере страницы, у которых установлено булевое поле use_other_template, будут использовать шаблон blog/other_blog_page.html. Все остальные страницы будут использовать стандартный шаблон blog/blog_page.html.

Шаблоны AJAX

Если вы хотите добавить функциональность AJAX на страницу, например, постраничное представление, которое обновляется на странице без полной перезагрузки, вы можете установить атрибут ajax_template для указания альтернативного шаблона, который будет использоваться при запросе страницы через вызов AJAX (как указано в заголовке X-Requested-With: XMLHttpRequest HTTP):

class BlogPage(Page):
    ...

    ajax_template = 'other_template_fragment.html'
    template = 'other_template.html'

Дружественные имена моделей

Вы можете сделать имена моделей более удобными для пользователей Wagtail, используя внутренний класс Django Meta с verbose_name, например:

class HomePage(Page):
    ...

    class Meta:
        verbose_name = "homepage"

Когда пользователям предлагается выбор страниц для создания, список типов страниц генерируется путем разделения имён моделей по заглавным буквам. Таким образом, модель HomePage получила бы имя «Главная страница», что немного неудобно. Определение verbose_name как в примере выше изменит это на «Главная», что немного более стандартно.

Порядок набора запросов страниц

Модели, производные от Page, не могут быть заданы по умолчанию по порядку с помощью стандартного подхода Django, добавив атрибут ordering к внутреннему классу Meta.

class NewsItemPage(Page):
    publication_date = models.DateField()
    ...

    class Meta:
        ordering = ('-publication_date', )  # will not work

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

news_items = NewsItemPage.objects.live().order_by('-publication_date')

Пользовательские менеджеры страниц

Вы можете добавить пользовательский менеджер Manager к вашему классу Page. Любые пользовательские менеджеры должны наследоваться от wagtail.models.PageManager:

from django.db import models
from wagtail.models import Page, PageManager

class EventPageManager(PageManager):
    """ Custom manager for Event pages """

class EventPage(Page):
    start_date = models.DateField()

    objects = EventPageManager()

В качестве альтернативы, если вам нужно добавить только дополнительные методы QuerySet, вы можете наследоваться от wagtail.models.PageQuerySet для создания пользовательского менеджера Manager:

from django.db import models
from django.utils import timezone
from wagtail.models import Page, PageManager, PageQuerySet

class EventPageQuerySet(PageQuerySet):
    def future(self):
        today = timezone.localtime(timezone.now()).date()
        return self.filter(start_date__gte=today)

EventPageManager = PageManager.from_queryset(EventPageQuerySet)

class EventPage(Page):
    start_date = models.DateField()

    objects = EventPageManager()