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 and the region’s media files are removed from the file system. 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

integreat_cms.cms.views.regions.region_actions.release_api_management(request: HttpRequest, slug: str) → HttpResponseRedirect

This view releases a region from being managed by an external system via the API.

It only clears api_settings_synced_at, which is what marks a region as API-managed and makes the synced settings read-only in the region form. Nothing else is changed: the settings themselves keep the values the external system pushed last.

The release is deliberately not permanent. If the connected system pushes again, the region is marked as API-managed once more and the fields become read-only again – which is the desired semantics: the release states “we maintain these settings here from now on”, and a subsequent push visibly contradicts that instead of failing silently.

Parameters:

• request (HttpRequest) – The current request

• slug (str) – The slug of the region

Returns:

A redirection to the region form

Return type:

HttpResponseRedirect

Region List View

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

Bases: TemplateView, FilterSortMixin, PaginationMixin

View for listing regions

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

model

alias of Region

template_name = 'regions/region_list.html'

The template to render (see TemplateResponseMixin)

Region Update View

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

Bases: CustomUpdateView

View for updating regions

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)

• places_enabled: Activate places (BooleanField)

• contacts_enabled: Activate contacts (BooleanField)

• push_notifications_enabled: Activate news (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)

• hix_enabled: Activate HIX analysis (BooleanField)

• mt_budget_booked: Machine translation budget (IntegerField)

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

• mt_budget_adjustment: Machine translation budget adjustment (IntegerField)

• 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

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

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