Pages
This package contains page-related data models:
Page
andPageTranslation
Abstract Base Page
- class integreat_cms.cms.models.pages.abstract_base_page.AbstractBasePage(*args, **kwargs)[source]
Bases:
AbstractContentModel
Abstract base class for page and imprint page models.
- Parameters:
created_date (DateTimeField) – Creation date
explicitly_archived (BooleanField) – Explicitly archived. Whether or not the page is explicitly archived
Relationship fields:
- Parameters:
region (
ForeignKey
toRegion
) – Region
- archived[source]
This is an alias of
explicitly_archived
. Used for hierarchical pages to implement a more complex notion of explicitly and implicitly archived pages (seearchived()
).- Returns:
Whether or not this page is archived
- available_translations() Iterator[Any] [source]
This method returns an iterator over all available translations, respecting the fallback_translations_enabled setting.
- Returns:
An iterator over all translations
- Return type:
Iterator[Any]
- backend_edit_link[source]
This function returns the absolute url to the edit form of this region
- Returns:
The url
- 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 content object in the current backend language and if it doesn’t exist, it provides a fallback to the translation in the region’s default language.
- Returns:
The “best” translation of a content object for displaying in the backend
- 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.
- created_date[source]
Type:
DateTimeField
Creation date
- default_public_translation[source]
This function returns the public translation of this content object in the region’s default language.
- Returns:
The default translation of a content object
- default_translation[source]
This function returns the translation of this content object in the region’s default language. Since a content object can only be created by creating a translation in the default language, this is guaranteed to return a object translation (Exception: When the default language tree node is changed to another language after the page has been created, the default translation might not exist).
- Returns:
The default translation of a content object
- property edit_lock_key: tuple[str | int | None, str][source]
This property returns the key that is used to lock this specific content object
- Returns:
A tuple of the id of this object and the classname
- explicitly_archived[source]
Type:
BooleanField
Explicitly archived. Whether or not the page is explicitly archived
- property fallback_translations_enabled: bool[source]
Whether translations should be returned in the default language if they do not exist
- Returns:
Whether fallback translations are enabled
- 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_locking_user() Any | None [source]
This method returns the user that is currently locking this content object.
- Returns:
The user
- Return type:
Any | None
- get_major_public_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest major public translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_major_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest major translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- classmethod get_model_name_plural() str [source]
Get the plural representation of this model name
- Returns:
The plural model name
- Return type:
- get_next_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=True, **kwargs)[source]
Finds next instance based on
created_date
. Seeget_next_by_FOO()
for more information.
- get_prefetched_translations_by_language_slug(attr: str = 'prefetched_translations', **filters: Any) dict[str, AbstractContentTranslation] [source]
This method returns a mapping from language slugs to their latest translations of this object
- Parameters:
attr (str) – Which attribute should be tried to get the prefetched translations [optional, defaults to
"prefetched_translations"
]**filters (Any) – Additional filters to be applied on the translations (e.g. by status)
- Returns:
The prefetched translations by language slug
- Return type:
- get_previous_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=False, **kwargs)[source]
Finds previous instance based on
created_date
. Seeget_previous_by_FOO()
for more information.
- get_public_or_draft_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest public or draft translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_public_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest public translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_repr() str [source]
This overwrites the default Django
__repr__()
method which would return<AbstractContentModel: AbstractContentModel object (id)>
. It is used for logging.- Returns:
The canonical string representation of the content object
- Return type:
- get_translation(language_slug: str) AbstractContentTranslation | None [source]
This function uses the reverse foreign key
self.translations
to get all translations ofself
and filters them to the requestedLanguage
slug.- Parameters:
- Returns:
The translation in the requested
Language
orNone
if no translation exists- Return type:
AbstractContentTranslation | None
- get_translation_state(language_slug: str) str [source]
This function returns the current state of a translation in the given language.
- hix_ignore: bool = False[source]
Whether the HIX value is ignored (this is
False
by default if not overwritten by a submodel)
- invalidate_cached_translations() None [source]
Delete all cached translations and query them from the database again when they are accessed next time.
This is helpful when new translations have been created and the content model should be reused.
- Return type:
None
- languages[source]
This property returns a list of all
Language
objects, to which a translation exists.- Returns:
The existing languages of this content object
- objects = <django.db.models.manager.ManagerFromContentQuerySet object>[source]
Django manager to access the ORM Use
AbstractBasePage.objects.all()
to fetch all objects.Custom model manager for content objects
- prefetched_major_public_translations_by_language_slug[source]
This method returns a mapping from language slugs to their major public translations of this object
- prefetched_major_translations_by_language_slug[source]
This method returns a mapping from language slugs to their major translations of this object
- prefetched_public_or_draft_translations_by_language_slug[source]
This method returns a mapping from language slugs to their public translations of this object
- prefetched_public_translations_by_language_slug[source]
This method returns a mapping from language slugs to their public translations of this object
- prefetched_translations_by_language_slug[source]
This method returns a mapping from language slugs to their latest translations of this object
- Returns:
The prefetched translations by language slug
- public_languages[source]
This property returns a list of all
Language
objects, to which a public translation exists and which are visible in this region.- Returns:
The existing languages of this content object
- 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.
- region[source]
Type:
ForeignKey
toRegion
Region
- 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.
Abstract Base Page Translation
- class integreat_cms.cms.models.pages.abstract_base_page_translation.AbstractBasePageTranslation(*args, **kwargs)[source]
Bases:
AbstractContentTranslation
Data model representing a page or imprint page translation
- Parameters:
title (TruncatingCharField) – Title
slug (SlugField) – Link. 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) – Content
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.
Relationship fields:
- Parameters:
language (
ForeignKey
toLanguage
) – Languagecreator (
ForeignKey
toUser
) – Creator
- all_versions[source]
This property returns all versions of this translation’s page in its language
- Returns:
All versions of this translation
- automatic_translation[source]
Type:
BooleanField
Automatic translation. Tick if updating this content should automatically refresh or create its translations.
- available_languages_dict[source]
This property checks in which
Language
the content is translated apart fromself.language
It only returns languages which have a public translation, so drafts are not included here. The returned dict has the following format:{ available_translation.language.slug: { 'id': available_translation.id, 'url': available_translation.permalink 'path': available_translation.path }, ... }
- Returns:
A dictionary containing the available languages of a content translation
- backend_edit_link[source]
Generates the url of the edit page for the content
To be implemented in the inheriting model
- base_link[source]
Generates the base link which is the whole url without slug
For information about the components of such an url, see
get_absolute_url()
- Returns:
the base link of the content
- 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.
- cleanup_autosaves() None [source]
Delete all
AUTO_SAVE
translations older than the second last manual save and renumber all affected versions to be continuous.- Return type:
None
- create_new_version_copy(user: User | None = None) AbstractContentTranslation [source]
Create a new version by copying
- Parameters:
user (User | None)
- Return type:
- creator[source]
Type:
ForeignKey
toUser
Creator
- currently_in_translation[source]
Type:
BooleanField
Currently in translation. Flag to indicate a translation is being updated by an external translator
- static default_icon() str | None [source]
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['page'] [source]
Returns the string “page” which ist the field name of the reference to the page which the translation belongs to
- Returns:
The foreign field name
- Return type:
Literal[‘page’]
- foreign_object[source]
This property is an alias of the page foreign key and is needed to generalize the
slug_utils
for all content types- Returns:
The page to which the translation belongs
- 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.
- full_url[source]
This property returns the full url of this content translation object
- Returns:
The full url
- get_absolute_url() str [source]
Generates the absolute url of the content translation object
Here is an example for demonstrating the components of a page url:
https://integreat.app/augsburg/en/welcome/city-map/attractions/ |-------------------------------------------------------------| full_url |----------------------------------------| get_absolute_url() |-------------------------------------------------| base_link |----------------------------| url_prefix |----------------| url_infix |-----------| slug
Here is an example for demonstrating the components of an event url:
https://integreat.app/augsburg/en/events/test-event/ |--------------------------------------------------| full_url |-----------------------------| get_absolute_url() |---------------------------------------| base_link |------------------| url_prefix |------| url_infix |----------| slug
- Returns:
The absolute url
- Return type:
- get_all_used_slugs() Iterable[str] [source]
- Returns:
All slugs that have been used by at least on version of this translation
- Return type:
Iterable[str]
- classmethod get_model_name_plural() str [source]
Get the plural representation of this model name
- Returns:
The plural model name
- Return type:
- get_next_by_last_updated(*, field=<django.db.models.DateTimeField: last_updated>, is_next=True, **kwargs)[source]
Finds next instance based on
last_updated
. Seeget_next_by_FOO()
for more information.
- get_previous_by_last_updated(*, field=<django.db.models.DateTimeField: last_updated>, is_next=False, **kwargs)[source]
Finds previous instance based on
last_updated
. Seeget_previous_by_FOO()
for more information.
- get_repr() str [source]
This overwrites the default Django
__repr__()
method. It is used for logging.- Returns:
The canonical string representation of the content translation
- Return type:
- get_status_display(*, field=<django.db.models.CharField: status>)[source]
Shows the label of the
status
. Seeget_FOO_display()
for more information.
- hix_enabled[source]
This function returns whether the HIX API is enabled for this instance
- Returns:
Whether HIX is enabled
- hix_ignore[source]
Whether this translation is ignored for HIX calculation
- Returns:
Wether the HIX value is ignored
- hix_sufficient_for_mt[source]
Whether this translation has a sufficient HIX value for machine translations. If it is
None
, machine translations are allowed by default.- Returns:
Whether the HIX value is sufficient for MT
- is_outdated[source]
This property checks whether a translation is outdated and thus needs a new revision of the content. This happens, when the source translation is updated and the update is no minor_edit.
If the translation is currently being translated, it is considered not outdated.
If the translation’s language is the region’s default language, it is defined to be never outdated.
If the translation’s source translation is already outdated, then the translation itself also is.
If neither the translation nor its source translation have a latest major public translation, it is defined as not outdated.
If neither the translation nor its source translation have a latest major public translation, it is defined as not outdated.
Otherwise, the outdated flag is calculated by comparing the last_updated-field of the translation and its source translation.
- Returns:
Flag to indicate whether the translation is outdated
- is_up_to_date[source]
This property checks whether a translation is up to date. A translation is considered up to date when it is either explicitly set to up-to-date, or has been machine-translated.
- Returns:
Flag which indicates whether a translation is up to date
- language[source]
Type:
ForeignKey
toLanguage
Language
- last_updated[source]
Type:
DateTimeField
Modification date
- latest_version[source]
This property is a link to the most recent version of this translation.
- Returns:
The latest revision of the translation
- link_title[source]
This property returns the html that should be used as a title for a link to this translation
- Returns:
The link content
- machine_translated[source]
Type:
BooleanField
Machine translated. Flag to indicate whether a translations is machine translated
- major_public_source_translation[source]
This property returns the latest major public version of the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- major_public_version[source]
This property is a link to the most recent major public version of this translation. This is used when translations, which are derived from this translation, check whether they are up to date.
- Returns:
The latest major public revision of the translation
- major_source_translation[source]
This property returns the latest major version of the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- major_version[source]
This property is a link to the most recent major version of this translation. This is used when translations, which are derived from this translation, check whether they are up to date.
- Returns:
The latest major public revision of the translation
- minor_edit[source]
Type:
BooleanField
Minor edit. Tick if this change does not require an update of translations in other languages.
- path() str [source]
This method returns a human-readable path that should uniquely identify this object within a given region If this content object does not have a hierarchy, just str(obj) should suffice
- Returns:
The path
- Return type:
- public_or_draft_source_translation[source]
This property returns the public and draft translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- public_source_translation[source]
This property returns the public translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- public_version[source]
This property is a link to the most recent public version of this translation. If the translation itself is not public, this property can return a revision which is older than
self
.- Returns:
The latest public revision of the translation
- read_only: bool = False[source]
Whether this object is read-only and not meant to be stored to the database
- readable_title[source]
Get the title of a page translation including the title in the best translation
- Returns:
The readable title of the page translation
- 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.
- replace_urls(urls_to_replace: dict[str, str], user: User | None = None, commit: bool = True) None [source]
Function to replace links that are in the translation and match the given keyword search
- save(*args: Any, **kwargs: Any) None [source]
This overwrites the default Django
save()
method, to update the last_updated field on changes.- Parameters:
*args (Any) – The supplied arguments
**kwargs (Any) – The supplied kwargs
- Raises:
RuntimeError – When the object was locked for database writes
- Return type:
None
- 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.
- classmethod search(region: Region, language_slug: str, query: str) QuerySet [source]
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
- 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.
- short_url[source]
This property calculates the short url dynamically
To be implemented in the inheriting model
- sitemap_alternates[source]
This property returns the language alternatives of a content translation for the use in sitemaps. Similar to
available_languages_dict()
, but in a slightly different format.- Returns:
A list of dictionaries containing the alternative translations of a content translation
- slug[source]
Type:
SlugField
Link. String identifier without spaces and special characters. Unique per region and language. Leave blank to generate unique parameter from title.
- source_language[source]
This property returns the source language of this language in this
Region
’s language tree- Returns:
The source language of this translation
- source_translation[source]
This property returns the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- status[source]
Type:
CharField
Status
Choices:
DRAFT
REVIEW
PUBLIC
AUTO_SAVE
Manage choices in
status
- translation_state[source]
This function returns the current state of a translation in the given language.
- Returns:
A string describing the state of the translation, one of
CHOICES
- url_infix[source]
Generates the infix of the url of the content translation object
For information about the components of such an url, see
get_absolute_url()
To be implemented in the inheriting model
- url_prefix[source]
Generates the prefix of the url of the content translation object
For information about the components of such an url, see
get_absolute_url()
- Returns:
The prefix to the url
- validate_unique(exclude=None)[source]
Check unique constraints on the model and raise ValidationError if any failed.
- version[source]
Type:
PositiveIntegerField
Revision
Imprint Page
- class integreat_cms.cms.models.pages.imprint_page.ImprintPage(*args, **kwargs)[source]
Bases:
AbstractContentModel
Data model representing an imprint.
- Parameters:
id (BigAutoField) – Primary key: ID
created_date (DateTimeField) – Creation date
Relationship fields:
- Parameters:
region (
ForeignKey
toRegion
) – Region (related name:imprints
)
Reverse relationships:
- Parameters:
translations (Reverse
ForeignKey
fromImprintPageTranslation
) – All translations of this imprint (related name ofpage
)
- exception DoesNotExist[source]
Bases:
ObjectDoesNotExist
- exception MultipleObjectsReturned[source]
Bases:
MultipleObjectsReturned
- available_translations() Iterator[Any] [source]
This method returns an iterator over all available translations, respecting the fallback_translations_enabled setting.
- Returns:
An iterator over all translations
- Return type:
Iterator[Any]
- backend_edit_link[source]
This function returns the absolute url to the edit form of this region
- Returns:
The url
- 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 content object in the current backend language and if it doesn’t exist, it provides a fallback to the translation in the region’s default language.
- Returns:
The “best” translation of a content object for displaying in the backend
- 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.
- created_date[source]
Type:
DateTimeField
Creation date
- default_public_translation[source]
This function returns the public translation of this content object in the region’s default language.
- Returns:
The default translation of a content object
- default_translation[source]
This function returns the translation of this content object in the region’s default language. Since a content object can only be created by creating a translation in the default language, this is guaranteed to return a object translation (Exception: When the default language tree node is changed to another language after the page has been created, the default translation might not exist).
- Returns:
The default translation of a content object
- property edit_lock_key: tuple[int, str][source]
This property returns the key that is used to lock this specific content object This overwrites
edit_lock_key()
- Returns:
A tuple of the region slug and the classname
- fallback_translations_enabled: bool = True[source]
Whether translations should be returned in the default language if they do not exist
- 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_locking_user() Any | None [source]
This method returns the user that is currently locking this content object.
- Returns:
The user
- Return type:
Any | None
- get_major_public_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest major public translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_major_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest major translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- classmethod get_model_name_plural() str [source]
Get the plural representation of this model name
- Returns:
The plural model name
- Return type:
- get_next_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=True, **kwargs)[source]
Finds next instance based on
created_date
. Seeget_next_by_FOO()
for more information.
- get_prefetched_translations_by_language_slug(attr: str = 'prefetched_translations', **filters: Any) dict[str, AbstractContentTranslation] [source]
This method returns a mapping from language slugs to their latest translations of this object
- Parameters:
attr (str) – Which attribute should be tried to get the prefetched translations [optional, defaults to
"prefetched_translations"
]**filters (Any) – Additional filters to be applied on the translations (e.g. by status)
- Returns:
The prefetched translations by language slug
- Return type:
- get_previous_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=False, **kwargs)[source]
Finds previous instance based on
created_date
. Seeget_previous_by_FOO()
for more information.
- get_public_or_draft_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest public or draft translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_public_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest public translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_repr() str [source]
This overwrites the default Django
__repr__()
method which would return<AbstractContentModel: AbstractContentModel object (id)>
. It is used for logging.- Returns:
The canonical string representation of the content object
- Return type:
- get_translation(language_slug: str) AbstractContentTranslation | None [source]
This function uses the reverse foreign key
self.translations
to get all translations ofself
and filters them to the requestedLanguage
slug.- Parameters:
- Returns:
The translation in the requested
Language
orNone
if no translation exists- Return type:
AbstractContentTranslation | None
- static get_translation_model() ModelBase [source]
Returns the translation model of this content model
- Returns:
The class of translations
- Return type:
ModelBase
- get_translation_state(language_slug: str) str [source]
This function returns the current state of a translation in the given language.
- hix_ignore: bool = False[source]
Whether the HIX value is ignored (this is
False
by default if not overwritten by a submodel)
- id[source]
Type:
BigAutoField
Primary key: ID
- invalidate_cached_translations() None [source]
Delete all cached translations and query them from the database again when they are accessed next time.
This is helpful when new translations have been created and the content model should be reused.
- Return type:
None
- languages[source]
This property returns a list of all
Language
objects, to which a translation exists.- Returns:
The existing languages of this content object
- objects = <django.db.models.manager.ManagerFromContentQuerySet object>[source]
Django manager to access the ORM Use
ImprintPage.objects.all()
to fetch all objects.Custom model manager for content objects
- prefetched_major_public_translations_by_language_slug[source]
This method returns a mapping from language slugs to their major public translations of this object
- prefetched_major_translations_by_language_slug[source]
This method returns a mapping from language slugs to their major translations of this object
- prefetched_public_or_draft_translations_by_language_slug[source]
This method returns a mapping from language slugs to their public translations of this object
- prefetched_public_translations_by_language_slug[source]
This method returns a mapping from language slugs to their public translations of this object
- prefetched_translations_by_language_slug[source]
This method returns a mapping from language slugs to their latest translations of this object
- Returns:
The prefetched translations by language slug
- public_languages[source]
This property returns a list of all
Language
objects, to which a public translation exists and which are visible in this region.- Returns:
The existing languages of this content object
- 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.
- region[source]
Type:
ForeignKey
toRegion
Region (related name:
imprints
)
- 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.
- translation_states[source]
This property calculates all translations states of the object
- Returns:
A dictionary containing each language as key and the given translation state as value
- translations[source]
Type: Reverse
ForeignKey
fromImprintPageTranslation
All translations of this imprint (related name of
page
)
Imprint Page Translation
- class integreat_cms.cms.models.pages.imprint_page_translation.ImprintPageTranslation(*args, **kwargs)[source]
Bases:
AbstractBasePageTranslation
Data model representing a imprint translation
- Parameters:
id (BigAutoField) – Primary key: ID
title (TruncatingCharField) – Title
status (CharField) – Status
content (TextField) – Content
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.
Relationship fields:
- Parameters:
language (
ForeignKey
toLanguage
) – Language (related name:imprint_translations
)creator (
ForeignKey
toUser
) – Creator (related name:imprint_translations
)page (
ForeignKey
toImprintPage
) – Imprint (related name:translations
)links (
GenericRelation
toLink
) – Links (related name:imprint_translation
)
- exception DoesNotExist[source]
Bases:
ObjectDoesNotExist
- exception MultipleObjectsReturned[source]
Bases:
MultipleObjectsReturned
- all_versions[source]
This property returns all versions of this translation’s page in its language
- Returns:
All versions of this translation
- automatic_translation[source]
Type:
BooleanField
Automatic translation. Tick if updating this content should automatically refresh or create its translations.
- available_languages_dict[source]
This property checks in which
Language
the content is translated apart fromself.language
It only returns languages which have a public translation, so drafts are not included here. The returned dict has the following format:{ available_translation.language.slug: { 'id': available_translation.id, 'url': available_translation.permalink 'path': available_translation.path }, ... }
- Returns:
A dictionary containing the available languages of a content translation
- backend_edit_link[source]
This function returns the absolute url to the editor for this translation
- Returns:
The url
- base_link[source]
Generates the base link which is the whole url without slug
For information about the components of such an url, see
get_absolute_url()
- Returns:
the base link of the content
- 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.
- cleanup_autosaves() None [source]
Delete all
AUTO_SAVE
translations older than the second last manual save and renumber all affected versions to be continuous.- Return type:
None
- create_new_version_copy(user: User | None = None) AbstractContentTranslation [source]
Create a new version by copying
- Parameters:
user (User | None)
- Return type:
- creator[source]
Type:
ForeignKey
toUser
Creator (related name:
imprint_translations
)
- currently_in_translation[source]
Type:
BooleanField
Currently in translation. Flag to indicate a translation is being updated by an external translator
- static default_icon() str | None [source]
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['page'] [source]
Returns the string “page” which ist the field name of the reference to the page which the translation belongs to
- Returns:
The foreign field name
- Return type:
Literal[‘page’]
- foreign_object[source]
This property is an alias of the page foreign key and is needed to generalize the
slug_utils
for all content types- Returns:
The page to which the translation belongs
- 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.
- full_url[source]
This property returns the full url of this content translation object
- Returns:
The full url
- get_absolute_url() str [source]
Generates the absolute url of the content translation object
Here is an example for demonstrating the components of a page url:
https://integreat.app/augsburg/en/welcome/city-map/attractions/ |-------------------------------------------------------------| full_url |----------------------------------------| get_absolute_url() |-------------------------------------------------| base_link |----------------------------| url_prefix |----------------| url_infix |-----------| slug
Here is an example for demonstrating the components of an event url:
https://integreat.app/augsburg/en/events/test-event/ |--------------------------------------------------| full_url |-----------------------------| get_absolute_url() |---------------------------------------| base_link |------------------| url_prefix |------| url_infix |----------| slug
- Returns:
The absolute url
- Return type:
- classmethod get_model_name_plural() str [source]
Get the plural representation of this model name
- Returns:
The plural model name
- Return type:
- get_next_by_last_updated(*, field=<django.db.models.DateTimeField: last_updated>, is_next=True, **kwargs)[source]
Finds next instance based on
last_updated
. Seeget_next_by_FOO()
for more information.
- get_previous_by_last_updated(*, field=<django.db.models.DateTimeField: last_updated>, is_next=False, **kwargs)[source]
Finds previous instance based on
last_updated
. Seeget_previous_by_FOO()
for more information.
- get_repr() str [source]
This overwrites the default Django
__repr__()
method. It is used for logging.- Returns:
The canonical string representation of the content translation
- Return type:
- get_status_display(*, field=<django.db.models.CharField: status>)[source]
Shows the label of the
status
. Seeget_FOO_display()
for more information.
- hix_enabled[source]
This function returns whether the HIX API is enabled for this instance
- Returns:
Whether HIX is enabled
- hix_ignore[source]
Whether this translation is ignored for HIX calculation
- Returns:
Wether the HIX value is ignored
- hix_sufficient_for_mt[source]
Whether this translation has a sufficient HIX value for machine translations. If it is
None
, machine translations are allowed by default.- Returns:
Whether the HIX value is sufficient for MT
- id[source]
Type:
BigAutoField
Primary key: ID
- is_outdated[source]
This property checks whether a translation is outdated and thus needs a new revision of the content. This happens, when the source translation is updated and the update is no minor_edit.
If the translation is currently being translated, it is considered not outdated.
If the translation’s language is the region’s default language, it is defined to be never outdated.
If the translation’s source translation is already outdated, then the translation itself also is.
If neither the translation nor its source translation have a latest major public translation, it is defined as not outdated.
If neither the translation nor its source translation have a latest major public translation, it is defined as not outdated.
Otherwise, the outdated flag is calculated by comparing the last_updated-field of the translation and its source translation.
- Returns:
Flag to indicate whether the translation is outdated
- is_up_to_date[source]
This property checks whether a translation is up to date. A translation is considered up to date when it is either explicitly set to up-to-date, or has been machine-translated.
- Returns:
Flag which indicates whether a translation is up to date
- language[source]
Type:
ForeignKey
toLanguage
Language (related name:
imprint_translations
)
- last_updated[source]
Type:
DateTimeField
Modification date
- latest_version[source]
This property is a link to the most recent version of this translation.
- Returns:
The latest revision of the translation
- link_title[source]
This property returns the html that should be used as a title for a link to this translation
- Returns:
The link content
- links[source]
Type: Reverse
GenericRelation
fromImprintPageTranslation
All imprint translation of this link (related name of
links
)
- machine_translated[source]
Type:
BooleanField
Machine translated. Flag to indicate whether a translations is machine translated
- major_public_source_translation[source]
This property returns the latest major public version of the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- major_public_version[source]
This property is a link to the most recent major public version of this translation. This is used when translations, which are derived from this translation, check whether they are up to date.
- Returns:
The latest major public revision of the translation
- major_source_translation[source]
This property returns the latest major version of the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- major_version[source]
This property is a link to the most recent major version of this translation. This is used when translations, which are derived from this translation, check whether they are up to date.
- Returns:
The latest major public revision of the translation
- minor_edit[source]
Type:
BooleanField
Minor edit. Tick if this change does not require an update of translations in other languages.
- page[source]
Type:
ForeignKey
toImprintPage
Imprint (related name:
translations
)
- path() str [source]
This method returns a human-readable path that should uniquely identify this object within a given region If this content object does not have a hierarchy, just str(obj) should suffice
- Returns:
The path
- Return type:
- public_or_draft_source_translation[source]
This property returns the public and draft translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- public_source_translation[source]
This property returns the public translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- public_version[source]
This property is a link to the most recent public version of this translation. If the translation itself is not public, this property can return a revision which is older than
self
.- Returns:
The latest public revision of the translation
- read_only: bool = False[source]
Whether this object is read-only and not meant to be stored to the database
- readable_title[source]
Get the title of a page translation including the title in the best translation
- Returns:
The readable title of the page translation
- 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.
- replace_urls(urls_to_replace: dict[str, str], user: User | None = None, commit: bool = True) None [source]
Function to replace links that are in the translation and match the given keyword search
- save(*args: Any, **kwargs: Any) None [source]
This overwrites the default Django
save()
method, to update the last_updated field on changes.- Parameters:
*args (Any) – The supplied arguments
**kwargs (Any) – The supplied kwargs
- Raises:
RuntimeError – When the object was locked for database writes
- Return type:
None
- 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.
- classmethod search(region: Region, language_slug: str, query: str) QuerySet [source]
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
- 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.
- short_url[source]
This function returns the absolute short url to the imprint translation
- Returns:
The short url of an imprint translation
- sitemap_alternates[source]
This property returns the language alternatives of a content translation for the use in sitemaps. Similar to
available_languages_dict()
, but in a slightly different format.- Returns:
A list of dictionaries containing the alternative translations of a content translation
- property slug: str[source]
For compatibility with the other page translations, a slug property is useful.
- Returns:
pseudo slug for the imprint translation
- source_language[source]
This property returns the source language of this language in this
Region
’s language tree- Returns:
The source language of this translation
- source_translation[source]
This property returns the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- status[source]
Type:
CharField
Status
Choices:
DRAFT
REVIEW
PUBLIC
AUTO_SAVE
Manage choices in
status
- translation_state[source]
This function returns the current state of a translation in the given language.
- Returns:
A string describing the state of the translation, one of
CHOICES
- url_infix[source]
Generates the infix of the url of the imprint translation object
For information about the components of such an url, see
get_absolute_url()
- Returns:
The infix of the url
- url_prefix[source]
Generates the prefix of the url of the content translation object
For information about the components of such an url, see
get_absolute_url()
- Returns:
The prefix to the url
- validate_unique(exclude=None)[source]
Check unique constraints on the model and raise ValidationError if any failed.
- version[source]
Type:
PositiveIntegerField
Revision
Page
- class integreat_cms.cms.models.pages.page.Page(*args, **kwargs)[source]
Bases:
AbstractTreeNode
,AbstractBasePage
Data model representing a page.
- Parameters:
id (BigAutoField) – Primary key: ID
created_date (DateTimeField) – Creation date
lft (PositiveIntegerField) – Lft
rgt (PositiveIntegerField) – Rgt
tree_id (PositiveIntegerField) – Tree id
depth (PositiveIntegerField) – Depth
explicitly_archived (BooleanField) – Explicitly archived. Whether or not the page is explicitly archived
mirrored_page_first (BooleanField) – Position of mirrored page. If a mirrored page is set, this field determines whether the live content is embedded before the content of this page or after.
api_token (CharField) – API access token. API token to allow writing content to translations.
hix_ignore (BooleanField) – Ignore HIX value. This allows to ignore HIX value for this specific page.
Relationship fields:
- Parameters:
parent (
ForeignKey
toPage
) – Parent page (related name:children
)region (
ForeignKey
toRegion
) – Region (related name:pages
)icon (
ForeignKey
toMediaFile
) – Icon (related name:pages
)mirrored_page (
ForeignKey
toPage
) – Mirrored page. If the page embeds live content from another page, it is referenced here. (related name:mirroring_pages
)organization (
ForeignKey
toOrganization
) – Responsible organization. This allows all members of the organization to edit and publish this page. (related name:pages
)authors (
ManyToManyField
toUser
) – Authors. A list of users who have the permission to edit this specific page. Only has effect if these users do not have the permission to edit pages anyway. (related name:editable_pages
)editors (
ManyToManyField
toUser
) – Editors. A list of users who have the permission to publish this specific page. Only has effect if these users do not have the permission to publish pages anyway. (related name:publishable_pages
)embedded_offers (
ManyToManyField
toOfferTemplate
) – Page based offer. Select an offer provider whose offers should be displayed on this page. (related name:pages
)
Reverse relationships:
- Parameters:
translations (Reverse
ForeignKey
fromPageTranslation
) – All translations of this page (related name ofpage
)children (Reverse
ForeignKey
fromPage
) – All children of this page (related name ofparent
)mirroring_pages (Reverse
ForeignKey
fromPage
) – All mirroring pages of this page (related name ofmirrored_page
)
- exception DoesNotExist[source]
Bases:
ObjectDoesNotExist
- exception MultipleObjectsReturned[source]
Bases:
MultipleObjectsReturned
- add_child(**kwargs: Any) AbstractTreeNode [source]
Adds a child to the node
- Parameters:
**kwargs (Any) – The supplied keyword arguments
- Returns:
The new child
- Return type:
- add_sibling(pos: str | None = None, **kwargs: Any) AbstractTreeNode [source]
Adds a new node as a sibling to the current node object
- Parameters:
pos (str | None) – The position of the new sibling
**kwargs (Any) – The supplied keyword arguments
- Returns:
The new sibling
- Return type:
- api_token[source]
Type:
CharField
API access token. API token to allow writing content to translations.
- archive() None [source]
Archives the page and removes all links of this page and all its subpages from the linkchecker
- Return type:
None
- archived[source]
A hierarchical page is archived either explicitly if
explicitly_archived=True
or implicitly if one of its ancestors is explicitly archived.- Returns:
Whether or not this page is archived
- authors[source]
Type:
ManyToManyField
toUser
Authors. A list of users who have the permission to edit this specific page. Only has effect if these users do not have the permission to edit pages anyway. (related name:
editable_pages
)
- available_translations() Iterator[Any] [source]
This method returns an iterator over all available translations, respecting the fallback_translations_enabled setting.
- Returns:
An iterator over all translations
- Return type:
Iterator[Any]
- backend_edit_link[source]
This function returns the absolute url to the edit form of this region
- Returns:
The url
- 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 content object in the current backend language and if it doesn’t exist, it provides a fallback to the translation in the region’s default language.
- Returns:
The “best” translation of a content object for displaying in the backend
- cached_parent[source]
Get the parent node of the current node object. Caches the result in the object itself to help in loops.
- Returns:
The parent of the node
- children[source]
Type: Reverse
ForeignKey
fromPage
All children of this page (related name of
parent
)
- 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.
- created_date[source]
Type:
DateTimeField
Creation date
- default_public_translation[source]
This function returns the public translation of this content object in the region’s default language.
- Returns:
The default translation of a content object
- default_translation[source]
This function returns the translation of this content object in the region’s default language. Since a content object can only be created by creating a translation in the default language, this is guaranteed to return a object translation (Exception: When the default language tree node is changed to another language after the page has been created, the default translation might not exist).
- Returns:
The default translation of a content object
- depth[source]
Type:
PositiveIntegerField
Depth
- classmethod dump_bulk(parent=None, keep_ids=True)[source]
Dumps a tree branch to a python data structure.
- property edit_lock_key: tuple[str | int | None, str][source]
This property returns the key that is used to lock this specific content object
- Returns:
A tuple of the id of this object and the classname
- editors[source]
Type:
ManyToManyField
toUser
Editors. A list of users who have the permission to publish this specific page. Only has effect if these users do not have the permission to publish pages anyway. (related name:
publishable_pages
)
- embedded_offers[source]
Type:
ManyToManyField
toOfferTemplate
Page based offer. Select an offer provider whose offers should be displayed on this page. (related name:
pages
)
- explicitly_archived[source]
Type:
BooleanField
Explicitly archived. Whether or not the page is explicitly archived
- explicitly_archived_ancestors[source]
This returns all of the page’s ancestors which are archived.
- Returns:
The list of archived ancestors
- property fallback_translations_enabled: bool[source]
Whether translations should be returned in the default language if they do not exist
- Returns:
Whether fallback translations are enabled
- classmethod find_problems() None [source]
Checks for problems in the tree structure.
This dummy method definition exists to silence pylint’s warning: Method ‘find_problems’ is abstract in class ‘Node’ but is not overridden (abstract-method)
- Return type:
None
- classmethod fix_tree() None [source]
Solves problems that can appear when transactions are not used and a piece of code breaks, leaving the tree in an inconsistent state.
This dummy method definition exists to silence pylint’s warning: Method ‘fix_tree’ is abstract in class ‘Node’ but is not overridden (abstract-method)
- Return type:
None
- 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_ancestors()[source]
- Returns:
A queryset containing the current node object’s ancestors, starting by the root node and descending to the parent.
- classmethod get_annotated_list(parent=None, max_depth=None)[source]
Gets an annotated list from a tree branch.
- Parameters:
parent – The node whose descendants will be annotated. The node itself will be included in the list. If not given, the entire tree will be annotated.
max_depth – Optionally limit to specified depth
- get_cached_ancestors(include_self: bool = False) list[Self] [source]
Get the cached ancestors of a specific node
- get_cached_descendants(include_self: bool = False) list[Self] [source]
Get the cached descendants of a specific node
- classmethod get_database_vendor(action)[source]
returns the supported database vendor used by a treebeard model when performing read (select) or write (update, insert, delete) operations.
- Parameters:
action – read or write
- Returns:
postgresql, mysql or sqlite
- get_descendants()[source]
- Returns:
A queryset of all the node’s descendants as DFS, doesn’t include the node itself
- classmethod get_descendants_group_count(parent=None)[source]
Helper for a very common case: get a group of siblings and the number of descendants (not only children) in every sibling.
- Parameters:
parent – The parent of the siblings to return. If no parent is given, the root nodes will be returned.
- Returns:
A list (NOT a Queryset) of node objects with an extra attribute: descendants_count.
- classmethod get_first_root_node()[source]
- Returns:
The first root node in the tree or
None
if it is empty.
- get_first_sibling()[source]
- Returns:
The leftmost node’s sibling, can return the node itself if it was the leftmost sibling.
- classmethod get_foreign_keys()[source]
Get foreign keys and models they refer to, so we can pre-process the data for load_bulk
- classmethod get_last_root_node()[source]
- Returns:
The last root node in the tree or
None
if it is empty.
- get_last_sibling()[source]
- Returns:
The rightmost node’s sibling, can return the node itself if it was the rightmost sibling.
- get_locking_user() Any | None [source]
This method returns the user that is currently locking this content object.
- Returns:
The user
- Return type:
Any | None
- get_major_public_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest major public translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_major_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest major translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_mirrored_page_translation(language_slug: str) Any | None [source]
Mirrored content always includes the live content from another page. This content needs to be added when delivering content to end users.
- classmethod get_model_name_plural() str [source]
Get the plural representation of this model name
- Returns:
The plural model name
- Return type:
- get_next_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=True, **kwargs)[source]
Finds next instance based on
created_date
. Seeget_next_by_FOO()
for more information.
- get_next_sibling()[source]
- Returns:
The next node’s sibling, or None if it was the rightmost sibling.
- get_non_archived_children() Iterator[Page] [source]
This method returns all children of this page that are neither explicitly archived nor implicitly archived
- Returns:
The non-archived children
- Return type:
Iterator[Page]
- get_parent(update=False)[source]
- Returns:
the parent node of the current node object. Caches the result in the object itself to help in loops.
- get_prefetched_translations_by_language_slug(attr: str = 'prefetched_translations', **filters: Any) dict[str, AbstractContentTranslation] [source]
This method returns a mapping from language slugs to their latest translations of this object
- Parameters:
attr (str) – Which attribute should be tried to get the prefetched translations [optional, defaults to
"prefetched_translations"
]**filters (Any) – Additional filters to be applied on the translations (e.g. by status)
- Returns:
The prefetched translations by language slug
- Return type:
- get_prev_sibling()[source]
- Returns:
The previous node’s sibling, or None if it was the leftmost sibling.
- get_previous_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=False, **kwargs)[source]
Finds previous instance based on
created_date
. Seeget_previous_by_FOO()
for more information.
- get_public_or_draft_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest public or draft translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- get_public_translation(language_slug: str) AbstractContentTranslation | None [source]
This function retrieves the newest public translation of a content object.
- Parameters:
- Returns:
The public translation of a content object
- Return type:
AbstractContentTranslation | None
- classmethod get_region_root_nodes(region_slug: str) NS_NodeQuerySet [source]
Get all root nodes of a specific region
- classmethod get_region_tree(region_slug: str) NS_NodeQuerySet [source]
Get the tree of a specific region
- get_repr() str [source]
This overwrites the default Django
__repr__()
method which would return<Page: Page object (id)>
. It is used for logging.- Returns:
The canonical string representation of the page
- Return type:
- classmethod get_root_pages(region_slug: str) QuerySet [source]
Gets all root pages
- Parameters:
region_slug (str) – Slug defining the region
- Returns:
All root pages i.e. pages without parents
- Return type:
QuerySet
- get_sorted_pos_queryset(siblings, newobj)[source]
- Returns:
A queryset of the nodes that must be moved to the right. Called only for Node models with
node_order_by
This function is based on _insertion_target_filters from django-mptt (BSD licensed) by Jonathan Buchanan: https://github.com/django-mptt/django-mptt/blob/0.3.0/mptt/signals.py
- get_translation(language_slug: str) AbstractContentTranslation | None [source]
This function uses the reverse foreign key
self.translations
to get all translations ofself
and filters them to the requestedLanguage
slug.- Parameters:
- Returns:
The translation in the requested
Language
orNone
if no translation exists- Return type:
AbstractContentTranslation | None
- static get_translation_model() ModelBase [source]
Returns the translation model of this content model
- Returns:
The class of translations
- Return type:
ModelBase
- get_translation_state(language_slug: str) str [source]
This function returns the current state of a translation in the given language.
- classmethod get_tree(parent: AbstractTreeNode | None = None) NS_NodeQuerySet [source]
Get the tree of a specific parent node
- Parameters:
parent (AbstractTreeNode | None) – The parent node of which the tree should be returned (optional, if no parent is given, all trees are returned.)
- Returns:
A
QuerySet
of nodes ordered as DFS, including the parent.- Return type:
NS_NodeQuerySet
- get_tree_max_depth(max_depth: int = 1) NS_NodeQuerySet [source]
Return all descendants with depth less or equal to max depth relative to this nodes depth
- Parameters:
max_depth (int) – The nodes maximum depth in the tree
- Returns:
This node including its descendants with relative max depth
- Return type:
NS_NodeQuerySet
- hix_ignore: bool[source]
Type:
BooleanField
Ignore HIX value. This allows to ignore HIX value for this specific page.
Whether the HIX value is ignored (this is
False
by default if not overwritten by a submodel)
- icon[source]
Type:
ForeignKey
toMediaFile
Icon (related name:
pages
)
- id[source]
Type:
BigAutoField
Primary key: ID
- implicitly_archived[source]
This checks whether one of the page’s ancestors is archived which means that this page is implicitly archived as well.
- Returns:
Whether or not this page is implicitly archived
- invalidate_cached_translations() None [source]
Delete all cached translations and query them from the database again when they are accessed next time.
This is helpful when new translations have been created and the content model should be reused.
- Return type:
None
- is_child_of(node)[source]
- Returns:
True
if the node is a child of another node given as an argument, else, returnsFalse
- Parameters:
node – The node that will be checked as a parent
- is_descendant_of(node)[source]
- Returns:
True
if the node if a descendant of another node given as an argument, else, returnsFalse
- is_sibling_of(node)[source]
- Returns:
True
if the node is a sibling of another node given as an argument, else, returnsFalse
- Parameters:
node – The node that will be checked as a sibling
- languages[source]
This property returns a list of all
Language
objects, to which a translation exists.- Returns:
The existing languages of this content object
- lft[source]
Type:
PositiveIntegerField
Lft
- classmethod load_bulk(bulk_data, parent=None, keep_ids=False)[source]
Loads a list/dictionary structure to the tree.
- mirrored_page[source]
Type:
ForeignKey
toPage
Mirrored page. If the page embeds live content from another page, it is referenced here. (related name:
mirroring_pages
)
- mirrored_page_first[source]
Type:
BooleanField
Position of mirrored page. If a mirrored page is set, this field determines whether the live content is embedded before the content of this page or after.
- mirrored_page_id[source]
Internal field, use
mirrored_page
instead.
- mirroring_pages[source]
Type: Reverse
ForeignKey
fromPage
All mirroring pages of this page (related name of
mirrored_page
)
- move(target: Page, pos: str | None = None) None [source]
Moving tree nodes potentially causes changes to the fields tree_id, lft and rgt in
NS_Node
so the cache of page translations has to be cleared, because of it’s relation toPage
- Parameters:
- Raises:
InvalidPosition – If the node is moved to another region
- Return type:
None
- next_region_sibling[source]
Get the next node’s sibling, or None if it was the rightmost sibling.
- Returns:
The next node’s sibling in its region
- objects = <integreat_cms.cms.models.pages.page.PageManager object>[source]
Django manager to access the ORM Use
Page.objects.all()
to fetch all objects.Custom model manager to inherit methods from tree manager as well as the custom content queryset
- organization[source]
Type:
ForeignKey
toOrganization
Responsible organization. This allows all members of the organization to edit and publish this page. (related name:
pages
)
- organization_id[source]
Internal field, use
organization
instead.
- parent[source]
Type:
ForeignKey
toPage
Parent page (related name:
children
)
- prefetched_major_public_translations_by_language_slug[source]
This method returns a mapping from language slugs to their major public translations of this object
- prefetched_major_translations_by_language_slug[source]
This method returns a mapping from language slugs to their major translations of this object
- prefetched_public_or_draft_translations_by_language_slug[source]
This method returns a mapping from language slugs to their public translations of this object
- prefetched_public_translations_by_language_slug[source]
This method returns a mapping from language slugs to their public translations of this object
- prefetched_translations_by_language_slug[source]
This method returns a mapping from language slugs to their latest translations of this object
- Returns:
The prefetched translations by language slug
- prev_region_sibling[source]
Get the previous node’s sibling, or None if it was the leftmost sibling.
- Returns:
The previous node’s sibling in its region
- public_languages[source]
This property returns a list of all
Language
objects, to which a public translation exists and which are visible in this region.- Returns:
The existing languages of this content object
- 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.
- region[source]
Type:
ForeignKey
toRegion
Region (related name:
pages
)
- region_siblings[source]
Get all siblings of a specific node in its region
- Returns:
A
QuerySet
of all the node’s siblings, including the node itself.
- relative_depth[source]
The relative depth inside a cached tree structure. This is relevant for archived pages, where even sub-pages should be displayed as root-pages if their parents are not archived.
- Returns:
The relative depth of this node inside its queryset
- restore() None [source]
Restores the page and adds all links of this page and its now non-archived subpages back
- Return type:
None
- rgt[source]
Type:
PositiveIntegerField
Rgt
- 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.
- translation_states[source]
This property calculates all translations states of the object
- Returns:
A dictionary containing each language as key and the given translation state as value
- translations[source]
Type: Reverse
ForeignKey
fromPageTranslation
All translations of this page (related name of
page
)
- tree_id[source]
Type:
PositiveIntegerField
Tree id
- class integreat_cms.cms.models.pages.page.PageManager(*args, **kwargs)[source]
Bases:
Manager
Custom manager for pages to inherit methods from both managers for tree nodes and content objects
- abulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)[source]
- aggregate(*args, **kwargs)[source]
Return a dictionary containing the calculations (aggregation) over the current queryset.
If args is present the expression is passed as a kwarg using the Aggregate object’s default alias.
- aiterator(chunk_size=2000)[source]
An asynchronous iterator over the results from applying this QuerySet to the database.
- alias(*args, **kwargs)[source]
Return a query set with added aliases for extra data or aggregations.
- annotate(*args, **kwargs)[source]
Return a query set in which the returned objects have been annotated with extra data or aggregations.
- bulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)[source]
Insert each of the instances into the database. Do not call save() on each of the instances, do not send any pre/post_save signals, and do not set the primary key attribute if it is an autoincrement field (except if features.can_return_rows_from_bulk_insert=True). Multi-table models are not supported.
- bulk_update(objs, fields, batch_size=None)[source]
Update the given fields in each of the given objects in the database.
- complex_filter(filter_obj)[source]
Return a new QuerySet instance with filter_obj added to the filters.
filter_obj can be a Q object or a dictionary of keyword lookup arguments.
This exists to support framework features such as ‘limit_choices_to’, and usually it will be more natural to use other methods.
- count()[source]
Perform a SELECT COUNT() and return the number of records as an integer.
If the QuerySet is already fully cached, return the length of the cached results set to avoid multiple SELECT COUNT(*) calls.
- create(**kwargs)[source]
Create a new object with the given kwargs, saving it to the database and returning the created object.
- dates(field_name, kind, order='ASC')[source]
Return a list of date objects representing all available dates for the given field_name, scoped to ‘kind’.
- datetimes(field_name, kind, order='ASC', tzinfo=None, is_dst=<object object>)[source]
Return a list of datetime objects representing all available datetimes for the given field_name, scoped to ‘kind’.
- deconstruct()[source]
Return a 5-tuple of the form (as_manager (True), manager_class, queryset_class, args, kwargs).
Raise a ValueError if the manager is dynamically generated.
- defer(*fields)[source]
Defer the loading of data for certain fields until they are accessed. Add the set of deferred fields to any existing set of deferred fields. The only exception to this is if None is passed in as the only parameter, in which case removal all deferrals.
- distinct(*field_names)[source]
Return a new QuerySet instance that will select only distinct results.
- exclude(*args, **kwargs)[source]
Return a new QuerySet instance with NOT (args) ANDed to the existing set.
- explain(*, format=None, **options)[source]
Runs an EXPLAIN on the SQL query this QuerySet would perform, and returns the results.
- extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)[source]
Add extra SQL fragments to the query.
- filter(*args, **kwargs)[source]
Return a new QuerySet instance with the args ANDed to the existing set.
- get(*args, **kwargs)[source]
Perform the query and return a single object matching the given keyword arguments.
- get_or_create(defaults=None, **kwargs)[source]
Look up an object with the given kwargs, creating one if necessary. Return a tuple of (object, created), where created is a boolean specifying whether an object was created.
- get_queryset() PageQuerySet [source]
Sets the custom queryset as the default.
- Returns:
The sorted queryset
- Return type:
- in_bulk(id_list=None, *, field_name='pk')[source]
Return a dictionary mapping each of the given IDs to the object with that ID. If id_list isn’t provided, evaluate the entire QuerySet.
- iterator(chunk_size=None)[source]
An iterator over the results from applying this QuerySet to the database. chunk_size must be provided for QuerySets that prefetch related objects. Otherwise, a default chunk_size of 2000 is supplied.
- latest(*fields)[source]
Return the latest object according to fields (if given) or by the model’s Meta.get_latest_by.
- only(*fields)[source]
Essentially, the opposite of defer(). Only the fields passed into this method and that are not already specified as deferred are loaded immediately when the queryset is evaluated.
Return a new QuerySet instance that will prefetch the specified Many-To-One and Many-To-Many related objects when the QuerySet is evaluated.
When prefetch_related() is called more than once, append to the list of prefetch lookups. If prefetch_related(None) is called, clear the list.
- select_for_update(nowait=False, skip_locked=False, of=(), no_key=False)[source]
Return a new QuerySet instance that will select objects with a FOR UPDATE lock.
Return a new QuerySet instance that will select related objects.
If fields are specified, they must be ForeignKey fields and only those related objects are included in the selection.
If select_related(None) is called, clear the list.
- update(**kwargs)[source]
Update all elements in the current QuerySet, setting all the given fields to the appropriate values.
- update_or_create(defaults=None, **kwargs)[source]
Look up an object with the given kwargs, updating one with defaults if it exists, otherwise create a new one. Return a tuple (object, created), where created is a boolean specifying whether an object was created.
- class integreat_cms.cms.models.pages.page.PageQuerySet(model=None, query=None, using=None, hints=None)[source]
Bases:
NS_NodeQuerySet
,ContentQuerySet
Custom queryset for pages to inherit methods from both querysets for tree nodes and content objects
- async abulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)[source]
- aggregate(*args, **kwargs)[source]
Return a dictionary containing the calculations (aggregation) over the current queryset.
If args is present the expression is passed as a kwarg using the Aggregate object’s default alias.
- async aiterator(chunk_size=2000)[source]
An asynchronous iterator over the results from applying this QuerySet to the database.
- alias(*args, **kwargs)[source]
Return a query set with added aliases for extra data or aggregations.
- all()[source]
Return a new QuerySet that is a copy of the current one. This allows a QuerySet to proxy for a model manager in some cases.
- annotate(*args, **kwargs)[source]
Return a query set in which the returned objects have been annotated with extra data or aggregations.
- bulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)[source]
Insert each of the instances into the database. Do not call save() on each of the instances, do not send any pre/post_save signals, and do not set the primary key attribute if it is an autoincrement field (except if features.can_return_rows_from_bulk_insert=True). Multi-table models are not supported.
- bulk_update(objs, fields, batch_size=None)[source]
Update the given fields in each of the given objects in the database.
- cache_tree(archived: bool | None = None, language_slug: str | None = None) list[Page] [source]
Caches a page tree queryset in a python data structure.
- Parameters:
- Raises:
ValueError – Indicates that the combination of parameters is not supported.
- Returns:
A list of pages with cached children, descendants and ancestors and a list of all skipped pages
- Return type:
- complex_filter(filter_obj)[source]
Return a new QuerySet instance with filter_obj added to the filters.
filter_obj can be a Q object or a dictionary of keyword lookup arguments.
This exists to support framework features such as ‘limit_choices_to’, and usually it will be more natural to use other methods.
- count()[source]
Perform a SELECT COUNT() and return the number of records as an integer.
If the QuerySet is already fully cached, return the length of the cached results set to avoid multiple SELECT COUNT(*) calls.
- create(**kwargs)[source]
Create a new object with the given kwargs, saving it to the database and returning the created object.
- dates(field_name, kind, order='ASC')[source]
Return a list of date objects representing all available dates for the given field_name, scoped to ‘kind’.
- datetimes(field_name, kind, order='ASC', tzinfo=None, is_dst=<object object>)[source]
Return a list of datetime objects representing all available datetimes for the given field_name, scoped to ‘kind’.
- defer(*fields)[source]
Defer the loading of data for certain fields until they are accessed. Add the set of deferred fields to any existing set of deferred fields. The only exception to this is if None is passed in as the only parameter, in which case removal all deferrals.
- delete(*args, removed_ranges=None, deleted_counter=None, **kwargs)[source]
Custom delete method, will remove all descendant nodes to ensure a consistent tree (no orphans)
- Returns:
tuple of the number of objects deleted and a dictionary with the number of deletions per object type
- distinct(*field_names)[source]
Return a new QuerySet instance that will select only distinct results.
- exclude(*args, **kwargs)[source]
Return a new QuerySet instance with NOT (args) ANDed to the existing set.
- explain(*, format=None, **options)[source]
Runs an EXPLAIN on the SQL query this QuerySet would perform, and returns the results.
- extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)[source]
Add extra SQL fragments to the query.
- filter(*args, **kwargs)[source]
Return a new QuerySet instance with the args ANDed to the existing set.
- get(*args, **kwargs)[source]
Perform the query and return a single object matching the given keyword arguments.
- get_or_create(defaults=None, **kwargs)[source]
Look up an object with the given kwargs, creating one if necessary. Return a tuple of (object, created), where created is a boolean specifying whether an object was created.
- in_bulk(id_list=None, *, field_name='pk')[source]
Return a dictionary mapping each of the given IDs to the object with that ID. If id_list isn’t provided, evaluate the entire QuerySet.
- iterator(chunk_size=None)[source]
An iterator over the results from applying this QuerySet to the database. chunk_size must be provided for QuerySets that prefetch related objects. Otherwise, a default chunk_size of 2000 is supplied.
- latest(*fields)[source]
Return the latest object according to fields (if given) or by the model’s Meta.get_latest_by.
- only(*fields)[source]
Essentially, the opposite of defer(). Only the fields passed into this method and that are not already specified as deferred are loaded immediately when the queryset is evaluated.
- property ordered[source]
Return True if the QuerySet is ordered – i.e. has an order_by() clause or a default ordering on the model (or is empty).
- prefetch_major_public_translations() ContentQuerySet [source]
Get the queryset including the custom attribute
prefetched_major_public_translations
which contains the latest major (in other words not a minor edit) public translations of each content object in each language- Returns:
The queryset of content objects
- Return type:
- prefetch_major_translations() ContentQuerySet [source]
Get the queryset including the custom attribute
prefetched_major_translations
which contains the latest major (in other words not a minor edit) translations of each content object in each language- Returns:
The queryset of content objects
- Return type:
- prefetch_public_or_draft_translations() ContentQuerySet [source]
Get the queryset including the custom attribute
prefetched_public_or_draft_translations
which contains the latest public or draft translations of each content object in each language- Returns:
The queryset of content objects
- Return type:
- prefetch_public_translations() ContentQuerySet [source]
Get the queryset including the custom attribute
prefetched_public_translations
which contains the latest public translations of each content object in each language- Returns:
The queryset of content objects
- Return type:
Return a new QuerySet instance that will prefetch the specified Many-To-One and Many-To-Many related objects when the QuerySet is evaluated.
When prefetch_related() is called more than once, append to the list of prefetch lookups. If prefetch_related(None) is called, clear the list.
- prefetch_translations(to_attr: str = 'prefetched_translations', **filters: Any) ContentQuerySet [source]
Get the queryset including the custom attribute
to_attr
which contains the latest translations of each content object in each language, optionally filtered by the givenstatus
- Parameters:
to_attr (str) – To which attribute the prefetched translations should be added [optional, defaults to
prefetched_translations
]**filters (Any) – Additional filters to be applied on the translations (e.g. by status)
- Returns:
The queryset of content objects
- Return type:
- select_for_update(nowait=False, skip_locked=False, of=(), no_key=False)[source]
Return a new QuerySet instance that will select objects with a FOR UPDATE lock.
Return a new QuerySet instance that will select related objects.
If fields are specified, they must be ForeignKey fields and only those related objects are included in the selection.
If select_related(None) is called, clear the list.
- update(**kwargs)[source]
Update all elements in the current QuerySet, setting all the given fields to the appropriate values.
Page Translation
- class integreat_cms.cms.models.pages.page_translation.PageTranslation(*args, **kwargs)[source]
Bases:
AbstractBasePageTranslation
Data model representing a page translation
- Parameters:
id (BigAutoField) – Primary key: ID
title (TruncatingCharField) – Title of the page
slug (SlugField) – Page link. 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) – Content of the page
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.
hix_score (FloatField) – HIX score
hix_feedback (JSONField) – HIX feedback
Relationship fields:
- Parameters:
language (
ForeignKey
toLanguage
) – Language (related name:page_translations
)creator (
ForeignKey
toUser
) – Creator (related name:page_translations
)page (
ForeignKey
toPage
) – Page (related name:translations
)links (
GenericRelation
toLink
) – Links (related name:page_translation
)
Reverse relationships:
- Parameters:
feedback (Reverse
ForeignKey
fromPageFeedback
) – All feedback of this page translation (related name ofpage_translation
)
- exception DoesNotExist[source]
Bases:
ObjectDoesNotExist
- exception MultipleObjectsReturned[source]
Bases:
MultipleObjectsReturned
- all_versions[source]
This property returns all versions of this translation’s page in its language
- Returns:
All versions of this translation
- ancestor_path[source]
This property calculates the path of all parents of the page
- Returns:
The relative path to the page
- automatic_translation[source]
Type:
BooleanField
Automatic translation. Tick if updating this content should automatically refresh or create its translations.
- available_languages_dict[source]
This property checks in which
Language
the content is translated apart fromself.language
It only returns languages which have a public translation, so drafts are not included here. The returned dict has the following format:{ available_translation.language.slug: { 'id': available_translation.id, 'url': available_translation.permalink 'path': available_translation.path }, ... }
- Returns:
A dictionary containing the available languages of a content translation
- backend_edit_link[source]
This function returns the absolute url to the editor for this translation
- Returns:
The url
- base_link[source]
Generates the base link which is the whole url without slug
For information about the components of such an url, see
get_absolute_url()
- Returns:
the base link of the content
- 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.
- cleanup_autosaves() None [source]
Delete all
AUTO_SAVE
translations older than the second last manual save and renumber all affected versions to be continuous.- Return type:
None
- combined_last_updated[source]
This function combines the last_updated date from this PageTranslation and from a mirrored page. If this translation has no content, then the date from the mirrored translation will be used. In other cases, the date from this translation will be used.
- Returns:
The last_updated date of this or the mirrored page translation
- combined_text[source]
This function combines the text from this PageTranslation with the text from the mirrored page. Mirrored content always includes the live content from another page. This content needs to be added when delivering content to end users. If the mirrored page is not available in the current language, or if the content is empty, an error message for the user will be used instead.
- Returns:
The combined content of this page and the mirrored page
- create_new_version_copy(user: User | None = None) AbstractContentTranslation [source]
Create a new version by copying
- Parameters:
user (User | None)
- Return type:
- creator[source]
Type:
ForeignKey
toUser
Creator (related name:
page_translations
)
- currently_in_translation[source]
Type:
BooleanField
Currently in translation. Flag to indicate a translation is being updated by an external translator
- static default_icon() str | None [source]
Returns the default icon that should be used for this content translation type, or None for no icon
- Return type:
str | None
- display_content[source]
This property returns the content that can be displayed to the user. This is just the normal content unless this translation is empty. Then a message will be returned which prompts the user to view the page in another language instead.
- Returns:
Html text for the content of this translation
- feedback[source]
Type: Reverse
ForeignKey
fromPageFeedback
All feedback of this page translation (related name of
page_translation
)
- static foreign_field() Literal['page'] [source]
Returns the string “page” which ist the field name of the reference to the page which the translation belongs to
- Returns:
The foreign field name
- Return type:
Literal[‘page’]
- foreign_object[source]
This property is an alias of the page foreign key and is needed to generalize the
slug_utils
for all content types- Returns:
The page to which the translation belongs
- 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.
- full_url[source]
This property returns the full url of this content translation object
- Returns:
The full url
- get_absolute_url() str [source]
Generates the absolute url of the content translation object
Here is an example for demonstrating the components of a page url:
https://integreat.app/augsburg/en/welcome/city-map/attractions/ |-------------------------------------------------------------| full_url |----------------------------------------| get_absolute_url() |-------------------------------------------------| base_link |----------------------------| url_prefix |----------------| url_infix |-----------| slug
Here is an example for demonstrating the components of an event url:
https://integreat.app/augsburg/en/events/test-event/ |--------------------------------------------------| full_url |-----------------------------| get_absolute_url() |---------------------------------------| base_link |------------------| url_prefix |------| url_infix |----------| slug
- Returns:
The absolute url
- Return type:
- get_all_used_slugs() Iterable[str] [source]
- Returns:
All slugs that have been used by at least on version of this translation
- Return type:
Iterable[str]
- classmethod get_current_translations(region: Region, language: Language) list[PageTranslation] [source]
This function is similar to
get_translations()
but returns only page translations which are currently being translated by an external translator
- classmethod get_model_name_plural() str [source]
Get the plural representation of this model name
- Returns:
The plural model name
- Return type:
- get_next_by_last_updated(*, field=<django.db.models.DateTimeField: last_updated>, is_next=True, **kwargs)[source]
Finds next instance based on
last_updated
. Seeget_next_by_FOO()
for more information.
- classmethod get_outdated_translations(region: Region, language: Language) list[PageTranslation] [source]
This function is similar to
get_translations()
but returns only page translations which are outdated
- get_previous_by_last_updated(*, field=<django.db.models.DateTimeField: last_updated>, is_next=False, **kwargs)[source]
Finds previous instance based on
last_updated
. Seeget_previous_by_FOO()
for more information.
- get_repr() str [source]
This overwrites the default Django
__repr__()
method. It is used for logging.- Returns:
The canonical string representation of the content translation
- Return type:
- get_status_display(*, field=<django.db.models.CharField: status>)[source]
Shows the label of the
status
. Seeget_FOO_display()
for more information.
- classmethod get_translations(region: Region, language: Language) QuerySet[PageTranslation] [source]
This function retrieves the most recent versions of all
PageTranslation
objects of aRegion
in a specificLanguage
- classmethod get_up_to_date_translations(region: Region, language: Language) list[PageTranslation] [source]
This function is similar to
get_translations()
but returns only page translations which are up to date
- hix_enabled[source]
This function returns whether the HIX API is enabled for this instance
- Returns:
Whether HIX is enabled
- hix_ignore[source]
Whether this translation is ignored for HIX calculation
- Returns:
Wether the HIX value is ignored
- hix_score[source]
Type:
FloatField
HIX score
The HIX score is
None
if not overwritten by a submodel
- hix_sufficient_for_mt[source]
Whether this translation has a sufficient HIX value for machine translations. If it is
None
, machine translations are allowed by default.- Returns:
Whether the HIX value is sufficient for MT
- id[source]
Type:
BigAutoField
Primary key: ID
- is_empty[source]
This property returns whether the content of this translation is empty
- Returns:
Whether the content of this translation is empty
- is_outdated[source]
This property checks whether a translation is outdated and thus needs a new revision of the content. This happens, when the source translation is updated and the update is no minor_edit.
If the translation is currently being translated, it is considered not outdated.
If the translation’s language is the region’s default language, it is defined to be never outdated.
If the translation’s source translation is already outdated, then the translation itself also is.
If neither the translation nor its source translation have a latest major public translation, it is defined as not outdated.
If neither the translation nor its source translation have a latest major public translation, it is defined as not outdated.
Otherwise, the outdated flag is calculated by comparing the last_updated-field of the translation and its source translation.
- Returns:
Flag to indicate whether the translation is outdated
- is_up_to_date[source]
This property checks whether a translation is up to date. A translation is considered up to date when it is either explicitly set to up-to-date, or has been machine-translated.
- Returns:
Flag which indicates whether a translation is up to date
- language[source]
Type:
ForeignKey
toLanguage
Language (related name:
page_translations
)
- last_updated[source]
Type:
DateTimeField
Modification date
- latest_version[source]
This property is a link to the most recent version of this translation.
- Returns:
The latest revision of the translation
- link_title[source]
This property returns the html that should be used as a title for a link to this translation
- Returns:
The link content
- links[source]
Type: Reverse
GenericRelation
fromPageTranslation
All page translation of this link (related name of
links
)
- machine_translated[source]
Type:
BooleanField
Machine translated. Flag to indicate whether a translations is machine translated
- major_public_source_translation[source]
This property returns the latest major public version of the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- major_public_version[source]
This property is a link to the most recent major public version of this translation. This is used when translations, which are derived from this translation, check whether they are up to date.
- Returns:
The latest major public revision of the translation
- major_source_translation[source]
This property returns the latest major version of the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- major_version[source]
This property is a link to the most recent major version of this translation. This is used when translations, which are derived from this translation, check whether they are up to date.
- Returns:
The latest major public revision of the translation
- minor_edit[source]
Type:
BooleanField
Minor edit. Tick if this change does not require an update of translations in other languages.
- mirrored_translation_text[source]
This method returns the text of the mirrored translation or an empty string, if it is not available in this language
- Returns:
The text
- mirrored_translation_text_or_fallback_message[source]
This method returns the text of the mirrored translation. If there is no mirrored translation, it returns an empty string. If there is a mirrored page but no translation, a html error message will be returned with languages that are translated as options.
- Returns:
The text, as specified
- page[source]
Type:
ForeignKey
toPage
Page (related name:
translations
)
- path() SafeString [source]
This method returns a human-readable path that should uniquely identify this page translation within a given region
- Returns:
The path
- Return type:
SafeString
- public_or_draft_source_translation[source]
This property returns the public and draft translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- public_source_translation[source]
This property returns the public translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- public_version[source]
This property is a link to the most recent public version of this translation. If the translation itself is not public, this property can return a revision which is older than
self
.- Returns:
The latest public revision of the translation
- read_only: bool = False[source]
Whether this object is read-only and not meant to be stored to the database
- readable_title[source]
Get the title of a page translation including the title in the best translation
- Returns:
The readable title of the page translation
- 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.
- replace_urls(urls_to_replace: dict[str, str], user: User | None = None, commit: bool = True) None [source]
Function to replace links that are in the translation and match the given keyword search
- save(*args: Any, **kwargs: Any) None [source]
This overwrites the default Django
save()
method, to update the last_updated field on changes.- Parameters:
*args (Any) – The supplied arguments
**kwargs (Any) – The supplied kwargs
- Raises:
RuntimeError – When the object was locked for database writes
- Return type:
None
- 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.
- classmethod search(region: Region, language_slug: str, query: str) QuerySet [source]
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
- 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.
- short_url[source]
This function returns the absolute short url to the page translation
- Returns:
The short url of a page translation
- sitemap_alternates[source]
This property returns the language alternatives of a content translation for the use in sitemaps. Similar to
available_languages_dict()
, but in a slightly different format.- Returns:
A list of dictionaries containing the alternative translations of a content translation
- slug[source]
Type:
SlugField
Page link. String identifier without spaces and special characters. Unique per region and language. Leave blank to generate unique parameter from title.
- source_language[source]
This property returns the source language of this language in this
Region
’s language tree- Returns:
The source language of this translation
- source_translation[source]
This property returns the translation which was used to create the
self
translation. It derives this information from theRegion
’s rootLanguageTreeNode
.
- status[source]
Type:
CharField
Status
Choices:
DRAFT
REVIEW
PUBLIC
AUTO_SAVE
Manage choices in
status
- tags[source]
This functions returns a list of translated tags which apply to this function. Supported tags: * Live content: if the page of this translation has live content * Empty: if the page contains no text and has no non-archived subpages
- Returns:
A list of tags which apply to this translation
- translation_state[source]
This function returns the current state of a translation in the given language.
- Returns:
A string describing the state of the translation, one of
CHOICES
- url_infix[source]
Generates the infix of the url of the page translation object which is the ancestor path of the page
For information about the components of such an url, see
get_absolute_url()
- Returns:
the infix of the url
- url_prefix[source]
Generates the prefix of the url of the content translation object
For information about the components of such an url, see
get_absolute_url()
- Returns:
The prefix to the url
- validate_unique(exclude=None)[source]
Check unique constraints on the model and raise ValidationError if any failed.
- version[source]
Type:
PositiveIntegerField
Revision