Places

This package contains all views related to places

Place Actions

This module contains view actions for objects related to places.

integreat_cms.cms.views.places.place_actions.archive_place(request: HttpRequest, place_id: int, region_slug: str, language_slug: str) → HttpResponseRedirect[source]

Archive place object

Parameters:

  • request (HttpRequest) – The current request

  • place_id (int) – The id of the place which should be archived

  • region_slug (str) – The slug of the current region

  • language_slug (str) – The slug of the current language

Returns:

A redirection to the PlaceListView

Return type:

HttpResponseRedirect

integreat_cms.cms.views.places.place_actions.auto_complete_address(request: HttpRequest, region_slug: str) → JsonResponse[source]

Autocomplete place address and coordinates

Parameters:

  • request (HttpRequest) – The current request

  • region_slug (str)

Raises:

Http404 – If no place was found for the given address

Returns:

The address and coordinates of the place

Return type:

JsonResponse

integreat_cms.cms.views.places.place_actions.copy_place(request: HttpRequest, place_id: int, region_slug: str, language_slug: str) → HttpResponseRedirect[source]

Duplicates the given event and all of its translations.

Parameters:

  • request (HttpRequest) – Object representing the user call

  • place_id (int) – internal id of the place to be copied

  • region_slug (str) – slug of the region which the event belongs to

  • language_slug (str) – current GUI language slug

Returns:

The rendered template response

Return type:

HttpResponseRedirect

integreat_cms.cms.views.places.place_actions.delete_place(request: HttpRequest, place_id: int, region_slug: str, language_slug: str) → HttpResponseRedirect[source]

Delete place object

Parameters:

  • request (HttpRequest) – The current request

  • place_id (int) – The id of the place which should be deleted

  • region_slug (str) – The slug of the current region

  • language_slug (str) – The slug of the current language

Returns:

A redirection to the PlaceListView

Return type:

HttpResponseRedirect

integreat_cms.cms.views.places.place_actions.get_address_from_coordinates(request: HttpRequest, region_slug: str) → JsonResponse[source]

Derive address from the coordinates (map pin position)

Parameters:

  • request (HttpRequest) – The current request

  • region_slug (str)

Raises:

Http404 – If no address was found for the given coordinates

Returns:

The address of the place

Return type:

JsonResponse

integreat_cms.cms.views.places.place_actions.restore_place(request: HttpRequest, place_id: int, region_slug: str, language_slug: str) → HttpResponseRedirect[source]

Restore place object (set archived=False)

Parameters:

  • request (HttpRequest) – The current request

  • place_id (int) – The id of the place which should be restored

  • region_slug (str) – The slug of the current region

  • language_slug (str) – The slug of the current language

Returns:

A redirection to the PlaceListView

Return type:

HttpResponseRedirect

integreat_cms.cms.views.places.place_actions.view_place(request: HttpRequest, place_id: int, region_slug: str, language_slug: str) → HttpResponse[source]

View place object

Parameters:

  • request (HttpRequest) – The current request

  • place_id (int) – The id of the place which should be viewed

  • language_slug (str) – The slug of the current language

  • region_slug (str)

Raises:

Http404 – If user no translation exists for the requested place and language

Returns:

A redirection to the PlaceListView

Return type:

HttpResponse

Place Context Mixin

class integreat_cms.cms.views.places.place_context_mixin.PlaceContextMixin[source]

Bases: ContextMixin

This mixin provides extra context for language tree views

__init__()[source]
extra_context = None[source]
get_context_data(**kwargs: Any) → dict[str, Any][source]

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]

related_class[source]

alias of Place

Place Form Ajax View

class integreat_cms.cms.views.places.place_form_ajax_view.PlaceFormAjaxView(**kwargs)[source]

Bases: TemplateView, PlaceContextMixin

View for the ajax place widget

__init__(**kwargs)[source]

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

classmethod as_view(**initkwargs)[source]

Main entry point for a request-response process.

content_type = None[source]
dispatch(request, *args, **kwargs)[source]
extra_context = None[source]
get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse[source]

Render a place form widget template

Parameters:

  • request (HttpRequest) – The current request

  • *args (Any) – The supplied arguments

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

Returns:

The html template of a place form

Return type:

HttpResponse

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

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_template_names()[source]

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'][source]
http_method_not_allowed(request, *args, **kwargs)[source]
options(request, *args, **kwargs)[source]

Handle responding to requests for the OPTIONS HTTP verb.

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

Add a new place to the database

Parameters:

  • request (HttpRequest) – The current request

  • *args (Any) – The supplied arguments

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

Raises:

Http404 – If no language for the given language slug was found

