L’application flatpages (pages statiques)Lien vers cette rubrique#

Utilisation de la configuration d’URLLien vers cette rubrique#

Il y a plusieurs façons d’inclure les pages statiques dans la configuration d’URL. Vous pouvez dédier un chemin particulier pour les pages statiques :

urlpatterns = [
    path("pages/", include("django.contrib.flatpages.urls")),
]

Vous pouvez également le configurer comme un motif « fourre-tout ». Dans ce cas, il est important de placer le motif à la fin des autres urlpatterns:

from django.contrib.flatpages import views

# Your other patterns here
urlpatterns += [
    re_path(r"^(?P<url>.*/)$", views.flatpage),
]

Une autre configuration courante consiste à utiliser des pages statiques pour un nombre limité de pages connues à l’avance et à figer leurs URL dans l”:doc:URLconf </topics/http/urls>`:

from django.contrib.flatpages import views

urlpatterns += [
    path("about-us/", views.flatpage, kwargs={"url": "/about-us/"}, name="about"),
    path("license/", views.flatpage, kwargs={"url": "/license/"}, name="license"),
]

L’argument kwargs définit la valeur url utilisée pour la requête de modèle FlatPage dans la vue flatpage.

L’argument name permet à l’URL d’être résolue dans les gabarits, par exemple en utilisant la balise de gabarit url.

Utilisation de l’intergicielLien vers cette rubrique#

L’intergiciel FlatpageFallbackMiddleware peut se charger de tout le travail.

class FlatpageFallbackMiddlewareLien vers cette définition#

Chaque fois qu’une application Django génère une erreur 404, cet intergiciel vérifie si la base de données flatpages contient l’URL demandée en dernier recours. Plus précisément, il recherche une flatpage avec l’URL donnée et avec un identifiant de site qui correspond au réglage SITE_ID.

S’il trouve une correspondance, il suit cet algorithme :

• Si la flatpage a un gabarit personnalisé, il charge ce gabarit. Sinon, il charge le gabarit flatpages/default.html.

• Il transmet à ce gabarit une variable unique de contexte, flatpage, qui est l’objet flatpage. Il utilise RequestContext dans le rendu du gabarit.

L’intergiciel ne fera qu’ajouter une barre oblique finale et rediriger (en fonction du réglage APPEND_SLASH) si l’URL résultante se réfère à une flatpage valide. Les redirections sont permanentes (code 301).

Si aucune correspondance n’est trouvée, le traitement de la requête continue normalement.

L’intergiciel ne s’active que pour les erreurs 404 – pas pour les erreurs 500 ni les réponses ayant un autre code de statut.

Notez que l’ordre de MIDDLEWARE est important. Généralement, vous pouvez mettre FlatpageFallbackMiddleware à la fin de la liste. Cela signifie qu’il s’exécutera en premier lors du traitement de la réponse et garantira que tout autre intergiciel qui traite la réponse voit la réponse de la flatpage plutôt que la 404.

Pour plus d’informations sur cet intergiciel, lisez la documentation des intergiciels.

Via l’interface d’administrationLien vers cette rubrique#

Si vous avez activé l’interface d’administration automatique de Django, vous devriez voir une section « Flatpages » sur la page d’accueil de l’administration. Les flatpages sont éditables comme pour n’importe quel autre objet du système.

Le modèle FlatPage possède un champ enable_comments qui n’est pas exploité par contrib.flatpages, mais il pourrait être utile pour votre projet ou des applications tierces. Il n’apparaît pas dans l’interface d’administration, mais vous pouvez l’ajouter en inscrivant un ModelAdmin personnalisé pour FlatPage:

from django.contrib import admin
from django.contrib.flatpages.admin import FlatPageAdmin
from django.contrib.flatpages.models import FlatPage
from django.utils.translation import gettext_lazy as _


# Define a new FlatPageAdmin
class FlatPageAdmin(FlatPageAdmin):
    fieldsets = [
        (None, {"fields": ["url", "title", "content", "sites"]}),
        (
            _("Advanced options"),
            {
                "classes": ["collapse"],
                "fields": [
                    "enable_comments",
                    "registration_required",
                    "template_name",
                ],
            },
        ),
    ]


# Re-register FlatPageAdmin
admin.site.unregister(FlatPage)
admin.site.register(FlatPage, FlatPageAdmin)

Via l’API PythonLien vers cette rubrique#

Les flatpages sont représentées par un modèle Django standard, FlatPage. Vous pouvez accéder aux objets flatpage via l’API de base de données de Django.

ChampsLien vers cette rubrique#

Les objets FlatPage possèdent les champs suivants :

class models.FlatPage

urlLien vers cette définition#

Obligatoire. 100 caractères au maximum. Indexé pour des recherches plus rapides.

titleLien vers cette définition#

Obligatoire. 200 caractères au maximum.

contentLien vers cette définition#

Facultatif (blank=True). Un champ TextField qui contient typiquement le contenu HTML de la page.

enable_commentsLien vers cette définition#

Booléen. Ce champ n’est pas utilisé par flatpages par défaut et n’apparaît pas dans l’interface d’administration. Veuillez consulter la section sur l’interface d’administration de flatpages pour une explication détaillée.

template_nameLien vers cette définition#

Facultatif (blank=True). Au maximum 70 caractères. Indique le gabarit utilisé pour produire la page. Si non défini, c’est le gabarit flatpages/default.html qui est utilisé.

sitesLien vers cette définition#

Relation plusieurs-à-plusieurs vers Site, ce qui détermine sur quels sites cette page statique sera disponible.

MéthodesLien vers cette rubrique#

class models.FlatPage

get_absolute_url()Lien vers cette définition#

Renvoie le chemin d’URL relatif vers la page, basé sur l’attribut url.

Affichage des flatpages avec registration_required (connexion requise)Lien vers cette rubrique#

Par défaut, la balise de gabarit get_flatpages n’affiche que les flatpages dont le champ registration_required = False. Si vous souhaitez afficher les flatpages limitées aux utilisateurs connectés, vous devez indiquer un utilisateur authentifié en utilisant une clause for.

Par exemple :

{% get_flatpages for someuser as about_pages %}

Si vous indiquez un utilisateur anonyme, get_flatpages se comporte comme si vous n’aviez pas indiqué d’utilisateur, c’est-à-dire qu’elle ne montre que les flatpages publiques.

Filtrage des flatpages selon une URL de baseLien vers cette rubrique#

Un paramètre facultatif, starts_with, peut être appliqué pour limiter les pages affichées à celles qui commencent par une URL de base particulière. Ce paramètre peut être transmis sous forme de chaîne ou comme variable à résoudre par le contexte.

Par exemple :

{% get_flatpages '/about/' as about_pages %}
{% get_flatpages about_prefix as about_pages %}
{% get_flatpages '/about/' for someuser as about_pages %}

ExempleLien vers cette rubrique#

Voici un exemple de configuration d’URL utilisant FlatPageSitemap:

from django.contrib.flatpages.sitemaps import FlatPageSitemap
from django.contrib.sitemaps.views import sitemap
from django.urls import path

urlpatterns = [
    # ...
    # the sitemap
    path(
        "sitemap.xml",
        sitemap,
        {"sitemaps": {"flatpages": FlatPageSitemap}},
        name="django.contrib.sitemaps.views.sitemap",
    ),
]