POIs

This package contains both data models related to points of interest (POIs): POI and POITranslation. POIs can be used to store information which is relevant for one specific location, e.g. a place where local authorities offer a public service. They can also be used as location for an Event.

POI

class integreat_cms.cms.models.pois.poi.POI(*args, **kwargs)

Bases: AbstractContentModel

Data model representing a point of interest (POI). It contains all relevant data about its exact position, including coordinates.

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

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

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

• temporarily_closed (BooleanField) – Temporarily closed. Whether or not the location 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 location can be made.

• opening_hours (JSONField) – Opening hours

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

Relationship fields:

Parameters:

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

• icon (ForeignKey to MediaFile) – Icon. The best results are achieved with images in 16:9 aspect ratio. (related name: pois)

• category (ForeignKey to POICategory) – Category (related name: pois)

• organization (ForeignKey to Organization) – Organization. Specify which organization operates this location. (related name: pois)

Reverse relationships:

Parameters:

• translations (Reverse ForeignKey from POITranslation) – All translations of this location (related name of poi)

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

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

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

archive() → bool

Archives the poi and removes all links of this poi from the linkchecker

Return type:

bool

can_be_deleted() → tuple[bool, str | None]

Checks if poi can be deleted

Return type:

tuple[bool, str | None]

property fallback_translations_enabled: bool

Whether translations should be returned in the default language if they do not exist

Returns:

Whether fallback translations are enabled

static get_translation_model() → ModelBase

Returns the translation model of this content model

Returns:

The class of translations

Return type:

ModelBase

property is_currently_used: bool

Returns:

whether this poi is used by a contact or an upcoming event

property is_used: bool

Returns:

whether this poi is used by another model

map_url

Returns:

the link to the POI of the default (public) translation

property referring_contacts_exist: bool

return: whether there are contact objects referring the POI. If the contact module is disabled in the region, it’s always False

restore() → None

Restores the poi and adds all links of this poi back

Return type:

None

short_address

Returns:

one-line representation of this POI’s address

POI Translation

class integreat_cms.cms.models.pois.poi_translation.POITranslation(*args, **kwargs)

Bases: AbstractContentTranslation

Data model representing a POI translation

Parameters:

• id (BigAutoField) – Primary key: ID

• title (TruncatingCharField) – Name of the location

• slug (SlugField) – Link to the location. 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.

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

Relationship fields:

Parameters:

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

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

• poi (ForeignKey to POI) – Location (related name: translations)

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

Reverse relationships:

Parameters:

feedback (Reverse ForeignKey from POIFeedback) – All feedback of this location translation (related name of poi_translation)

exception DoesNotExist

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

backend_edit_link

This function returns the absolute url to the editor for this translation

Returns:

The url

clean() → None

Checks if the slug is unique and generates when necessary

Return type:

None

static default_icon() → str | None

Returns:

The default icon that should be used for this content translation type, or None for no icon

Return type:

str | None

static foreign_field() → Literal['poi']

Returns the string “poi” which ist the field name of the reference to the poi which the translation belongs to

Returns:

The foreign field name

Return type:

Literal[‘poi’]

foreign_object

This property is an alias of the POI foreign key and is needed to generalize the slug_utils for all content types

Returns:

The POI to which the translation belongs

map_url

Returns:

the link to the POI on the Integreat map (if it exists), to google maps otherwise

save(*args: Any, **kwargs: Any) → None

Override save to perform unique slug validation

Parameters:

• args (Any)

• kwargs (Any)

Return type:

None

classmethod search(region: Region, language_slug: str, query: str) → QuerySet

Searches for all content translations which match the given query in their title or slug. :param region: The current region :param language_slug: The language slug :param query: The query string used for filtering the content translations :return: A query for all matching objects

Parameters:

• region (Region)

• language_slug (str)

• query (str)

Return type:

QuerySet

status

Type: CharField

Status

Choices:

• DRAFT

• REVIEW

• PUBLIC

• AUTO_SAVE

Manage choices in status

classmethod suggest(**kwargs: Any) → list[dict[str, Any]]

Suggests keywords for POI search

Parameters:

**kwargs (Any) – The supplied kwargs

Returns:

Json object containing all matching elements, of shape {title: str, url: str, type: str}

Return type:

list[dict[str, Any]]

url_infix

Generates the infix of the url of the poi translation object

For information about the components of such an url, see get_absolute_url()

Returns:

The infix of the url