6. Расширение панели инструментов¶

6.1. Добавить базовый класс PollToolbar¶

Мы добавим различные элементы управления на панель инструментов, используя подкласс cms.toolbar_base.CMSToolbar.

6.1.1. Добавить меню на панель инструментов¶

Начните с добавления нового файла, cms_toolbars.py, в ваше приложение Polls/CMS Integration, и создайте класс CMSToolbar:

from cms.toolbar_base import CMSToolbar
from cms.toolbar_pool import toolbar_pool
from polls.models import Poll


class PollToolbar(CMSToolbar):

    def populate(self):
        self.toolbar.get_or_create_menu(
            'polls_cms_integration-polls',  # a unique key for this menu
            'Polls',                        # the text that should appear in the menu
            )


# register the toolbar
toolbar_pool.register(PollToolbar)

Примечание

Не забудьте перезапустить runserver, чтобы ваш новый файл cms_toolbars.py был распознан.

Теперь на каждой странице сайта вы найдете новый элемент на панели инструментов:

Метод populate() - это то, что вызывается при создании панели инструментов. В нем мы используем get_or_create_menu() для добавления элемента Polls на панель инструментов.

6.1.1.1. Добавить узлы в меню Вопросы¶

Пока что меню Polls пустое. Мы можем расширить populate(), чтобы добавить некоторые пункты. get_or_create_menu возвращает меню, которым мы можем манипулировать, поэтому давайте изменим метод populate(), чтобы добавить элемент, позволяющий нам видеть полный список опросов в боковом фрейме, с помощью add_sideframe_item().

from cms.utils.urlutils import admin_reverse
[...]


class PollToolbar(CMSToolbar):

    def populate(self):
        menu = self.toolbar.get_or_create_menu('polls_cms_integration-polls', 'Polls')

        menu.add_sideframe_item(
            name='Poll list',                              # name of the new menu item
            url=admin_reverse('polls_poll_changelist'),    # the URL it should open with
        )

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

Также полезной была бы возможность создания новых опросов. Для этого мы будем использовать модальное окно, вызываемое методом add_modal_item(). Добавьте новый код в конец метода populate():

class PollToolbar(CMSToolbar):

    def populate(self):
        [...]

        menu.add_modal_item(
            name='Add a new poll',                # name of the new menu item
            url=admin_reverse('polls_poll_add'),  # the URL it should open with
        )

def populate(self):

    buttonlist = self.toolbar.add_button_list()

    buttonlist.add_sideframe_button(
        name='Poll list',
        url=admin_reverse('polls_poll_changelist'),
    )

    buttonlist.add_modal_button(
        name='Add a new poll',
        url=admin_reverse('polls_poll_add'),
    )

6.2. Дальнейшие усовершенствования¶

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

Первое, что нужно добавить, это тест в самом начале метода populate():

    def populate(self):

        if not self.is_current_app:
            return

        [...]

Флаг is_current_app говорит нам, принадлежит ли функция, обрабатывающая данное представление (например, список опросов), тому же приложению, что и то, которое отвечает за данное меню панели инструментов.

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

class PollToolbar(CMSToolbar):

    supported_apps = ['polls']

Теперь кнопки/меню будут появляться только на соответствующих страницах.

6.3. Полное cms_toolbars.py¶

Для полноты картины приводим полный пример:

from cms.utils.urlutils import admin_reverse
from cms.toolbar_base import CMSToolbar
from cms.toolbar_pool import toolbar_pool
from polls.models import Poll


class PollToolbar(CMSToolbar):
    supported_apps = ['polls']

    def populate(self):

        if not self.is_current_app:
            return

        menu = self.toolbar.get_or_create_menu('polls_cms_integration-polls', 'Polls')

        menu.add_sideframe_item(
            name='Poll list',
            url=admin_reverse('polls_poll_changelist'),
        )

        menu.add_modal_item(
            name=('Add a new poll'),
            url=admin_reverse('polls_poll_add'),
        )

        buttonlist = self.toolbar.add_button_list()

        buttonlist.add_sideframe_button(
            name='Poll list',
            url=admin_reverse('polls_poll_changelist'),
        )

        buttonlist.add_modal_button(
            name='Add a new poll',
            url=admin_reverse('polls_poll_add'),
        )

toolbar_pool.register(PollToolbar)  # register the toolbar

Это всего лишь базовый пример, и существует гораздо больше классов панелей инструментов django CMS, чем этот - смотрите Как расширить панель инструментов для более подробной информации.