Returns:

A status message, either a success or an error message

Return type:

HttpResponse

related_class[source]

alias of Place

render_to_response(context, **response_kwargs)[source]

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[source]

alias of TemplateResponse

setup(request, *args, **kwargs)[source]

Initialize attributes shared by all view methods.

template = 'ajax_place_form/_place_form_widget.html'[source]

Template for ajax place widget

template_engine = None[source]
template_name = None[source]
view_is_async = False[source]

Place Form View

A view representing an instance of a place. Places can be created or updated via this view.

class integreat_cms.cms.views.places.place_form_view.PlaceFormView(**kwargs)[source]

Bases: TemplateView, PlaceContextMixin, MediaContextMixin, ContentEditLockMixin

View for editing places

__init__(**kwargs)[source]

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

adjust_status_of_dependent_translations(place_translation_form: PlaceTranslationForm, language: Language, region: Region) → None[source]

Change the status of all dependent translations of the place according to the status of the current translation.

Parameters:
Return type:

None

classmethod as_view(**initkwargs)[source]

Main entry point for a request-response process.

back_url_name: str | None = 'places'[source]

The url name of the view to show if the user decides to go back (see ContentEditLockMixin)

check_if_place_is_locked(request: HttpRequest, place: Place | None) → bool[source]

Check if the content is locked for editing.

Parameters:

  • request (HttpRequest)

  • place (Place | None)

Return type:

bool

content_type = None[source]
dispatch(request, *args, **kwargs)[source]
extra_context = None[source]
get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse[source]

Render PlaceForm and PlaceTranslationForm

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: Any) → dict[str, Any][source]

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_instances(language: Language, place_id: Any) → tuple[Place, PlaceTranslation][source]
Parameters:
Return type:

tuple[Place, PlaceTranslation]

get_template_names()[source]

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'][source]
http_method_not_allowed(request, *args, **kwargs)[source]
instantiate_forms(request: HttpRequest, place_instance: Place, place_translation_instance: PlaceTranslation, language: Language, region: Any) → tuple[PlaceForm, PlaceTranslationForm][source]
Parameters:
Return type:

tuple[PlaceForm, PlaceTranslationForm]

is_qualified_for_save(request: HttpRequest, place_form: PlaceForm, place_translation_form: PlaceTranslationForm) → bool[source]

Checks whether the current request should proceed with saving the page and translation.

Parameters:
Return type:

bool

options(request, *args, **kwargs)[source]

Handle responding to requests for the OPTIONS HTTP verb.

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

Submit PlaceForm and PlaceTranslationForm and save Place and PlaceTranslation objects

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

related_class[source]

alias of Place

related_contact_data_added(data: dict[str, str | list[str]]) → bool[source]
Parameters:

data (dict[str, str | list[str]])

Return type:

bool

render_to_response(context, **response_kwargs)[source]

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[source]

alias of TemplateResponse

set_success_messages(is_edit: bool, request: HttpRequest, place_translation_form: PlaceTranslationForm, place_form: PlaceForm) → None[source]

Show success messages after saving the place and PlaceTranslation forms.

Parameters:
Return type:

None

setup(request, *args, **kwargs)[source]

Initialize attributes shared by all view methods.

show_slug_changed_message(request: HttpRequest, language: Language, region: Any, user_slug: str, place_translation_form: PlaceTranslationForm) → None[source]

Shows a message to the user if the slug they provided was not unique and therefore changed.

Parameters:
Return type:

None

template_engine = None[source]
template_name = 'places/place_form.html'[source]

The template to render (see TemplateResponseMixin)

update_contact_cards(place_form: PlaceForm) → None[source]

Send the post save signal of contact model to trigger contact card update

Parameters:

place_form (PlaceForm)

Return type:

None

validate_and_save_place(request: HttpRequest, place_form: PlaceForm) → bool[source]
Parameters:

  • request (HttpRequest)

  • place_form (PlaceForm)

Return type:

bool

Parameters:
Return type:

bool

validate_place_translation(request: HttpRequest, place_translation_form: PlaceTranslationForm) → bool[source]
Parameters:
Return type:

bool

view_is_async = False[source]
warn_if_coordinates_too_far(request: HttpRequest, place_form: PlaceForm) → None[source]

Warn the user if the manually entered coordinates are too far from the entered address.

Parameters:

  • request (HttpRequest)

  • place_form (PlaceForm)

Return type:

None

Place List View

class integreat_cms.cms.views.places.place_list_view.PlaceListView(**kwargs)[source]

Bases: TemplateView, PlaceContextMixin, MachineTranslationContextMixin, FilterSortMixin, PaginationMixin

