La Fabrique

Publié le : 20 avril 2012 – Dernière modification le 18 juin 2023 – par Matthieu Marcillaud – 388 commentaires

1
2
3
4
5
123 votes

La Fabrique est un outil pour créer des plugins, essentiel dans la phase de développement d’un site SPIP. La Fabrique est capable de générer le code source minimal d’un plugin pour SPIP 3 (elle accélère donc le démarrage d’un plugin) et peut s’occuper également de construire un plugin fonctionnel gérant un ou plusieurs objets éditoriaux et leurs liaisons (et là, elle devient formidable !). La base du plugin construit, il ne vous reste plus qu’à l’adapter à vos désirs les plus créatifs.

La Fabrique est un outil de construction de plugin spécialement orientée pour la gestion d’objets éditoriaux. Pour ceux qui ont connu le plugin « Chat » ou « Chat2 », sachez que la Fabrique sait gérer tout ce qui est présent dans ce tutoriel / plugin, et même au-delà, bien au-delà.

N’allez pas trop vite !

Cette note est aussi présente lors de l’installation du plugin, mais redisons le encore :

  • la Fabrique crée un code fonctionnel mais qui ne répondra peut être pas à 100% de vos attentes. La Fabrique ne peut pas tout faire. À vous d’adapter ensuite le code généré.
  • un plugin est très vite fait grâce à la Fabrique. Mais attention : le code n’est qu’une partie d’un plugin. Si vous voulez que votre plugin perdure dans le temps, il faut qu’il soit utile, partagé, documenté, traduit, il faut assister les utilisateurs, et maintenir son code avec les évolutions de SPIP et c’est tout cela aussi un plugin !
  • la Zone de SPIP permet de collaborer sur les plugins. Essayez au maximum de ne pas créer des plugins existant déjà, pour éviter des doublons qui peuvent disperser d’autant les énergies pour toutes les tâches citées au point précédent.

Pré-requis

Pour faire fonctionner la Fabrique il faut :

  • PHP >= 5.3 (il est possible que 5.2 fonctionne aussi)
  • SPIP 3.0-RC minimum
  • Un navigateur récent (testé avec FF11 et Chrome 18.0)
  • Saisies >= 0.25
  • Et peut être un système Unix/Linux pour son serveur (appel de exec('diff') en PHP) [1]

Optionnellement mais conseillé :

Démonstration vidéo

Dans la vidéo suivante, vous verrez une présentation de la Fabrique impliquant la construction d’un plugin « Félins » dans lequel nous créons 1 objet éditorial « Chats ».
Cette vidéo est aussi disponible en meilleure qualité sur medias.spip.net

Présentation de la Fabrique en vidéo

Accéder à la fabrique

Depuis SPIP 3.1, La fabrique est accessible dans le menu de développement (il faut activer l’option de vos préférences personnelles pour voir ce menu)

Documentation

En attendant une documentation plus riche ici, vous pouvez lire ces articles :

Capture d’écran

La Fabrique, version 1.13.3
Interface d’accueil de la Fabrique avec un objet éditorial « Chats » de renseigné dans un plugin nommé « Félins »

À tester

« La Fabrique » doit être testée dans différents environnements. Vous êtes donc invités à explorer cet outil développé avec git sur la Zone [2]

Limitation connue

Actuellement (version 1.16.3), à partir d’un certain nombre d’objets et de champs (environ 10 objets * 8 champs ici), le formulaire devient naturellement inopérant à cause d’une limitation voulue de PHP : max_input_vars, par défaut à 1000 dans php.ini.
Pour contourner, il faut modifier php.ini pour tolérer plus de champs (5000) par exemple.

Attention

Depuis la version 2.0.0, le menu de la fabrique se trouve dans celui de Développement. Celui-ci est activable depuis l’espace préférence de l’utilisateur.

Notes

[1] À faire vérifier par quelqu’un ayant un serveur local sous Windows

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

