POIs

Forms for creating and modifying POI and POI translation objects

POI Form

class integreat_cms.cms.forms.pois.poi_form.POIForm(**kwargs: Any)

Bases: CustomModelForm

Form for creating and modifying POI objects

Form fields:

• address: Street and house number (CharField)

• postcode: Postal code (CharField)

• city: City (CharField)

• country: Country (CharField)

• latitude: Latitude (FloatField)

• longitude: Longitude (FloatField)

• location_on_map: Show this location on map (BooleanField)

• icon: Icon (ModelChoiceField)

• website: Website (URLField)

• email: Email address (EmailField)

• phone_number: Phone number (CharField)

• category: Category (ModelChoiceField)

• opening_hours: Opening hours (JSONField)

• temporarily_closed: Temporarily closed (BooleanField)

• appointment_url: Appointment link (URLField)

• organization: Organization (ModelChoiceField)

• barrier_free: Barrier free (NullBooleanField)

Parameters:

kwargs (Any) –

__init__(**kwargs: Any) → None

Initialize placeholder model form

Parameters:

**kwargs (Any) – The supplied keyword arguments

Raises:

TypeError – If form is instantiated directly without an inheriting subclass

Return type:

None

add_error(field, error)

Update the content of self._errors.

The field argument is the name of the field to which the errors should be added. If it’s None, treat the errors as NON_FIELD_ERRORS.

The error argument can be a single error, a list of errors, or a dictionary that maps field names to lists of errors. An “error” can be either a simple string or an instance of ValidationError with its message attribute set and a “list or dictionary” can be an actual list or dict or an instance of ValidationError with its error_list or error_dict attribute set.

If error is a dictionary, the field argument must be None and errors will be added to the fields that correspond to the keys of the dictionary.

add_error_messages(request: HttpRequest) → None

This function accepts the current request and adds the form’s error messages to the message queue of django.contrib.messages.

Parameters:

request (HttpRequest) – The current request submitting the form

Return type:

None

add_initial_prefix(field_name)

Add an ‘initial’ prefix for checking dynamic initial values.

add_prefix(field_name)

Return the field name with a prefix appended, if this Form has a prefix set.

Subclasses may wish to override.

as_div()

Render as <div> elements.

as_p()

Render as <p> elements.

as_table()

Render as <tr> elements excluding the surrounding <table> tag.

as_ul()

Render as <li> elements excluding the surrounding <ul> tag.

changed_data

clean() → dict[str, Any]

Validate form fields which depend on each other, see django.forms.Form.clean()

Returns:

The cleaned form data

Return type:

dict[str, Any]

clean_opening_hours() → list[dict[str, Any]]

Validate the opening hours field (see Overriding the clean() method).

Returns:

The valid opening hours

Return type:

list[dict[str, Any]]

default_renderer = None

property errors

Return an ErrorDict for the data provided for the form.

field_order = None

full_clean()

Clean all of self.data and populate self._errors and self.cleaned_data.

get_context()

get_error_messages() → list[dict[str, str]]

Return all error messages of this form and append labels to field-errors

Returns:

The errors of this form

Return type:

list[dict[str, str]]

get_initial_for_field(field, field_name)

Return initial data for field on form. Use initial data from the form or the field, in that order. Evaluate callable values.

has_changed()

Return True if data differs from initial.

has_error(field, code=None)

hidden_fields()

Return a list of all the BoundField objects that are hidden fields. Useful for manual form layout in templates.

is_multipart()

Return True if the form needs to be multipart-encoded, i.e. it has FileInput, or False otherwise.

is_valid()

Return True if the form has no errors, or False otherwise.

property media

Return all media required to render the widgets on this form.

nominatim_distance_delta = 0

The distance in km between the manually entered coordinates and the coordinates returned from Nominatim

non_field_errors()

Return an ErrorList of errors that aren’t associated with a particular field – i.e., from Form.clean(). Return an empty ErrorList if there are none.

order_fields(field_order)

Rearrange the fields according to field_order.

field_order is a list of field names specifying the order. Append fields not included in the list in the default order for backward compatibility with subclasses not overriding field_order. If field_order is None, keep all fields in the order defined in the class. Ignore unknown fields in field_order to allow disabling fields in form subclasses without redefining ordering.

prefix = None

render(template_name=None, context=None, renderer=None)

save(commit: bool = True) → Any

This method extends the default save()-method of the base ModelForm to provide debug logging

Parameters:

commit (bool) – Whether or not the changes should be written to the database

Returns:

The saved object returned by The save() method

Return type:

Any

property template_name

template_name_div = 'django/forms/div.html'

template_name_label = 'django/forms/label.html'

template_name_p = 'django/forms/p.html'

template_name_table = 'django/forms/table.html'

template_name_ul = 'django/forms/ul.html'

use_required_attribute = True

validate_unique()

Call the instance’s validate_unique() method and update the form’s validation errors if any were raised.

visible_fields()

Return a list of BoundField objects that aren’t hidden fields. The opposite of the hidden_fields() method.

POI Translation Form

class integreat_cms.cms.forms.pois.poi_translation_form.POITranslationForm(**kwargs: Any)

Bases: MachineTranslationForm

Form for creating and modifying POI translation objects

Form fields:

• title: Name of the location (CharField)

• status: Status (TypedChoiceField)

• content: Description (CharField)

• minor_edit: Minor edit (BooleanField)

• automatic_translation: Automatic translation (BooleanField)

• machine_translated: Machine translated (BooleanField)

• meta_description: Meta description (CharField)

• slug: Link to the location (SlugField)

• mt_translations_to_create: Create new translations: (ModelMultipleChoiceField)

• mt_translations_to_update: Update existing translations: (ModelMultipleChoiceField)

Parameters:

kwargs (Any) –

__init__(**kwargs: Any) → None

Initialize POI translation form

Parameters:

**kwargs (Any) – The supplied keyword arguments

Return type:

None

add_error(field, error)

Update the content of self._errors.

The field argument is the name of the field to which the errors should be added. If it’s None, treat the errors as NON_FIELD_ERRORS.

The error argument can be a single error, a list of errors, or a dictionary that maps field names to lists of errors. An “error” can be either a simple string or an instance of ValidationError with its message attribute set and a “list or dictionary” can be an actual list or dict or an instance of ValidationError with its error_list or error_dict attribute set.

If error is a dictionary, the field argument must be None and errors will be added to the fields that correspond to the keys of the dictionary.

add_error_messages(request: HttpRequest) → None

This function accepts the current request and adds the form’s error messages to the message queue of django.contrib.messages.

Parameters:

request (HttpRequest) – The current request submitting the form

Return type:

None

add_initial_prefix(field_name)

Add an ‘initial’ prefix for checking dynamic initial values.

add_prefix(field_name)

Return the field name with a prefix appended, if this Form has a prefix set.

Subclasses may wish to override.

add_success_message(request: HttpRequest) → None

This adds a success message for a translation form. Requires the attributes “title”, “status” and “foreign_object” on the form instance.

Parameters:

request (HttpRequest) – The current request submitting the translation form

Return type:

None

as_div()

Render as <div> elements.

as_p()

Render as <p> elements.

as_table()

Render as <tr> elements excluding the surrounding <table> tag.

as_ul()

Render as <li> elements excluding the surrounding <ul> tag.

changed_data

clean() → dict[str, Any]

Validate form fields which depend on each other, see django.forms.Form.clean()

Returns:

The cleaned form data

Return type:

dict[str, Any]

clean_content() → str

Validate the content field (see Overriding the clean() method) and applies changes to <img>- and <a>-Tags to match the guidelines.

Raises:

ValidationError – When a heading 1 (<h1>) is used in the text content

Returns:

The valid content

Return type:

str

clean_slug() → str

Validate the slug field (see Overriding the clean() method)

Returns:

A unique slug based on the input value

Return type:

str

default_renderer = None

property errors

Return an ErrorDict for the data provided for the form.

field_order = None

full_clean()

Clean all of self.data and populate self._errors and self.cleaned_data.

get_context()

get_error_messages() → list[dict[str, str]]

Return all error messages of this form and append labels to field-errors

Returns:

The errors of this form

Return type:

list[dict[str, str]]

get_initial_for_field(field, field_name)

Return initial data for field on form. Use initial data from the form or the field, in that order. Evaluate callable values.

has_changed()

Return True if data differs from initial.

has_error(field, code=None)

hidden_fields()

Return a list of all the BoundField objects that are hidden fields. Useful for manual form layout in templates.

is_multipart()

Return True if the form needs to be multipart-encoded, i.e. it has FileInput, or False otherwise.

is_valid()

Return True if the form has no errors, or False otherwise.

property media

Return all media required to render the widgets on this form.

mt_form_is_enabled() → NS_NodeQuerySet

Helper method to decide if this form should be shown, or if it should be hidden for the current language due to a lack of MT-compatible child language nodes

Returns:

Whether this form is enabled

Return type:

NS_NodeQuerySet

non_field_errors()

Return an ErrorList of errors that aren’t associated with a particular field – i.e., from Form.clean(). Return an empty ErrorList if there are none.

order_fields(field_order)

Rearrange the fields according to field_order.

field_order is a list of field names specifying the order. Append fields not included in the list in the default order for backward compatibility with subclasses not overriding field_order. If field_order is None, keep all fields in the order defined in the class. Ignore unknown fields in field_order to allow disabling fields in form subclasses without redefining ordering.

prefix = None

render(template_name=None, context=None, renderer=None)

save(commit: bool = True, foreign_form_changed: bool = False)

Create machine translations and save them to the database

Parameters:

• commit (bool) – Whether or not the changes should be written to the database

• foreign_form_changed (bool) – Whether or not the foreign form of this translation form was changed

Returns:

The saved content translation object

Return type:

EventTranslation | (PageTranslation | POITranslation)

property template_name

template_name_div = 'django/forms/div.html'

template_name_label = 'django/forms/label.html'

template_name_p = 'django/forms/p.html'

template_name_table = 'django/forms/table.html'

template_name_ul = 'django/forms/ul.html'

use_required_attribute = True

validate_unique()

Call the instance’s validate_unique() method and update the form’s validation errors if any were raised.

visible_fields()

Return a list of BoundField objects that aren’t hidden fields. The opposite of the hidden_fields() method.