From e795aa9c70897111644504c64e5a7f1145f057c4 Mon Sep 17 00:00:00 2001 From: Qwann Date: Thu, 20 Jul 2017 00:58:18 +0200 Subject: [PATCH] dev-doc started --- dev-doc.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/dev-doc.md b/dev-doc.md index e69de29..c1f683d 100644 --- a/dev-doc.md +++ b/dev-doc.md @@ -0,0 +1,31 @@ +# Documentation de la/du développeu-se-r + +## L'application évènements + +Il s'agit de l'application contenue dans le répertoire `communication` + +### EventSpecificMixin + +Pour décrire les modèles qui peuvent dépendre d'un évènement ou non on utilise le Mixin `EventSpecificMixin` qui rajoute la relation `event` avec l'option `blank=True`. Si le champ est spécifié alors le modèle est spécifique à un évènement, sinon il est général à l'instance de GestionÉvènementiel. + + +## L'application de communication + +Il s'agit de l'application contenue dans le répertoire `communication` + +### Les commentaires + +Les commentaires sont gérés à l'aide de la librairie `django-contrib-comments`. + +### Les notifications + +Les notifications sont gérées à l'aide de la librairie `django-notifications`. + +#### SubscriptionMixin + +Afin de savoir qui souscrit aux notification envoyées par un modèle, on utilise le Mxin `SubscriptionMixin` qui contient les champs `user_subscriptions` des utilisateurs abonnés ou désabonnés et `group_subscriptions` des groupes qui sont abonnées. + +Le modèle `UserSubscription` contient `user`, l'utilisateur concerné et sais s'il s'agit d'une inscription ou une désinscription à l'aide du champ `is_unsub` + +Une classe héritant de `SubscriptionMixin` peut récupérer ses abonnées à l'aide de la méthode `get_all_subscribers` +