View for listing places

__init__(**kwargs)[source]

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

archived = False[source]

Whether or not to show archived places

classmethod as_view(**initkwargs)[source]

Main entry point for a request-response process.

content_type = None[source]
default_page_size = 16[source]
dispatch(request, *args, **kwargs)[source]
extra_context = None[source]
filter_form_class = None[source]
get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse[source]

Render place 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: Any) → dict[str, Any][source]

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_filter_form() → ObjectSearchForm | None[source]
Return type:

ObjectSearchForm | None

get_filtered_sorted_queryset(queryset: QuerySet) → QuerySet[source]

Annotate sort keys that match what the user actually sees in the list:

  • _sort_title and _sort_status: latest translation (any version, including auto-saves) in the language slug from the URL — this is the translation rendered by place_list_row.html.

  • _sort_status ranks status values by workflow order (AUTO_SAVE, DRAFT, REVIEW, PUBLIC) instead of by the lexicographic order of the choice keys, which has no relation to the localized labels shown.

  • _sort_category_name: name of the category in the active backend (UI) language, mirroring how PlaceCategory.__str__ renders the column.

Parameters:

queryset (QuerySet)

Return type:

QuerySet

get_template_names()[source]

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'][source]
http_method_not_allowed(request, *args, **kwargs)[source]
max_page_size = 500[source]
model[source]

alias of Place

options(request, *args, **kwargs)[source]

Handle responding to requests for the OPTIONS HTTP verb.

paginate_queryset(queryset: QuerySet) → Page[source]
Parameters:

queryset (QuerySet)

Return type:

Page

related_class[source]

alias of Place

render_to_response(context, **response_kwargs)[source]

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.

request[source]
response_class[source]

alias of TemplateResponse

setup(request, *args, **kwargs)[source]

Initialize attributes shared by all view methods.

property sort_fields: list[str][source]

Extract only sortable field names from table_fields. A field is sortable if its first element is not None.

table_fields = [('_sort_title', 'Title'), ('_sort_status', 'Publication status'), ('address', 'Street'), ('postcode', 'Postal Code'), ('city', 'City'), ('country', 'Country'), ('_sort_category_name', 'Category')][source]
template_engine = None[source]
template_name = 'places/place_list.html'[source]

Template for list of non-archived and archived places

translation_model[source]

The translation model of this list view (used to determine whether machine translations are permitted)

Parameters:

  • id (BigAutoField) – Primary key: ID

  • title (TruncatingCharField) – Name of the place

  • slug (SlugField) – Link to the place. String identifier without spaces and special characters. Unique per region and language. Leave blank to generate unique parameter from title.

  • status (CharField) – Status

  • content (TextField) – Description

  • currently_in_translation (BooleanField) – Currently in translation. Flag to indicate a translation is being updated by an external translator

  • machine_translated (BooleanField) – Machine translated. Flag to indicate whether a translations is machine translated

  • version (PositiveIntegerField) – Revision

  • minor_edit (BooleanField) – Minor edit. Tick if this change does not require an update of translations in other languages.

  • last_updated (DateTimeField) – Modification date

  • published_at (DateTimeField) – Publication date

  • automatic_translation (BooleanField) – Automatic translation. Tick if updating this content should automatically refresh or create its translations.

  • meta_description (CharField) – Meta description. Describe the place in one or two short sentences. This text will be displayed in the Google search results below the title.

Relationship fields:

Parameters:

Reverse relationships:

Parameters:

feedback (Reverse ForeignKey from PlaceFeedback) – All feedback of this place translation (related name of place_translation)

alias of PlaceTranslation

view_is_async = False[source]

Place Version View

class integreat_cms.cms.views.places.place_version_view.PlaceVersionView(**kwargs)[source]

Bases: PlaceContextMixin, ContentVersionView

View for browsing the place versions and restoring old place versions

__init__(**kwargs)[source]

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

classmethod as_view(**initkwargs)[source]

Main entry point for a request-response process.

back_to_form_label = 'Back to the place form'[source]

The label of the “back to form” button

content_type = None[source]
context_object_name = None[source]
dispatch(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect | TemplateResponse[source]

Validate the versions view

Parameters:

  • request (HttpRequest) – The current request

  • *args (Any) – The supplied arguments

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

Raises:

PermissionDenied – If user does not have the permission to edit the specific page

Returns:

The rendered template response

Return type:

HttpResponseRedirect | TemplateResponse

property edit_url: str[source]

The url to the form in the current language

Returns:

The edit url

extra_context = None[source]
get(request, *args, **kwargs)[source]
get_context_data(**kwargs: Any) → dict[str, Any][source]

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)[source]

Get the name to use for the object.

get_login_url()[source]

Override this method to override the login_url attribute.

get_object(queryset=None)[source]

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()[source]

Override this method to override the permission_denied_message attribute.

get_permission_required()[source]

Override this method to override the permission_required attribute. Must return an iterable.

get_queryset()[source]

Filter the content objects by the current region

Raises:

Http404 – HTTP status 404 if the content is not found

Returns:

The rendered template response

Return type:

ContentQuerySet | (EventQuerySet | PageQuerySet)

get_redirect_field_name()[source]

Override this method to override the redirect_field_name attribute.

get_slug_field()[source]

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

get_template_names()[source]

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()[source]
has_change_permission() → bool[source]

Whether the user has the permission to change objects

Returns:

Whether the user can change objects

Return type:

bool

has_permission() → bool[source]

Override django.contrib.auth.mixins.PermissionRequiredMixin.has_permission()

Returns:

Whether the current user can access this view

Return type:

bool

has_publish_permission() → bool[source]

All users who can change places also can publish these changes

Returns:

Whether the user can publish places

Return type:

bool

has_view_permission() → bool[source]

Whether the user has the permission to change objects

Returns:

Whether the user can change objects

Return type:

bool

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace'][source]
http_method_not_allowed(request, *args, **kwargs)[source]
language = None[source]

The current language

login_url = None[source]
model[source]

The current content model (see SingleObjectMixin)

Parameters:

  • id (BigAutoField) – Primary key: ID

  • created_date (DateTimeField) – Creation date

  • do_not_translate_title (BooleanField) – Do not translate the title. Tick if you do not want to translate the title by automatic translation.

  • address (CharField) – Street and house number

  • postcode (CharField) – Postal code

  • city (CharField) – City

  • country (CharField) – Country

  • latitude (FloatField) – Latitude. The latitude coordinate

  • longitude (FloatField) – Longitude. The longitude coordinate

  • place_on_map (BooleanField) – Show this place on map. Tick if you want to show this place on map

  • archived (BooleanField) – Archived. Whether or not the place is read-only and hidden in the API.

  • temporarily_closed (BooleanField) – Temporarily closed. Whether or not the place is temporarily closed. The opening hours remain and are only hidden.

  • appointment_url (URLField) – Appointment link. Link to an external website where an appointment for this place can be made.

  • opening_hours (JSONField) – Opening hours

  • barrier_free (BooleanField) – Barrier free. Indicate if the place is barrier free.

Relationship fields:

Parameters:

Reverse relationships:

Parameters:

  • translations (Reverse ForeignKey from PlaceTranslation) – All translations of this place (related name of place)

  • contacts (Reverse ForeignKey from Contact) – All contacts of this place (related name of place)

  • events (Reverse ForeignKey from Event) – All events of this place (related name of place)

alias of Place

property model_name: str[source]

The name of this model

Returns:

The name of this model

object = None[source]

The current content object (see SingleObjectMixin)

options(request, *args, **kwargs)[source]

Handle responding to requests for the OPTIONS HTTP verb.

permission_denied_message = ''[source]
permission_required = None[source]
property pk_url_kwarg: str[source]

The name of the URLConf keyword argument that contains the primary key. By default, pk_url_kwarg is ‘pk’. See django.views.generic.detail.SingleObjectMixin.pk_url_kwarg.

Returns:

The name of URL kwarg of the id

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

Restore a previous revision of a page translation

Parameters:

  • request (HttpRequest) – The current request

  • *args (Any) – The supplied arguments

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

Raises:

PermissionDenied – If user does not have the permission to edit the specific page

Returns:

The rendered template response

Return type:

HttpResponseRedirect

query_pk_and_slug = False[source]
queryset = None[source]
raise_exception = False[source]
redirect_field_name = 'next'[source]
related_class[source]

alias of Place

render_to_response(context, **response_kwargs)[source]

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[source]

alias of TemplateResponse

restore_version(restored_version: Any) → None[source]

Restore the given version

Parameters:

restored_version (Any) – The version which should be restored

Return type:

None

selected_version = None[source]

The currently selected translation version

setup(request, *args, **kwargs)[source]

Initialize attributes shared by all view methods.

slug_field = 'slug'[source]
slug_url_kwarg = 'slug'[source]
template_engine = None[source]
template_name = 'content_versions.html'[source]

The template to render (see TemplateResponseMixin)

translations = [][source]

All translations of the content object in the current language

property versions_url: str[source]

The url to the form in the current language

Returns:

The edit url

view_is_async = False[source]