modelemvc

Mode d'emploi du projet mod�le MVC-entity

*-*-*-*-*-*
historique
v0.1 13/07/2016 (Julien Legrand) : 1�re version
*-*-*-*-*-*

# Actions � faire apr�s copie
1. Renommer les projets en suivant ce sch�ma : "CD67.[nom appli].[Entity/Factory/MVC/Tests/Batchs]"
2. Renommer �galement les assemblies et espaces de nom de chaque projet (dans les propri�t�s des projets, onglet "Application")

x. Cr�er vos propres fichiers d'extension avec DataAnnotation ici : "CD67.ModeleMVC.Entity\Extend" et supprimer le fichier d'exemple "CD67.ModeleMVC.Entity\Extend\PARAM.cs"
x. Cr�er vos propres factory ici : "CD67.ModeleMVC.Factory" et supprimer le fichier d'exemple "CD67.ModeleMVC.Factory\PARAMFactory.cs"

10. supprimer ce fichier pour ne pas que l'on sache que vous avez utilis� un mod�le


# Description g�n�rale
La solution est consitu�e de 4 projets :
- CD67.ModeleMVC.Entity : Projet qui contient les objets m�tiers, c'est � dire dans le cas de projets Entity : le mod�le entity framework
- CD67.ModeleMVC.Factory : Projet qui contient les classes permettant la gestion des objets : les actions CRUD pour chacun � minima
- CD67.ModeleMVC.MVC : Projet qui comprent le site Web MVC
- CD67.ModeleMVC.Tests : Tests unitaires


# CD67.ModeleMVC.Entity
Le mod�le se nomme par d�faut "EntityModel"

Le dossier "Extend" contient les extensions �ventuelles de classe Entity (qui se trouvent dans "EntityModel.edmx\EntityModel.tt\").
C'est notamment utile pour ajouter les DataAnnotations permettant de d�crire le donn�es en vue d'une g�n�ration de contr�les plus appropi�s dans les vues MVC.
Attention � bien surveiller l'espace de noms lors de la cr�ation d'une classe dans ce sous-dossier (erreur fr�quente) :
- par d�faut ce sera : "CD67.ModeleMVC.Entity.Extend",
- mais il faut "CD67.ModeleMVC.Entity" (le m�me que les classes de bases Entity).

Le dossier "Internal" contient :
- "FormattedDbEntityValidationException.cs" : classe h�rit�e de Exception qui permet un affichage plus complet dans les messages d'erreur pour les exceptions li�es au format de donn�es du mod�le Entity
- "Entities.cs" : classe partielle permettant d'utiliser les nouvelles Exceptions FormattedDbEntityValidationException en surchargeant "SaveChanges()"
En cas d'ajout d'une nouvelle connexion avec Entity Framework, il faut ajouter une nouvelle classe d'extension du m�me type.


# CD67.ModeleMVC.Factory
Les classes Factory sont nomm�es ainsi : "[Nom objet]Factory"
On cr�e autant de classe Factory que d'objet � g�rer
Elles doivent contenir un constructeur public avec le context Entities en param�tre qui se base sur le constructeur de la classe parente.
Elles contiennent g�n�ralement les fonctions suivantes : getById, getAll, add, update, delete.
C'est � adapter � chaque cas.

Le dossier "Internal" contient la classe de base "baseFactory" dont chaque "Factory" h�rite.


# CD67.ModeleMVC.MVC
La partie Model du projet n'est pas n�cessaire que pour d�finir des classes ne servant qu'� l'affichage, les classes m�tiers �tant dans le projet Entity.

Le dossier "Views" contient par d�faut :
- "Shared\_AppLayout.cshtml" : une page de disposition pour l'application
- "DisplayTemplates\YesNo.cshtml" et "EditorTemplates\YesNo.cshtml" : ils s'agit d'exemple de personnalisation d'affichage pour un type de champ, ici "YesNo". On attribut un type avec la DataAnnotation "[UIHint("YesNo")]" dans la classe Metadata et ce sont les fichiers dans DisplayTemplates et EditorTemplates du m�me nom qui seront utilis�s pour cr�er le contr�le � l'affichage.

Le dossier "style" contient :
- un sous dossier "images" destin� � contenir toutes les images utilis�es dans la mise en page
- "AppStyleSheet.css" : feuille de style � modifier pour le projet courant
- "ModeleStyleSheet.css" : feuille de style du mod�le CD67 � ne pas modifier


# CD67.ModeleMVC.Tests
Projet le plus important de la solution :)