Frappe Framework
Comprendre les DocTypes
Le DocType est la brique fondamentale de Frappe Framework : il décrit à la fois le modèle et la vue de vos données et génère une table en base. Cette page introduit le concept, ses conventions de nommage et les vues obtenues automatiquement.
Plan de la section DocTypes
Cette introduction ouvre une série de pages consacrées aux DocTypes :
- Introduction (cette page)
- Modules
- DocField
- Nommage des documents
- Contrôleurs : méthodes de contrôleur et hooks de contrôleur
- DocType enfant (table)
- DocType Single
- DocTypes virtuels
- Actions et liens
- Personnaliser les DocTypes
Qu’est-ce qu’un DocType ?
Un DocType est la brique de base de toute application construite avec Frappe Framework. Il décrit à la fois le modèle (Model) et la vue (View) de vos données : quels champs sont stockés, comment ils se comportent les uns par rapport aux autres, et comment vos données sont nommées. Il active aussi un riche mécanisme de correspondance objet-relationnel (Object Relational Mapper, ORM), détaillé plus loin dans ce guide. Quand vous créez un DocType, un objet JSON est créé, qui crée à son tour une table dans la base de données.
À retenir
Un ORM est simplement un moyen pratique de lire, écrire et mettre à jour des données en base sans écrire explicitement de requêtes SQL.
Conventions
Pour favoriser le développement rapide d’applications, Frappe Framework suit quelques conventions standard :
- Le nom d’un DocType est toujours au singulier. Pour stocker une liste d’articles, nommez le DocType Article.
- Les noms de tables sont préfixés par
tab. La table du DocType Article s’appelle donctabArticle.
Créer un DocType
La façon standard de créer un DocType consiste à taper new doctype dans la barre de recherche du bureau (Desk). La documentation officielle illustre cette étape par une capture d’écran du DocType ToDo.
Un DocType ne stocke pas seulement des champs : il contient aussi d’autres informations sur la manière dont vos données se comportent dans le système. C’est ce qu’on appelle le Meta. Comme ces métadonnées sont elles aussi stockées dans une table de la base de données, il est facile de les modifier à la volée sans écrire beaucoup de code.
À retenir
Un DocType est lui-même un DocType. Autrement dit, les métadonnées sont stockées comme une partie des données.
Les vues générées automatiquement
Une fois un DocType créé, Frappe fournit de nombreuses fonctionnalités prêtes à l’emploi. Si vous allez sur /app/todo, vous êtes dirigé vers la vue liste (List View) du bureau.
De même, vous disposez d’une vue formulaire (Form View) à la route /app/todo/000001. Le formulaire sert à créer de nouveaux documents et à les consulter.
La documentation officielle illustre ces deux vues par des captures d’écran de la liste et du formulaire ToDo.