Как создать apphooks¶

Основы создания apphook¶

Чтобы создать apphook, создайте файл cms_apps.py в вашем приложении.

Файл должен содержать подкласс CMSApp. Например:

from cms.app_base import CMSApp
from cms.apphook_pool import apphook_pool

@apphook_pool.register
class MyApphook(CMSApp):
    app_name = "myapp"  # must match the application namespace
    name = "My Apphook"

    def get_urls(self, page=None, language=None, **kwargs):
        return ["myapp.urls"] # replace this with the path to your application's URLs module

re_path(r'^myapp/', include('myapp.urls', app_name='myapp'))

from django.urls import re_path
from myapp.views import SomeListView, SomeDetailView

class MyApphook(CMSApp):
    # ...
    def get_urls(self, page=None, language=None, **kwargs):
        return [
            re_path(r'^$', SomeListView.as_view()),
            re_path(r'^(?P<slug>[\w-]+)/?$', SomeDetailView.as_view()),
        ]

Использование apphook¶

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

apphook прикрепляет все URL-адреса приложения apphooked к странице; корневой URL будет собственным URL-адресом страницы, а все URL-адреса более низкого уровня будут находиться на том же пути URL.

Итак, в приложении с urls.py для представлений index_view и archive_view:

urlpatterns = [
    re_path(r'^$', index_view),
    re_path(r'^archive/$', archive_view),
]

прикрепленной к странице, путь URL которой /hello/world/, представления будут открыты следующим образом:

• index_view при /hello/world/

• archive_view при /hello/world/archive/

Управление apphooks¶

manage.py cms uninstall apphooks MyApphook MyOtherApphook

manage.py cms list apphooks

Добавление меню в apphooks¶

Как правило, рекомендуется позволить пользователю контролировать, прикреплено ли меню к странице (См. Прикрепить меню подробнее об этих меню). Однако при необходимости можно сделать так, чтобы apphook делал это автоматически. Он будет вести себя так же, как если бы меню было прикреплено к странице с помощью его Дополнительных настроек).

Меню можно добавить в apphook с помощью метода get_menus(). На основе приведенного выше примера:

# [...]
from myapp.cms_menus import MyAppMenu

class MyApphook(CMSApp):
    # [...]
    def get_menus(self, page=None, language=None, **kwargs):
        return [MyAppMenu]

Меню, возвращаемые в методе get_menus(), должны возвращать список узлов в своих методах get_nodes(). В Прикрепить меню есть больше информации о создании классов меню, которые генерируют узлы.

Вы можете вернуть несколько классов меню; все они будут прикреплены к одной странице:

def get_menus(self, page=None, language=None, **kwargs):
    return [MyAppMenu, CategoryMenu]

Управление разрешениями на apphooks¶

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

Чтобы отключить это поведение, установите permissions = False в вашем apphook:

class MyApphook(CMSApp):
    [...]
    permissions = False

Если вы все еще хотите, чтобы некоторые из ваших представлений использовали проверки разрешений CMS, вы можете включить их с помощью декоратора, cms.utils.decorators.cms_perms.

Вот простой пример:

from cms.utils.decorators import cms_perms

@cms_perms
def my_view(request, **kw):
    ...

Если вы делаете собственные проверки разрешений в своем приложении, то используйте свойство exclude_permissions в apphook:

class MyApphook(CMSApp):
    [...]
    permissions = True
    exclude_permissions = ["some_nested_app"]

где вы указываете название приложения, о котором идет речь

Автоматический перезапуск сервера при изменении apphook¶

Как упоминалось выше, всякий раз, когда вы:

• добавить или удалить apphook

• изменение slug страницы, содержащей apphook

• изменение slug страницы с потомком с помощью apphook

CMS сервер будет перезагружать свои кэши URL. Для этого он прослушивает сигнал cms.signals.urls_need_reloading.

Apphooks и тэги шаблонов¶

Важно понимать, что хотя apphooked приложение полностью берет на себя страницу CMS в этом месте, в зависимости от того, как шаблоны приложения расширяют другие шаблоны, тег шаблона django CMS {% placeholder %} может быть вызван - но не будет работать.

С другой стороны, теги {% static_placeholder %} не специфичны для страницы и будут функционировать нормально.