diff --git a/.gitignore b/.gitignore index 9491a2f..2748175 100644 --- a/.gitignore +++ b/.gitignore @@ -360,4 +360,6 @@ MigrationBackup/ .ionide/ # Fody - auto-generated XML schema -FodyWeavers.xsd \ No newline at end of file +FodyWeavers.xsd +/docs/tools +/docs/phpdoc.dist.xml diff --git a/MediaTekDocuments/MediaTekDocuments.csproj b/MediaTekDocuments/MediaTekDocuments.csproj index 1cc65e2..ecd3f8a 100644 --- a/MediaTekDocuments/MediaTekDocuments.csproj +++ b/MediaTekDocuments/MediaTekDocuments.csproj @@ -24,6 +24,7 @@ DEBUG;TRACE prompt 4 + bin\Debug\MediaTekDocuments.xml AnyCPU diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..43b76b7 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,157 @@ + + + + + + Documentation Technique - MediaTekDocuments + + + + + + +
+

Documentation Technique MediaTekDocuments

+

Cette documentation détaille les classes, méthodes et structures de données de l'application de gestion MediaTekDocuments.

+ +
+

Espace de noms : MediaTekDocuments.controller

+ +

Classe FrmAuthController

+

Contrôleur gérant l'authentification des utilisateurs.

+ + + + + + +
MéthodeDescription
GetConnection(login, pwd)Vérifie les identifiants. Retourne un objet Utilisateur ou null.
+ +

Classe FrmMediatekController

+

Contrôleur principal servant d'interface entre la vue et la couche d'accès aux données.

+ + + + + + + +
MéthodeDescription
GetAllLivres() / GetAllDvd() / GetAllRevues()Récupère l'intégralité des documents par type.
GetExemplairesRevue(idDocument)Récupère la liste des exemplaires pour une revue donnée.
GetCommandesDocument(idDocument)Récupère les commandes (Livres/DVD) associées à un document.
UpdateSuiviCommande(idCommande, idSuivi)Met à jour l'état d'avancement d'une commande.
CreerAbonnement(abonnement)Enregistre un nouvel abonnement en base de données.
+
+ +
+

Espace de noms : MediaTekDocuments.dal & manager

+ +

Classe Access

+

Implémentation du pattern Singleton pour l'accès centralisé aux données via l'API.

+ + + + + +
MembreDescription
GetInstance()Retourne l'instance unique de la classe Access.
convertToJson(nom, valeur)Sérialise un couple clé/valeur pour les envois à l'API.
GetNextCommandeId()Récupère le futur identifiant de commande disponible.
+ +

Classe ApiRest

+

Gère les appels HTTP bas niveau vers l'API Rest.

+
    +
  • RecupDistant(methode, message, parametres) : Point d'entrée unique pour GET, POST, PUT, DELETE.
  • +
+
+ +
+

Espace de noms : MediaTekDocuments.model

+

Les classes modèles représentent les entités métier du domaine.

+ +

Classe Livre (hérite de LivreDvd)

+ + + + + +
PropriétéTypeDescription
IsbnstringCode ISBN unique du livre.
AuteurstringNom de l'auteur.
CollectionstringCollection éditoriale.
+ +

Classe Dvd (hérite de LivreDvd)

+ + + + + +
PropriétéTypeDescription
DureeintDurée en minutes.
RealisateurstringNom du réalisateur.
SynopsisstringRésumé du film.
+ +

Classe Abonnement

+

Gère les informations liées aux contrats de revues.

+
    +
  • DateFinAbonnement : Détermine la période de validité du contrat.
  • +
  • Montant : Coût de l'abonnement.
  • +
+ +

Classe CommandeDocument

+

Représente l'achat d'un exemplaire de livre ou de DVD.

+
    +
  • NbExemplaire : Quantité commandée.
  • +
  • IdSuivi / LibelleSuivi : État actuel (en cours, reçu, etc.).
  • +
+
+ +
+

Espace de noms : MediaTekDocuments.view

+

Classe FrmMediatek

+

Interface principale de l'application. Elle contient la logique de filtrage et d'affichage.

+ + + + + +
MéthodeDescription
AlerteAbonnementsExpirants()Vérifie au démarrage les abonnements finissant sous 30 jours.
PeutSupprimerAbonnement()Contrôle métier : interdit la suppression si des exemplaires ont été reçus.
RemplirComboCategorie()Méthode générique pour peupler les listes déroulantes (Genre, Public, Rayon).
+
+ +
+ +
+ + + \ No newline at end of file