Regions

This package contains all views related to regions

Region Actions

This module contains view actions for region objects.

integreat_cms.cms.views.regions.region_actions.delete_region(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect

This view deletes a region. All content is cascade deleted. Region users, who are not assigned to any other region, are manually removed.

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

A redirection to the media library

Return type:

HttpResponseRedirect

Region List View

class integreat_cms.cms.views.regions.region_list_view.RegionListView(**kwargs)

Bases: TemplateView

View for listing regions

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = {'current_menu_item': 'regions'}

The context dict passed to the template (see ContextMixin)

get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Render region list

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

get_context_data(**kwargs)

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Apply the query and filter the rendered regions

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

template_engine = None

template_name = 'regions/region_list.html'

The template to render (see TemplateResponseMixin)

view_is_async = False

Region Update View

class integreat_cms.cms.views.regions.region_update_view.RegionUpdateView(**kwargs)

Bases: CustomUpdateView

View for updating regions

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

context_object_name = None

dispatch(request, *args, **kwargs)

extra_context = None

fields = None

form_class

The form class for this update view

Form fields:

• name: Name (CharField)

• common_id: Community identification number (CharField)

• slug: URL parameter (SlugField)

• events_enabled: Activate events (BooleanField)

• locations_enabled: Activate locations (BooleanField)

• contacts_enabled: Activate contacts (BooleanField)

• chat_enabled: Activate author chat (BooleanField)

• push_notifications_enabled: Activate push notifications (BooleanField)

• term_explanations_enabled: Activate term explanations (BooleanField)

• latitude: Latitude (FloatField)

• longitude: Longitude (FloatField)

• longitude_min: Minimum longitude (FloatField)

• latitude_min: Minimum latitude (FloatField)

• longitude_max: Maximum longitude (FloatField)

• latitude_max: Maximum latitude (FloatField)

• postal_code: Postal code (CharField)

• admin_mail: Email address of the administrator (EmailField)

• statistics_enabled: Activate statistics (BooleanField)

• matomo_id: Matomo ID (IntegerField)

• matomo_token: Matomo authentication token (CharField)

• status: Status (TypedChoiceField)

• page_permissions_enabled: Activate page-specific permissions (BooleanField)

• administrative_division: Administrative division (TypedChoiceField)

• aliases: Aliases (JSONField)

• icon: Logo (ModelChoiceField)

• administrative_division_included: Include administrative division into name (BooleanField)

• offers: Offers (ModelMultipleChoiceField)

• short_urls_enabled: Activate short urls (BooleanField)

• seo_enabled: Activate SEO section (BooleanField)

• custom_prefix: Custom prefix (CharField)

• external_news_enabled: Enable external news (BooleanField)

• timezone: Timezone (CharField)

• fallback_translations_enabled: Show content in default language as fallback (BooleanField)

• summ_ai_enabled: Activate automatic translations via SUMM.AI (BooleanField)

• summ_ai_renewal_month: Credits renewal date for simplified language translation (TypedChoiceField)

• summ_ai_midyear_start_enabled: Budget year start differs from the renewal date (BooleanField)

• summ_ai_midyear_start_month: Budget year start date for simplified language translation (TypedChoiceField)

• hix_enabled: Activate HIX analysis (BooleanField)

• mt_budget_booked: Machine translation budget (TypedChoiceField)

• mt_renewal_month: Credits renewal date for foreign language translation (TypedChoiceField)

• mt_midyear_start_enabled: Budget year start differs from the renewal date (BooleanField)

• mt_midyear_start_month: Budget year start date for foreign language translation (TypedChoiceField)

• integreat_chat_enabled: Enable public chat (BooleanField)

• zammad_url: Zammad-URL (URLField)

• zammad_access_token: Zammad access token (CharField)

• zammad_webhook_token: Token used by Zammad webhook (UUIDField)

• zammad_privacy_policy: Custom Integreat Chat privacy policy (CharField)

• chat_beta_tester_percentage: Chat beta tester percentage (IntegerField)

• duplicated_region: Copy languages, pages and media from another region (ModelChoiceField)

• duplication_keep_status: Keep publication status of pages (BooleanField)

• duplication_keep_translations: Copy languages and content translations (BooleanField)

• duplication_pbo_behavior: Page based offers cloning behavior (ChoiceField)

• timezone_area: Timezone area (ChoiceField)

• zammad_offers: Zammad forms (ModelMultipleChoiceField)

alias of RegionForm

form_invalid(form: CustomModelForm) → HttpResponse

Renders a response, providing the invalid form as context.

Parameters:

form (CustomModelForm) – The invalid form instance

Returns:

The rendered invalid form

Return type:

HttpResponse

form_valid(form: CustomModelForm) → HttpResponseRedirect

Saves the form instance, sets the current object for the view, and redirects to get_success_url().

Parameters:

form (CustomModelForm) – The valid form instance

Returns:

A redirection to the success url

Return type:

HttpResponseRedirect

get(request: HttpRequest, *args: Any, **kwargs: Any) → TemplateResponse

Render region form for HTTP GET requests

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

TemplateResponse

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

get_context_object_name(obj)

Get the name to use for the object.

get_form(form_class=None)

Return an instance of the form to be used in this view.

get_form_class()

Return the form class to use in this view.

get_form_kwargs() → dict[str, Any]

Return the keyword arguments for instantiating the form

Returns:

The form kwargs

Return type:

dict[str, Any]

get_initial()

Return the initial data to use for forms on this view.

get_login_url()

Override this method to override the login_url attribute.

get_object(queryset=None)

Return the object the view is displaying.

Require self.queryset and a pk or slug argument in the URLconf. Subclasses can override this to return any object.

get_permission_denied_message()

Override this method to override the permission_denied_message attribute.

get_permission_required() → tuple[str]

Override this method to override the permission_required attribute.

Returns:

The permissions that are required for views inheriting from this Mixin

Return type:

tuple[str]

get_prefix()

Return the prefix to use for forms.

get_queryset()

Return the QuerySet that will be used to look up the object.

This method is called by the default implementation of get_object() and may not be called if get_object() is overridden.

get_redirect_field_name()

Override this method to override the redirect_field_name attribute.

get_slug_field()

Get the name of a slug field to be used to look up by slug.

get_success_url() → str

Determine the URL to redirect to when the form is successfully validated

Returns:

The url to redirect on success

Return type:

str

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

handle_no_permission()

has_permission()

Override this method to customize the way permissions are checked.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

initial = {}

login_url = None

property model: ModelBase

Return the model class of this form mixin

Returns:

The corresponding Django model

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

permission_denied_message = ''

permission_required = None

pk_url_kwarg = 'pk'

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect

Updates region and removes mirrored pages from all pages of the region when it gets archived

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponseRedirect

prefix = None

put(*args, **kwargs)

query_pk_and_slug = False

queryset = None

raise_exception = False

redirect_field_name = 'next'

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

slug_field = 'slug'

slug_url_kwarg = 'slug'

success_url = None

template_engine = None

property template_name: str

Return the template name to be used for the request.

Returns:

The template to be rendered

template_name_suffix: str = '_form'

The suffix to append to the auto-generated candidate template name.

view_is_async = False