POI Categories

This package contains page-related data models:

POI Category

class integreat_cms.cms.models.poi_categories.poi_category.POICategory(*args, **kwargs)[source]

Bases: AbstractBaseModel

Data model representing a POI category.

Parameters:

  • id (BigAutoField) – Primary key: ID

  • icon (CharField) – Icon. Select an icon for this category

  • color (CharField) – Color. Select a color for map pins with this category

Reverse relationships:

Parameters:
exception DoesNotExist[source]

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)[source]
add_note()[source]

Exception.add_note(note) – add a note to the exception

args[source]
silent_variable_failure = True[source]
with_traceback()[source]

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned[source]

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)[source]
add_note()[source]

Exception.add_note(note) – add a note to the exception

args[source]
with_traceback()[source]

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)[source]
async adelete(using=None, keep_parents=False)[source]
async arefresh_from_db(using=None, fields=None)[source]
async asave(force_insert=False, force_update=False, using=None, update_fields=None)[source]
backend_translation[source]

This function returns the translation of this content object in the current backend language.

Returns:

The backend translation of a content object

best_translation[source]

This function returns the translation of this category in the current backend language and if it doesn’t exist, it provides a fallback to the first translation.

Returns:

The “best” translation of this category for displaying in the backend

classmethod check(**kwargs)[source]
clean()[source]

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)[source]

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

color[source]

Type: CharField

Color. Select a color for map pins with this category

Choices:

  • #3700D2

  • #2E98FB

  • #1DC6C6

  • #3F8F01

  • #07DC03

  • #F2DA04

  • #C38E03

  • #FF7C32

  • #FF3333

  • #EE36DC

  • and 2 more

date_error_message(lookup_type, field_name, unique_for)[source]
delete(using=None, keep_parents=False)[source]
classmethod from_db(db, field_names, values)[source]
full_clean(exclude=None, validate_unique=True, validate_constraints=True)[source]

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_color_display(*, field=<django.db.models.CharField: color>)[source]

Shows the label of the color. See get_FOO_display() for more information.

get_constraints()[source]
get_deferred_fields()[source]

Return a set containing names of deferred fields for this instance.

get_icon_display(*, field=<django.db.models.CharField: icon>)[source]

Shows the label of the icon. See get_FOO_display() for more information.

classmethod get_model_name_plural() → str[source]

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_repr() → str[source]

This overwrites the default Django __repr__() method which would return <POI Category: POICategory object (id, category name)>. It is used for logging.

Returns:

The canonical string representation of the category

Return type:

str

get_translation(language_slug: str) → POICategoryTranslation | None[source]

Get the translation of this category in a given language

Parameters:

language_slug (str) – language in which the poi category is to be shown

Returns:

translation of the poi category in the language if no translation is saved for the language, the category name of the POICategory

Return type:

POICategoryTranslation | None

icon[source]

Type: CharField

Icon. Select an icon for this category

Choices:

  • advice

  • culture

  • daily_routine

  • education

  • finance

  • gastronomy

  • health

  • house

  • leisure

  • media

  • and 11 more

id[source]

Type: BigAutoField

Primary key: ID

name[source]

This function returns the name of the category in the “best” translation

Returns:

The name of the category

objects = <django.db.models.Manager object>[source]
property pk[source]
pois[source]

Type: Reverse ForeignKey from POI

All pois of this location category (related name of category)

prefetched_translations_by_language_slug[source]

This method returns a mapping from language slugs to their public translations of this object

Returns:

The object translation in the requested Language or None if no translation exists

prepare_database_save(field)[source]
refresh_from_db(using=None, fields=None)[source]

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

save(force_insert=False, force_update=False, using=None, update_fields=None)[source]

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)[source]

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)[source]

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

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

Suggests keywords for searching the objects of the class

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

To be implemented in the inheriting model

translations[source]

Type: Reverse ForeignKey from POICategoryTranslation

All translations of this location category (related name of category)

unique_error_message(model_class, unique_check)[source]
validate_constraints(exclude=None)[source]
validate_unique(exclude=None)[source]

Check unique constraints on the model and raise ValidationError if any failed.

POI Category Translation

class integreat_cms.cms.models.poi_categories.poi_category_translation.POICategoryTranslation(*args, **kwargs)[source]

Bases: AbstractBaseModel

Data model representing a POI category translation.

Parameters:

  • id (BigAutoField) – Primary key: ID

  • name (CharField) – Category name. The name of the POI category.

Relationship fields:

Parameters:
exception DoesNotExist[source]

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)[source]
add_note()[source]

Exception.add_note(note) – add a note to the exception

args[source]
silent_variable_failure = True[source]
with_traceback()[source]

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned[source]

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)[source]
add_note()[source]

Exception.add_note(note) – add a note to the exception

args[source]
with_traceback()[source]

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)[source]
async adelete(using=None, keep_parents=False)[source]
async arefresh_from_db(using=None, fields=None)[source]
async asave(force_insert=False, force_update=False, using=None, update_fields=None)[source]
category[source]

Type: ForeignKey to POICategory

Category (related name: translations)

category_id[source]

Internal field, use category instead.

classmethod check(**kwargs)[source]
clean()[source]

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)[source]

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

date_error_message(lookup_type, field_name, unique_for)[source]
delete(using=None, keep_parents=False)[source]
classmethod from_db(db, field_names, values)[source]
full_clean(exclude=None, validate_unique=True, validate_constraints=True)[source]

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()[source]
get_deferred_fields()[source]

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str[source]

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_repr() → str[source]

This overwrites the default Django __repr__() method which would return <POI CategoryTranslation: POICategoryTranslation object (id, category name)>. It is used for logging.

Returns:

The canonical string representation of the category translation

Return type:

str

id[source]

Type: BigAutoField

Primary key: ID

language[source]

Type: ForeignKey to Language

Language (related name: poi_category_translations)

language_id[source]

Internal field, use language instead.

name[source]

Type: CharField

Category name. The name of the POI category.

objects = <django.db.models.Manager object>[source]
property pk[source]
prepare_database_save(field)[source]
refresh_from_db(using=None, fields=None)[source]

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

save(force_insert=False, force_update=False, using=None, update_fields=None)[source]

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)[source]

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)[source]

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

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

Suggests keywords for searching the objects of the class

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

To be implemented in the inheriting model

unique_error_message(model_class, unique_check)[source]
validate_constraints(exclude=None)[source]
validate_unique(exclude=None)[source]

Check unique constraints on the model and raise ValidationError if any failed.