POIs
Forms for creating and modifying POI and POI translation objects
POI Form
- class integreat_cms.cms.forms.pois.poi_form.POIForm(**kwargs: Any)[source]
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 [source]
Initialize page form
- Parameters:
**kwargs (Any) – The supplied keyword arguments
- Return type:
None
- add_error(field, error)[source]
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 [source]
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)[source]
Add an ‘initial’ prefix for checking dynamic initial values.
- add_prefix(field_name)[source]
Return the field name with a prefix appended, if this Form has a prefix set.
Subclasses may wish to override.
- clean() dict[str, Any] [source]
Validate form fields which depend on each other, see
django.forms.Form.clean()
- clean_opening_hours() list[dict[str, Any]] [source]
Validate the opening hours field (see Overriding the clean() method).
- get_error_messages() list[dict[str, str]] [source]
Return all error messages of this form and append labels to field-errors
- get_initial_for_field(field, field_name)[source]
Return initial data for field on form. Use initial data from the form or the field, in that order. Evaluate callable values.
Return a list of all the BoundField objects that are hidden fields. Useful for manual form layout in templates.
- is_multipart()[source]
Return True if the form needs to be multipart-encoded, i.e. it has FileInput, or False otherwise.
- nominatim_distance_delta = 0[source]
The distance in km between the manually entered coordinates and the coordinates returned from Nominatim
- non_field_errors()[source]
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)[source]
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.
- save(commit: bool = True) Any [source]
This method extends the default
save()
-method of the baseModelForm
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
POI Translation Form
- class integreat_cms.cms.forms.pois.poi_translation_form.POITranslationForm(**kwargs: Any)[source]
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 [source]
Initialize POI translation form
- Parameters:
**kwargs (Any) – The supplied keyword arguments
- Return type:
None
- add_error(field, error)[source]
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 [source]
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)[source]
Add an ‘initial’ prefix for checking dynamic initial values.
- add_prefix(field_name)[source]
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 [source]
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
- clean() dict[str, Any] [source]
Validate form fields which depend on each other, see
django.forms.Form.clean()
- clean_content() str [source]
Validate the content field (see Overriding the clean() method) and applies changes to any element to match the guidelines.
- Raises:
ValidationError – When a heading 1 (
<h1>
) is used in the text content- Returns:
The valid content
- Return type:
- clean_slug() str [source]
Validate the slug field (see Overriding the clean() method)
- Returns:
A unique slug based on the input value
- Return type:
- get_error_messages() list[dict[str, str]] [source]
Return all error messages of this form and append labels to field-errors
- get_initial_for_field(field, field_name)[source]
Return initial data for field on form. Use initial data from the form or the field, in that order. Evaluate callable values.
Return a list of all the BoundField objects that are hidden fields. Useful for manual form layout in templates.
- is_multipart()[source]
Return True if the form needs to be multipart-encoded, i.e. it has FileInput, or False otherwise.
- mt_form_is_enabled() NS_NodeQuerySet [source]
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()[source]
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)[source]
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.
- save(commit: bool = True, foreign_form_changed: bool = False)[source]
Create machine translations and save them to the database
- Parameters:
- Returns:
The saved content translation object
- Return type: