Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardisation des noms des templates. #175

Closed
noelma opened this issue Aug 10, 2020 · 0 comments
Closed

Standardisation des noms des templates. #175

noelma opened this issue Aug 10, 2020 · 0 comments
Assignees
Labels
change Change in functionality evolution New feature or request

Comments

@noelma
Copy link
Member

noelma commented Aug 10, 2020

Le but est d'éviter les collisions de templates.
C'est-à-dire que si 2 modules utilisent des templates portant le même nom, il y a un risque de collision.

Les règles de nommages suivantes seront obligatoires pour les modules du cœur :

  • Tous les répertoires contenant les templates doivent être situés dans le répertoire Views,
  • Les templates métier doivent être placés dans un répertoire portant le même nom que le module en camelCase
  • Le nom des template sont égalements en cameCase,
    • Le nom d'un template doit commencer par le nom de la fonction qu'il occupe dans le thème (content, submenu, filter, modal, menu...),
    • Puis le nom du contrôleur l'utilisant,
    • En enfin le nom de la méthode, si plusieurs méthodes utilisent le template, un nom générique peut-être utilisé (par exemple form pour les méthodes create, edit et remove).
  • Les templates utilisés pour l'installation doivent être placés dans un répertoire nommé install à la racine du répertoire Views,
  • Les templates utilisés pour les hooks d'autres modules comme block doivent être placés dans un répertoire nommé components puis dans un répertoire nommé du module utilisant ces template. Dans des template du module block l’arborescence ressemble à : Views/components/block.

Exemples de nom de template :

  • Pour le formulaire du module configuration config/content-config-form.php,
  • Pour la page personnel des utilisateurs user/content-user-show/php,
  • Pour les formulaires d'ajout, d'édition et suppression d'un utilisateur user/content-user-form.php,
  • Pour la page d'administration des rôles utilisateurs user/content-role_manager-admin.php
@noelma noelma added evolution New feature or request change Change in functionality labels Aug 10, 2020
@noelma noelma self-assigned this Aug 10, 2020
@noelma noelma changed the title Standardisation des noms des templates Standardisation des noms des templates. Aug 10, 2020
@noelma noelma closed this as completed Sep 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change Change in functionality evolution New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant