Events

This package contains all views related to events

Event Actions

This module contains action methods for events (archive, restore, …)

integreat_cms.cms.views.events.event_actions.archive(request: HttpRequest, event_id: int, region_slug: str, language_slug: str) → HttpResponseRedirect

Set archived flag for an event

Parameters:

• request (HttpRequest) – Object representing the user call

• event_id (int) – internal id of the event to be archived

• 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.events.event_actions.copy(request: HttpRequest, event_id: int, region_slug: str, language_slug: str) → HttpResponseRedirect

Duplicates the given event and all of its translations.

Parameters:

• request (HttpRequest) – Object representing the user call

• event_id (int) – internal id of the event 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.events.event_actions.delete(request: HttpRequest, event_id: int, region_slug: str, language_slug: str) → HttpResponseRedirect

Delete a single event

Parameters:

• request (HttpRequest) – Object representing the user call

• event_id (int) – internal id of the event to be deleted

• 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.events.event_actions.restore(request: HttpRequest, event_id: int, region_slug: str, language_slug: str) → HttpResponseRedirect

Remove archived flag for an event

Parameters:

• request (HttpRequest) – Object representing the user call

• event_id (int) – internal id of the event to be un-archived

• 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.events.event_actions.search_poi_ajax(request: HttpRequest, region_slug: str) → HttpResponse

AJAX endpoint for searching POIs

Parameters:

• request (HttpRequest) – Object representing the user call

• region_slug (str) – The current regions slug

Returns:

The rendered template response

Return type:

HttpResponse

Event Context Mixin

class integreat_cms.cms.views.events.event_context_mixin.EventContextMixin

Bases: ContextMixin

This mixin provides extra context for event views

__init__()

extra_context = None

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]

Event Form View

class integreat_cms.cms.views.events.event_form_view.EventFormView(**kwargs)

Bases: TemplateView, EventContextMixin, MediaContextMixin, ContentEditLockMixin

Class for rendering the events form

__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.

back_url_name: str | None = 'events'

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

content_type = None

dispatch(request, *args, **kwargs)

extra_context = {'translation_status': <module 'integreat_cms.cms.constants.translation_status' from '/home/circleci/project/integreat_cms/cms/constants/translation_status.py'>}

The context dict passed to the template (see ContextMixin)

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

Render event form for HTTP GET requests

Parameters:

• request (HttpRequest) – Object representing the user call

• *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]

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()

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, **kwargs: Any) → HttpResponse

Save event and ender event form for HTTP POST requests

Parameters:

• request (HttpRequest) – Object representing the user call

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

Raises:

PermissionDenied – If user does not have the permission to publish events

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 = 'events/event_form.html'

The template to render (see TemplateResponseMixin)

view_is_async = False

Event List View

class integreat_cms.cms.views.events.event_list_view.EventListView(**kwargs)

Bases: TemplateView, EventContextMixin, MachineTranslationContextMixin

View for listing events (either non-archived or archived events depending on archived)

__init__(**kwargs)

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

archived = False

Whether or not to show archived events

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = None

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

Render events list for HTTP GET requests

Parameters:

• request (HttpRequest) – Object representing the user call

• *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]

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()

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.

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 = 'events/event_list.html'

Template for list of non-archived events

template_archived = 'events/event_list_archived.html'

Template for list of archived events

template_engine = None

property template_name: str

Select correct HTML template, depending on archived flag (see TemplateResponseMixin)

Returns:

Path to HTML template

translation_model

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

Parameters:

• id (BigAutoField) – Primary key: ID

• title (TruncatingCharField) – Title of the event

• slug (SlugField) – Event link. 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

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

Relationship fields:

Parameters:

• language (ForeignKey to Language) – Language (related name: event_translations)

• creator (ForeignKey to User) – Creator (related name: event_translations)

• event (ForeignKey to Event) – Event (related name: translations)

• links (GenericRelation to Link) – Links (related name: event_translation)

Reverse relationships:

Parameters:

feedback (Reverse ForeignKey from EventFeedback) – All feedback of this event translation (related name of event_translation)

alias of EventTranslation

view_is_async = False

Event Version View

class integreat_cms.cms.views.events.event_version_view.EventVersionView(**kwargs)

Bases: EventContextMixin, ContentVersionView

View for browsing the event versions and restoring old event versions

__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.

back_to_form_label: Promise = 'Back to the event form'

The label of the “back to form” button

content_type = None

context_object_name = None

dispatch(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect | TemplateResponse

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

The url to the form in the current language

Returns:

The edit url

extra_context = None

get(request, *args, **kwargs)

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_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()

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

get_queryset()

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()

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_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_change_permission() → bool

Whether the user has the permission to change objects

Returns:

Whether the user can change objects

Return type:

bool

has_permission() → bool

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

Returns:

Whether the current user can access this view

Return type:

bool

has_publish_permission() → bool

Whether the user has the permission to publish objects

Returns:

Whether the user can publish objects

Return type:

bool

has_view_permission() → bool

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']

http_method_not_allowed(request, *args, **kwargs)

language: Language | None = None

The current language

login_url = None

model

The current content model (see SingleObjectMixin)

Parameters:

• id (BigAutoField) – Primary key: ID

• created_date (DateTimeField) – Creation date

• start (DateTimeField) – Start

• end (DateTimeField) – End

• archived (BooleanField) – Archived

• external_event_id (CharField) – The ID of this event in the external calendar

Relationship fields:

Parameters:

• region (ForeignKey to Region) – Region (related name: events)

• location (ForeignKey to POI) – Location (related name: events)

• recurrence_rule (OneToOneField to RecurrenceRule) –

  Recurrence rule (related name: event)

  If the event is recurring, the recurrence rule contains all necessary information on the frequency, interval etc. which is needed to calculate the single instances of a recurring event

• icon (ForeignKey to MediaFile) – Icon (related name: events)

• external_calendar (ForeignKey to ExternalCalendar) – External calendar (related name: events)

Reverse relationships:

Parameters:

translations (Reverse ForeignKey from EventTranslation) – All translations of this event (related name of event)

alias of Event

property model_name: str

The name of this model

Returns:

The name of this model

object: AbstractContentModel | None = None

The current content object (see SingleObjectMixin)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

permission_denied_message = ''

permission_required = None

property pk_url_kwarg: str

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

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

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

restore_version(restored_version: Any) → None

Restore the given version

Parameters:

restored_version (Any) – The version which should be restored

Return type:

None

selected_version: AbstractContentTranslation | None = None

The currently selected translation version

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

slug_field = 'slug'

slug_url_kwarg = 'slug'

template_engine = None

template_name: str = 'content_versions.html'

The template to render (see TemplateResponseMixin)

translations: list[AbstractContentTranslation] = []

All translations of the content object in the current language

property versions_url: str

The url to the form in the current language

Returns:

The edit url

view_is_async = False