Users

This package contains all views related to users

Region User Actions

This module contains view actions for region user objects.

integreat_cms.cms.views.users.region_user_actions.delete_region_user(request: HttpRequest, region_slug: str, user_id: int) → HttpResponseRedirect

This view deletes a region user

Parameters:

• request (HttpRequest) – The current request

• user_id (int) – The id of the user which should be deleted

• region_slug (str)

Returns:

A redirection to region user list

Return type:

HttpResponseRedirect

integreat_cms.cms.views.users.region_user_actions.resend_activation_link_region(request: HttpRequest, region_slug: str, user_id: int) → HttpResponseRedirect

Resends an activation link to a region user

Parameters:

• request (HttpRequest) – The current request

• user_id (int) – users id to send the activation link

• region_slug (str)

Returns:

A redirection to region user list

Return type:

HttpResponseRedirect

Region User Form View

class integreat_cms.cms.views.users.region_user_form_view.RegionUserFormView(**kwargs)

Bases: TemplateView

View for the user form of region users

__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': 'region_user_form'}

The context dict passed to the template (see ContextMixin)

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

Render UserForm for region users

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

Submit UserForm and save User object for region users

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 = 'users/region_user_form.html'

The template to render (see TemplateResponseMixin)

view_is_async = False

Region User List View

class integreat_cms.cms.views.users.region_user_list_view.RegionUserListView(**kwargs)

Bases: TemplateView, FilterSortMixin, PaginationMixin

View for listing region users

__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

default_page_size: int = 16

dispatch(request, *args, **kwargs)

extra_context = {'current_menu_item': 'region_users'}

The context dict passed to the template (see ContextMixin)

filter_form_class: type[ObjectSearchForm] | None = None

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

Render region user 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_filter_form() → ObjectSearchForm | None

Return type:

ObjectSearchForm | None

get_filtered_sorted_queryset(queryset: QuerySet) → QuerySet

Parameters:

queryset (QuerySet)

Return type:

QuerySet

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)

max_page_size: int = 500

model

alias of User

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

paginate_queryset(queryset: QuerySet) → Page

Parameters:

queryset (QuerySet)

Return type:

Page

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.

request: Any

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

property sort_fields: list[str]

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

table_fields: list[tuple[str | None, str]] = []

template_engine = None

template_name = 'users/region_user_list.html'

The template to render (see TemplateResponseMixin)

view_is_async = False

User Actions

This module contains view actions for user objects.

integreat_cms.cms.views.users.user_actions.delete_user(request: HttpRequest, user_id: int) → HttpResponseRedirect

This view deletes a user

Parameters:

• request (HttpRequest) – The current request

• user_id (int) – The id of the user which should be deleted

Returns:

A redirection to user list

Return type:

HttpResponseRedirect

integreat_cms.cms.views.users.user_actions.resend_activation_link(request: HttpRequest, user_id: int) → HttpResponseRedirect

Resends an activation link to an user

Parameters:

• request (HttpRequest) – The current request

• user_id (int) – users id to send the activation link

Returns:

A redirection to region user list

Return type:

HttpResponseRedirect

User Form View

class integreat_cms.cms.views.users.user_form_view.UserFormView(**kwargs)

Bases: TemplateView

View for the user form and user 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.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = {'current_menu_item': 'user_form'}

The context dict passed to the template (see ContextMixin)

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

Render UserForm

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

Submit UserForm and save User

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 = 'users/user_form.html'

The template to render (see TemplateResponseMixin)

view_is_async = False

User List View

class integreat_cms.cms.views.users.user_list_view.UserListView(**kwargs)

Bases: TemplateView

View for listing all users (admin users and region users)

__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': 'users'}

The context dict passed to the template (see ContextMixin)

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

Render user 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.

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 = 'users/user_list.html'

The template to render (see TemplateResponseMixin)

view_is_async = False