SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

286 Plugins, 197 contribs sur SPIP-Zone, 217 visiteurs en ce moment

Accueil > Outils pour plugins > Tutoriaux pour Plugins > Convention de nommage pour le code des plugins

Convention de nommage pour le code des plugins

30 mai 2007 (Date de rédaction antérieure : 27 mai 2007). – par NicolasR, support, toggg – commentaire

1 vote

Une proposition pour éviter les conflits de noms entre les actions de différents plugins.

ceci fait suite à une discussion sur irc le dimanche 27 mai 2007 à propos d’une recommandation manquante pour les plugins.

Constat : un espace de nommage unique

Un plugin peut fournir des execs et des actions. Peu de différences si ce n’est que l’un est privé et le second public (grosso modo). Ils partagent en tout cas une chose, c’est qu’ils sont basés sur une recherche d’un fichier exec/xxx.php ou action/xxx.php

Tout cela pour dire que ces « xxx » ne sont pas infinis (on appelle ça un espace de nommage unique). Donc, pitié ! Lorsque vous adoptez un nom pour une action ou un exec de votre plugin, veuillez assurer qu’il est assez particulier pour votre plugin.

Un exemple célèbre est « spip-listes » qui utilise ou utilisait exec=config. On peut croire que c’est la config générale de spip ? et bien non c’est juste celle de « spip-listes » ... Cette appropriation est une des raisons pour laquelle cfg s’appelle cfg et pas config.

Proposition de convention

La seule solution pratique est de préfixer le nom, par exemple, nous parlions avec BoOz de renommer ce spip-listes/exec/config.phpen
spip-listes/exec/sl_config.php ou spip-listes/exec/listes_config.php (en préfixant le nom de fichier donc). Ce qui donnerait ecrire/?exec=sl_config... etc.

Je donnerais aussi l’exemple de « spixplorer » dont toutes les actions sont des
spx_machin.

Idéalement, il faudrait meme utiliser le « prefix » du plugin, dont l’unicité est assurée, comme prefixage de tous les noms de fichiers de chaque plugin ainsi que le suggère Cédric. Evidemment, cela fait des noms à rallonge, mais ils faut savoir que ça n’est qu’interne, en général, ça correspond à un bouton à cliquer.

Ma proposition était même de réserver les noms très génériques au core de SPIP . Car je ne pense pas qu’une solution compliquée coté core fasse l’affaire. C’est très, très bien que les noms d’actions ou execs se limitent à un nom pour celui ci.

La suite

Débat sur le forum ci-dessous

P.-S.

Merci à Nicolasr d’avoir transformé cette discussion en convention.

Dernière modification de cette page le 30 mai 2007

Retour en haut de la page

Vos commentaires

  • Le 31 mai 2007 à 20:04, par cam.lafit En réponse à : Convention de nommage pour le code des plugins

    Bonjour

    Je serais assez d’accord pour donner en prefixe le nom complet du plugin.
    Cela donne peut etre un truc à rallonge mais c’est deja le cas pour les fonctions interne aux plugins.

    De plus pas de surprises à la lecture du exec/xxx.php . Car spx, ou bien sl ou listes c’est pas necessairement évident à deviner.

    Répondre à ce message

Répondre à cet article

Qui êtes-vous ?
  • [Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • ciag : plugin « Groupes d’auteurs »

    30 novembre 2011 – 16 commentaires

    Ce plugin facilite l’affectation des auteurs aux rubriques, via des groupes d’auteurs. Il offre également des vues globales des affectations de rubriques aux auteurs. Les objectifs de ce plugin Le premier objectif est de faciliter (...)

  • Bazar

    8 octobre 2015 – 21 commentaires

    Un squelette pour étaler son bazar sur l’accueil. Bazar est un squelette HTML5/CSS3 issu du squelette neo-dist (http://zone.spip.org/trac/spip-zone/browser/_core_/plugins/neo-dist) : c’est un choix fait au départ, qui à l’avantage d’intégrer (...)

  • LinkCheck : vérificateur de liens

    13 février 2015 – 70 commentaires

    Ce plugin permet de chercher et tester l’ensemble des liens présents dans les objets. Vous pourrez donc en quelques clics connaître les liens brisés ou défectueux qui se sont immiscés dans le contenu de votre site SPIP. La vérification s’effectue en (...)

  • Dublin Core

    21 septembre 2010 – 28 commentaires

    Un petit squelette pour l’insertion de méta-données Dublin Core dans la partie head des articles. Le Dublin Core « Le Dublin Core est un schéma de métadonnées générique qui permet de décrire des ressources numériques ou physiques et d’établir des (...)

  • Le plugin ZotSpip

    28 mai 2012 – 136 commentaires

    Synchronise Spip avec une bibliothèque (personnelle ou partagée) de références bibliographiques Zotero. Utilisez Zotero pour gérer / importer / rédiger vos références bibliographiques, puis incorporez vos références bibliographiques dans votre Spip avec (...)