137 discussions

  • 2
    Davidoff

    Bonjour, utilisateur depuis longtemps de ce plugin merveilleux, je rencontre un petit soucis de débutant. Je n’ai jamais eu besoin d’afficher du texte formaté dans les précédentes réalisations. Mais là, sur un champ qui ne s’appelle pas TEXTE ou DESCRIPTIF, j’ai bien la possibilité de formater le texte (gras, italique, liste, etc...) mais impossible d’afficher le texte formaté dans le site public comme il le fait pour le champ TEXTE. J’ai bien regardé du côté des filtres applicables aux texte, mais je n’ai rien trouvé.

    Merci d’avance pour l’astuce qui doit être très simple...

    • Matthieu Marcillaud

      Dans un squelette, ça serait |typo ou |propre.
      Cela dit c’est mieux de le déclarer dans le plugin tant qu’à faire, une fois qu’il a été généré, dans le fichier base/{prefixe}.php en utilisant la constante _TRAITEMENT_RACCOURCIS dans le pipeline déclarant les traitements des champs.

      Exemple :

      // syntaxe
$interfaces['table_des_traitements']['NOMCHAMP']['nomtablesansprefixe'] = 'letraitement(%s)';
// spécifique
$interfaces['table_des_traitements']['TYPE']['mots'] = _TRAITEMENT_RACCOURCIS;

      Regarder d’autres plugins pour s’inspirer, tel que :

      MM.

    • Davidoff

      Bonjour Matthieu et merci pour cette réponse. J’avais fini par retrouver le filtre. Je vais essayer de le déclarer dans le plugin (base/prefixe.php).

      Bravo pour tout ton travail et toutes les aides que tu apportes à beaucoup de monde, ici et ailleurs, car je tombe souvent sur tes écrits numériques. Ta rapidité et ton efficacité nous permettent d’avancer plus rapidement, et l’existence même de ce plugin justifie largement l’utilisation de SPIP. Encore une fois, BRAVO et MERCI !

    Répondre à ce message

  • koan

    Bonjour,
    Je trouve se plugin très utile pour commencer le développement d’un plugin sans trop de difficulté.

    Mais j’ai un souci, j’ai commencé par voir ce que cela pouvait donner en créant un plugin avec un objet éditorial créer de 0, la création est OK mais quand je veux éditer un nouvel objet j’ai le message d’erreur suivant :

    Erreur SQL 1146
    Table ’spip.spip_suivis’ doesn’t exist
    SELECT suivis.id_suivi, 0 as points, ’’, suivis.titre, suivis.titre AS titre_rang FROM spip_suivis AS suivis GROUP BY suivis.id_suivi ORDER BY 0+suivis.titre, suivis.titre

    Je comprends que ma table spip_suivis n’existe pas. Pourquoi La Fabrique n’a pas créé ma table ? Suis-je passé à côté de quelque chose ?
    J’ai pourtant suivis l’exemple de la video des félins...

    pour information, j’utilise :

    • spip v.3.1.6
    • La Fabrique 2.3.11

    Merci de votre aide ou éclaircissement.

    Répondre à ce message

  • 4
    Sauterey Francois

    Je viens de créer une ébauche de plugin destinée à gérer des « auteurs de livres » autrement désignés « écrivains » (le plugin s’appellera... ecrivain).
    J’ai décris les tables du nouvel objet éditorial, et fabrique m’a bien généré le fichier ecrivain_administration.php (jusque là, tout va bien !)
    fichier qui contient
    function ecrivain_upgrade($nom_meta_base_version, $version_cible)
    $maj = array() ;
    $maj[’create’] = array(array(’maj_tables’, array(’spip_ecrivains’, ’spip_ecrivains_liens’))) ;
    include_spip(’base/upgrade’) ;
    maj_plugin($nom_meta_base_version, $version_cible, $maj) ;

    MAIS à l’activation du plugin seule la table de jointure est crée, pas la table principale :-(
    Le fichier fabrique_ecrivain.php.zip est disponible ici :
    http://w3.adapt.snes.edu/IMG/zip/fabrique_ecrivain.php.zip

    Bon, au pire, je vais créer la table à la pain pour continuer...

    • Sauterey Francois

      Bon, en reprenant tout de puis le début, tout fonctionne bien :-) (Merci Matthieu pour la vidéo !)
      Bon mon plugin « fonctionne », il me reste à lui faire faire ce que je veux !
      Je cherche un espace où discuter du développement de celui-ci sans polluer les espaces de discussion bien connus... Ça existe ?

    • pamillet

      effectivement

      mais ce n’est pas dans le nom d’objet, mais dans le nom de la table
      et il faut après l’avoir changé comme nom de table, aller modifier les noms d’identifiant qui trainent...

      merci
      pam

    • LauDai

      Bonjour,

      j’ai exactement le même problème. La table principale n’est pas créée. Mais j’ai beau recommencer depuis le début, j’ai le même problème. Avez vous compris ce que vous ne faisiez pas correctement ?

      J’ai également quelques autres dysfonctionnements, par exemple le prebuild ne fonctionne pas. En indiquant une table (p.ex., spip_article) le bouton est ineffectif.

      Une idée ?

    • Luc

      Le prebuild ne marche pas pour moi non plus. Par contre, si les tables des nouveaux objets ne se créent pas, vous pouvez toujours procéder à une Réparation de la base de données. Ce n’est peut-être pas l’idéal, mais ça a fonctionné pour moi.

    Répondre à ce message

  • jpcrea

    Bonjour à tous,

    Dans l’écriture d’un champ de type « radio », j’ai érit :
    datas=[(#ARRAY{cle1,Faible,cle2,Modéré,cle3,Moyen,cle4,Élevé,cle5,Fort})]

    A l’édition : ce sont les « cle » qui apparaissent à la place des valeurs.
    Je n’ai pas dû comprendre quelque chose ?
    Merci de vos lumière,
    jpcrea

    Répondre à ce message

  • 1
    jpcrea

    Bonjour,

    Ce magnifique plugin m’a permis de créer facilement un nouvel objet pour publier des recettes de cuisine qui fonctionne très bien.

    Mais j’ai, lorsque je désire modifier la recette : « Modifier cette recettes » avec un « s » ;
    J’avais effectivement, dans un premier temps, mis par erreur un « s » lors de la création du plugin, j’ai rectifié, mais j’ai toujours ce « s » qui m’embête bien .
    Que faire, je ne vois plus ou aller pour rectifier cette anomalie ?
    Merci de vos lumières.

    Répondre à ce message

  • 2
    Franck

    Bonjour à tous...
    Version Fabrique 2.3.11 :
    Juste pour vous informer qu’il me semble qu’une petite erreur d’écriture s’est glissée dans le fichier fabrique/fabrique/prefixe_autorisations.php.html
    Ligne 63, remplacer :

    function autoriser_#GET{type}creer_menu_dist($faire, $type, $id, $qui, $opt) {
	return autoriser('creer', ['(#TYPE)'], '', $qui, $opt);
}(#VAL{outils_rapides}|in_any{#VALEUR{boutons}})]

    par :

    function autoriser_#GET{type}_creer_menu_dist($faire, $type, $id, $qui, $opt) {
	return autoriser('creer', ['(#TYPE)'], '', $qui, $opt);
}(#VAL{outils_rapides}|in_any{#VALEUR{boutons}})]

    Il manque un underscore entre « #GETtype » et « creer_menu_dist ».

    Cela entraîne le plantage d’un site lors de l’activation d’un plugin généré par la fabrique et utilisant cette fonction.
    Bon développement ! et merci pour ce super plugin !

    • Matthieu Marcillaud

      Non non, cette écriture est correcte et doit générer autoriser_chatcreer_menu_dist(...)

      Voir par exemple dans ecrire/inc/autoriser.php la fonction autoriser_articlecreer_menu_dist.

      Il y a quelques autorisations un peu spécifiques $type$verbe_xxx de la sorte.

      Maintenant que dans ton cas cela provoque une erreur d’activation est plus ennuyant. Il faudrait avoir plus de détail sur l’erreur ?

    • Franck

      Bonjour Mathieu,
      Merci pour ta réponse rapide...
      Ok, pourtant si je ne corrige pas de la façon indiquée, Fabrique génère un fichier prefixe_autorisations.php (prefixe = prefixe de votre plugin) avec la fonction suivante :

      function autoriser_prefixecreer_menu_dist($faire, $type, $id, $qui, $opt) {
	return autoriser('creer', 'prefixe', '', $qui, $opt);
}

      Ce qui fait planter mon site spip de dev (3.1.4 ).
      Si je corrige avec :

      function autoriser_prefixe_creer_menu_dist($faire, $type, $id, $qui, $opt) {
	return autoriser('creer', 'prefixe', '', $qui, $opt);
}

      Tout est OK.
      Je vais investiguer, sans doute que quelque chose en amont en avale cloche et qu’en changeant la syntaxe je désactive la fonction qui entraîne le crash...
      Merci encore !

    Répondre à ce message

  • 1
    LauDai

    Bonjour et bravo pour ce plugin vraiment très utile,

    Le plugin Fabrique propose t il un moyen de modifier une version précédente de son plugin qui serait déjà en exploitation et ce sans perdre les données qui seraient déjà saisies ? On peut supposer que l’évolution consisterait à ajouter des champs sur le tard pour s’adapter à un nouveau besoin.

    Merci !

    • Matthieu Marcillaud

      Oui et non.

      La fabrique génère un fichier fabrique_{prefixe}.php à la racine du plugin, qui est une sauvegarde de toutes les données du formulaire.
      Par contre ça n’a aucune information sur les fichiers que tu aurais pu avoir modifié / créés à la main, après la création du plugin.

      Ce fichier peut être réimporté pour recréer le plugin depuis la Fabrique (et ajouter des champs donc). Cependant, les actions de mises à jour ne seront pas créées. Il faut t’inspirer d’autres plugins pour ce faire, mais cela consiste à :
      -  augmenter le schéma dans paquet.xml
      -  ajouter un $maj[’x.y.z’] = ... dans le fichier xxx_administrations.php (du numéro de schéma), avec les actions à faire.

      Cela peut être pour ajouter les champs manquants sur spip_matables quelque chose tel que :

      $maj['1.1.0'] = array(array('maj_tables', 'spip_matables'));

      Tu as plein de beaux exemples ici :
      https://zone.spip.org/trac/spip-zone/browser/_plugins_/gis/trunk/gis_administrations.php

      MM.

    Répondre à ce message

  • 3
    pamillet

    bonjour

    découvrant (impressionné !) la fabrique, je fais un premier essai avec qq objets liés, la génération se passe bien, mais j’ai systématiquement une erreur lors de l’activation du plugin...

    Parse error : syntax error, unexpected ’-’, expecting ’(’ in /home/venissie/test/spipr/plugins/fabrique_auto/elec/elec_autorisations.php on line 259

    au cas ou j’ai coché le fichier autorisations...sabs changements...
    je en vois rien de particulier dans elec_autorisations à la ligne indiquée...

    je n’ai fait que des objets éditoriaux avec qq champs et des liaisons indirectes entre eux...

    merci d’avance d’une piste...

    pam

    • Matthieu Marcillaud

      Si tu peux mettre dans un pastebin le code généré pour ce fichier d’autorisations, cela pourrait aider à comprendre. Par exemple sur http://spip.pastebin.fr/
      Merci.

    • pamillet

      c’est fait...

      http://spip.pastebin.fr/50123

      la ligne 259 signaliée est la définition de fonction sur un des objets...

      function autoriser_spip-resultat_creer_dist($faire, $type, $id, $qui, $opt) {
	return in_array($qui['statut'], array('0minirezo', '1comite'));
}

      merci

    • Matthieu Marcillaud

      Ah voilà une blague quelle est bonne :)

      Bon, donc, il ne faut pas mettre de - dans les noms de tes objets. Tu peux utiliser le _ de préférence je pense.

      Bizarre que je n’ai pas de test sur ce cas. Je verrais, mais je pense que tu as la réponse.

    Répondre à ce message

  • 2
    joz

    Bonjour,
    J’ai un plugin crée avec fabrique, qui ajoute deux tables à la base.
    Depuis la dernière mise à jour spip je reçois cet erreur :

    Unknown column 'projets.date' in 'where clause'
SELECT projets.id_projet, projets.titre, projets.texte FROM spip_projets AS <span class="base64" title="PGNvZGUgY2xhc3M9InNwaXBfY29kZSBzcGlwX2NvZGVfaW5saW5lIiBkaXI9Imx0ciI+cHJvamV0czwvY29kZT4="></span> INNER JOIN spip_mots_liens AS L2 ON ( L2.id_objet = projets.id_projet AND L2.objet='projet') INNER JOIN spip_projets_liens AS L1 ON ( L1.id_projet = projets.id_projet ) WHERE (projets.statut = 'publie') AND projets.date<'2016-11-27 00:01:00' AND (L1.id_objet = 2117) AND (L1.objet = 'article') AND (L2.id_mot = 645) GROUP BY projets.id_projet

    squelette : /monchemin/ecrire/public/composer.php
    boucle : calculer_select(){ sql_select(); }

    Je n’ai effectivement pas de champs « date » dans ma table, et je n’en ai pas besoin. ça m’embête que ce squelette en a besoin. Est-ce que c’est indispensable ? Est-ce que c’est qqchose qu’il faudrait savoir avant de créer son plugin ?

    J’ai contourné l’affichage de l’erreur en ajoutant tout à ma boucle sur cette table...

    Merci d’avance pour vos lumières

    • Matthieu Marcillaud

      Bonjour joz,

      Peux tu préciser de quelle mise à jour tu parles ? de SPIP (et de quelle version à quelle version ?) ou de la Fabrique ? à quel endroit tu as cette erreur ?

    • joz

      Ah oui, sorry : c’est depuis la dernière màj spip que j’ai eu ce problème, vers spip 3.1.3

      J’ai cette erreur sur une page ou j’utilise l’objet « projet » que je cré avec mon plugin. C’est sur ma boucle (PROJETS) où j’ai ajouté {tout} pour que l’erreur ne s’affiche plus.

      J’espère que je m’exprime un peu compréhensible...

    Répondre à ce message

  • 2
    Julien Lanfrey

    Bonjour,

    J’ai relevé un bug quand on utilise « pré-construire » sur l’interface de définition d’un nouvel objet éditorial.

    Si dans la table SQL de notre objet, on a une colonne « id_secteur », celle-ci se retrouve définie au niveau de la section « Champs » et la case à cocher dans la section « champs spéciaux » ne l’est pas. Ça fonctionne en revanche pour « id_rubrique » : « champs spéciaux » coché et rien dans « champs ».

    Voici le schéma SQL utilisé sur lequel je me suis appuyé.

    CREATE TABLE spip_pomme (
  id_pomme bigint(21) NOT NULL AUTO_INCREMENT,
  id_rubrique bigint(21) NOT NULL DEFAULT '0',
  id_secteur bigint(21) NOT NULL DEFAULT '0',
  titre text NOT NULL,
  variete varchar(255) NOT NULL DEFAULT '',
  date datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
  statut varchar(10) NOT NULL DEFAULT '0',
  maj timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (id_pomme),
  KEY id_rubrique (id_rubrique),
  KEY id_secteur (id_secteur),
  KEY statut (statut,date)
) ENGINE=MyISAM  DEFAULT CHARSET=utf8;
    • Matthieu Marcillaud

      Ah oui, bien vu.
      La version 2.2.1 corrige ce point.
      Je considère qu’il faut forcément id_rubrique pour que id_secteur soit pris en compte aussi.

      Merci.

    • Julien Lanfrey

      Ça fonctionne, merci.

      Je viens de voir la réorganisation avec les sections « liaisons directes/indirectes » : de mieux en mieux. C’est un un plaisir d’utiliser cet outil !

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

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

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom