Apphooks

class cms.app_base.``CMSApp

CMSApp is the base class for django CMS apphooks.

  • _urls

    list of urlconfs: example: _urls = ["myapp.urls"]

  • _menus

    list of menu classes: example: _menus = [MyAppMenu]

  • name = None

    name of the apphook (required)

  • app_name = None

    name of the app, this enables Django namespaces support (optional)

  • app_config = None

    configuration model (optional)

  • permissions = True

    if set to true, apphook inherits permissions from the current page

  • exclude_permissions = []

    list of application names to exclude from inheriting CMS permissions

  • get_configs()

    Returns all the apphook configuration instances.

  • get_config(namespace)

    Returns the apphook configuration instance linked to the given namespace

  • get_config_add_url()

    Returns the url to add a new apphook configuration instance (usually the model admin add view)

  • get_menus(page, language, \*kwargs*)

    Returns the menus for the apphook instance, eventually selected according to the given arguments.

    By default it returns the menus assigned to cms.app_base.CMSApp._menus

    If no page and language si provided, this method must return all the menus used by this apphook. Example:

    1. if page and page.reverse_id == 'page1':
    2.     return [Menu1]
    3. elif page and page.reverse_id == 'page2':
    4.     return [Menu2]
    5. else:
    6.     return [Menu1, Menu2]
    Parameters:
    • page – page the apphook is attached to
    • language – current site language
    Returns:

    list of menu classes

  • get_urls(page, language, \*kwargs*)

    Returns the urlconfs for the apphook instance, eventually selected according to the given arguments.

    By default it returns the urls assigned to cms.app_base.CMSApp._urls

    This method must return a non empty list of urlconfs, even if no argument is passed.

    Parameters:
    • page – page the apphook is attached to
    • language – current site language
    Returns:

    list of urlconfs strings