La Fabrique

Published : 20 April 2012 – updated on 17 March 2021 – by Matthieu Marcillaud – 372 commentaires

1
2
3
4
5
119 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» débute sa vie publique et doit être testée dans différents environnements. Vous êtes donc invités à explorer cet outil développé maintenant 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.

Footnotes

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

Discussion

5 years 1 year 3 months Without limit
par date
Filter

132 discussions

  • 1
    baloo

    Bonjour,
    j’essaye de faire un pluging avec la fabrique. Dans l’ensemble cela fonctionne bien. Il me reste un point que je n’arrive pas à comprendre :

    J’ai un objet X qui dépend en liaison directe d’un objet Y et qui peut être rattaché à des rubriques et des articles.
    Je vois bien la liste des objets X de l’objet Y.
    Je vois bien la liste des objets X.
    par contre si je rattache un objet x par exemple a 2 rubriques, j’ai dans la page de l’objet
    Liés à cet objet X et la liste de toutes les rubriques.
    J’ai vue que cela venait de l’element généré
    objets/liste/#GET{liste},objet,id_Y_X,ajax,env} />
    avec #GETliste=rubrique qui va chercher le code dans prive/objets/liste/rubriques de la dist 3.2
    Je n’arrive pas à résoudre ce pb même en mettant id_Y_X=#ID_OBJET
    savez vous comment résoudre ce pb

    • ben

      Salut,

      J’espère qu’en un an, tu as pu trouver solution à ton problème mais comme j’ai galéré pas mal avec cette même difficulté, je précise ici ce que j’ai fais pour résoudre ce problème pour les futurs galérien·ne·s :

      Dans mon cas, les objets liés sont surtout des articles, j’ai donc recopié le fichier racine-du-site/prive/objets/liste/articles.html dans plugins/xyz/prive/objets/liste et j’ai ajouté à la boucle liste_art de ce fichier le critère spip_xyz_liens.id_xyz?

      La documentation du plugin mériterait d’être clarifiée à ce niveau (avec cet exemple ?), j’ai trouvé d’autres personnes qui ne l’ont pas comprises sur ce point.

    Reply to this message

  • 1
    baloo

    bonjour,
    juste pour info pour les néophytes , je teste le mode de saisie php avec avec fabrique-issue_8 ,
    dans “options de saisie” il y a comme exemple :
    Exemple pour selection / checkbox / radio :
    datas=[(#ARRAY{cle1,valeur1,cle2,valeur2})]
    ce qui correspond au mode html
    ... peut être faudrait il indiquer la syntaxe aussi en mode php car dans ce cas cela génére

    array(
                        'saisie' => 'radio',
                        'options' => array(
                                'nom' => 'menu_selections',
                                
                                'label' => _T('page:champ_menu_selections_label'),
                                 'explication' => _T('page:champ_menu_selections_explication'),
                                'datas' => '[(#ARRAY{oui',
                                'oui' => '',
                                'non' => '',
                                'non})]' => '',
                                
                        ),
                ),

    qui bien sur ne fonctionne pas.

    Reply to this message

  • 3
    baloo

    bonjour,
    Sauriez vous t ce qui peut empêcher la création des tables alors que la création du plugin s’est bien déroulé , le plugin activé, le cache vidé?
    les tables ont un format standard nom : spip_ensembles

    SPIP 3.3.0-dev [24578]
    merci

    • Matthieu Marcillaud

      Le [24578] m’inquiète : c’est une version SVN et on n’utilise plus ça. Soit il reste un fichier .svn_revision à la racine de ton SPIP. Soit y a un autre soucis.

      Ensuite, il faut regarder tmp/log/mysql ou sqlite pour savoir quelle est l’erreur de création de la table. Ça peut être du à une mauvaise syntaxe de déclaration.

    • baloo

      cela venait de la présence d’une cote de de trop dans text NOT NULL DEFAULT “”“” difficile à voir qui ne génère pas d’erreur. La cote enlevée cela fonctionne.
      C’est bon par contre a l’affichage de la partie ’Autorisations’ de l’objet le plugin affiche deux fois xxx_voir par défaut : toujours .

    • baloo

      autan pour moi ... ne cherche pas c’est objets _voir et objet_voir ....

    Reply to this message

  • BD

    Bonjour,

    Je suis en train d’utiliser ce super plugin pour créer un objet éditorial et je rencontre deux problèmes.

    Lors d’un test (le dernier) le plugin a fait planter le spip (en local, bien sûr) avec une page blanche. Impossible donc de désinstaller le plugin depuis la page d’admin. J’ai donc supprimer le dossier du plugin et ça refonctionne. Problème: plusieurs messages d’erreurs s’affichent alors.
    -  Le premier (sur la page d’admin des plugins) m’indiquant

    "Actions non réalisées

    Le plugin « XXX » (version : 1.0.0) va être installé

    Certaines actions n’ont pas été réalisées. Cela peut provenir d’une erreur lors des actions à réaliser, ou d’un affichage de cette page alors que des actions sont encore en cours. Les actions avaient été lancées par test le 28 août 2020 à 13h54min."

    -  Le second, sur toutes les pages d’admin, m’indiquant que les deux tables que devait créer le plugin n’existent pas (Erreur SQL 1146 par le squelette /spip/ecrire/genie/maintenance.php)

    La question est la suivante: comment désinstaller proprement un plugin manuellement. Quels sont les fichiers de conf à supp? Un script a lancer?

    J’ai testé ceci https://gist.github.com/Cerdic/5848603#file-site-desactive-plugin-php mais sans succès (les chemins et fichiers ne correspondent pas).

    Je peux repartir d’un spip tout frais mais il y avoir mieux, surtout si ça arrive lors du déploiement sur le site en ligne! :s Si quelqu’un saurait comment procéder?

    Autre soucis, déjà évoqué plus bas, sûrement accessoire mais peut-être pas étranger au crash du plugin: les boutons “pré-remplir cet objet” et “supprimer cet objet éditorial” ne sont pas fonctionnels.
    Je suis sous spip SPIP 3.2.7 [24473] avec la Fabrique 2.3.15

    Reply to this message

  • YannX

    Erreur inopinée !

    Si, comme moi, vous avez chargé une version récente de Fabrique et qu’au moment de sauvegarder votre plugin, vous vous prenez une “Erreur inopinée” ?
    Je vous suggère de vérifier la version de PHP que votre serveur utilise...
    -  en PHP 5.6 j’avais l’erreur (sans en comprendre la cause)
    -  en passant sous PHP 7.2... actualiser la page restée ouverte a suffit !

    P.S.: normal que cet outil de développeur utilise les dernières possibilités du langage ! ;-)

    Reply to this message

  • escurel

    Bonjour,
    si c’est pas encore fait, je confirme que dans un environnement windows 7 pro 64bits, avec wampserver 3.1.9 (apache 2.4.33, php 5.6.35 à 7.2.4, MySQL 5.7.21, spip 3.2.5) la fabrique (2.3.15) bloque sur la génération des fichiers avec les messages suivant
    -  si le dossier /plugins/fabrique_auto/ est présent : La sauvegarde de ../plugins/fabrique_auto/alloc n’a pu être réalisée. Le plugin par précaution n’a pas été régénéré. La cause probable provient de droits insufisants ce répertoire source pour le serveur. (avec une faute “insuffisants” dans la chaîne de langue)
    -  si le dossier est absent : vérifier les droits d’écriture
    Le système a rencontré une erreur lors de l’écriture du fichier tmp/cache/fabrique/alloc /.plat. Veuillez, en tant qu’administrateur du site, vérifier les droits d’écriture sur le répertoire ecrire/tmp/cache/fabrique/alloc .
    La même chose dans un environnement Unix/Linux y a pas de soucis (sauf la faute d’orthographe ;)
    cordialement

    Reply to this message

  • Callaghan

    Salut,

    Une petite anomalie sous spip 3.2 Factory (2.3.15)
    Je crée un objet blob simple sans liaison directe, mais avec une liaison indirecte
    sur des articles

    Lors de l’édition du premier objet, nous avons une erreur de compilation:
    Argument manquant dans la balise INFO_
    ../plugins/fabrique_auto/blobings/prive/squelettes/contenu/blob_edit.html

    01 [(#ID_BLOB|oui)

02     [(#AUTORISER{modifier,blob,#ID_BLOB}|sinon_interdire_acces)]
03     [(#SET{id_parent,#INFO_{blob,#ID_BLOB}})]
04 ]

    Mauvaise utilisation ?

    Merci

    Reply to this message

  • 1
    Pascal

    Bonjour,
    je n’arrive pas à effectuer ce correctif :

    Vous pouvez sur la vue de votre objet, lister les objets (sélectionnés au dessus) qui lui sont liés. Note : il est possible que ces listes ne fonctionnent pas parfaitement, affichant l’ensemble des objets, au lieu de seulement ceux liés au votre ; il faudra alors surcharger le fichier de liste utilisé (prive/objets/liste/xxx.html) pour ajouter un critère `xxx_liens.id_xxx ?` supplémentaire.

    Pourriez-vous donner un exemple ou “xxx” en effet les fichiers sont au pluriel et le id_ au singulier...
    Voici mon code après modification la table s’appelle bien “spip_etapes_liens” avec “id_etape”:

    <BOUCLE_liste_etapes(ETAPES){id_rubrique?}{id_secteur?}{tours_liens.id_tour?}{journees_liens.id_journee?}{id_mot?}{id_auteur?}{where?}{statut?}{recherche?}{tri #ENV{par,num titre},#GET{defaut_tri}}{par titre}{pagination #ENV{nb,10}}{etapes_liens.id_etape ?}>

    Ce code provoque une erreur “Critère inconnu etapes_liens.id_etape”
    je ne comprends pas d’où vient cette erreur...
    NB : retirer l’espace devant le “?” ne change rien.

    • Mike

      Voici un exemple ou j’avais fait cette modification et qui marche:
      ajout de rivieres_liens.id_riviere? sinon
      a l’affichage d’une riviere on a tous les articles et non seulement les articles qui lui sont associes .

      \prive\objets\liste\articles.html

       
        <BOUCLE_liste_art(ARTICLES){id_article?}{id_rubrique?}{id_mot?}{id_auteur?}{rivieres_liens.id_riviere?}{where?}{statut?}{recherche?}{tri #ENV{par,date}|defaut_tri_par{#GET{defaut_tri}},#GET{defaut_tri},session_liste_art}{par titre}{pagination #ENV{nb,10}}{!lang_select}>

      => et alors seuls les articles (et non tous) auxquels une riviere est associee, sont listes quand on affiche cette riviere

    Reply to this message

  • 7
    mcommemarc

    Merci pour cet outil vraiment pratique ! J’ai créé un nouvel objet éditorial (que j’appelle “fiches”), tout fonctionne sauf les inclusions de doc.
    Je copie/colle une inclusion de doc dans un texte (exemple : doc18, entre balises ouvrante et fermante). Dans l’espace privé, ma fiche s’affiche bien avec sa jolie image.
    Dans l’espace public, impossible par contre d’afficher cette fiche avec son image. Cela m’affiche l’inclusion “doc18” en toute lettre.... Pourtant, je code exactement pareil que pour un objet “article” standard (sauf le nom des balises qui changent...).
    Ya un truc que j’ai pas dû suivre... Vous avez une idée ?

    • Matthieu Marcillaud

      Il n’y a rien de spécial à faire. Je suppose que le nom du champ (la colonne SQL) n’est pas commune pour SPIP (pas ’texte’ ou ’descriptif’ par exemple). Dans ce cas, il faut soit utiliser [(#TRUC|propre)] pour appliquer les traitements typos au cas par cas dans les squelettes, soit déclarer un traitement typo automatiquement sur cette balise, ce qui se fait dans le pipeline ’declarer_interfaces’, avec par exemple : 

      $interface['table_des_traitements']['SLOGAN']['fiches'] = _TRAITEMENT_RACCOURCIS;

      où ’SLOGAN’ est le nom du champ, et ’fiches’ le nom de la table (sans spip_).

    • mcommemarc

      Merci beaucoup Matthieu !
      Effectivement |propre fonctionne bien. Je vais de suite me renseigner par quelle magie ce filtre opère !

    • Pascal

      Bonjour,
      vous écrivez :
      “, soit déclarer un traitement typo automatiquement sur cette balise, ce qui se fait dans le pipeline ’declarer_interfaces’, avec par exemple :

      $interface[’table_des_traitements’][’SLOGAN’][’fiches’] = _TRAITEMENT_RACCOURCIS;
      où ’SLOGAN’ est le nom du champ, et ’fiches’ le nom de la table (sans spip_).”

      Où se trouve ce pipeline ’declarer_interfaces’ ?
      Cordialement

    • Matthieu Marcillaud

      Il est créé et utilisé normalement tout seul par le plugin Fabrique et est présent dans base/objet.php par exemple là : https://gitlab.com/magraine/vortaro/blob/master/base/vortaro.php#L15 ; et c’est effectivement declarer_tables_interfaces, pas declarer_interfaces.

    • Pascal

      Merci de votre réponse.
      Suite à vos commentaires j’ai modifié mon fichier “bases/tours.php” comme suit

      function tours_declarer_tables_interfaces($interfaces) {
 
	$interfaces['table_des_tables']['tours'] = 'tours';
	$interfaces['table_des_tables']['journees'] = 'journees';
	$interfaces['table_des_tables']['etapes'] = 'etapes';
//modifications
	$interface['table_des_traitements']['PTIDEJ']['journees'] = _TRAITEMENT_RACCOURCIS ;
	$interface['table_des_traitements']['DEJEUNER']['journees'] = _TRAITEMENT_RACCOURCIS ;
	$interface['table_des_traitements']['DINER']['journees'] = _TRAITEMENT_RACCOURCIS ;
// /modifications
	return $interfaces;
}

      Je n’ai aucun effet...

      Cordialement

    • Matthieu Marcillaud

      C’est pourtant il me semble la bonne écriture.
      (je me suis permis d’éditer ton commentaire pour colorer le code)

      Ah… je vois le problème : dans ton code, il faut utiliser $interfaces au pluriel ; c’est le nom de la variable qui arrive et repart du pipelines. Tu as modifié $interface sans s.

      Une fois ce genre de modifications faite, il faut ensuite soit repasser par la page de gestion des plugins (ecrire/?exec=admin_plugin) soit lancer un ?var_mode=recalcul sur une page. Mais je suppose que c’est ce qui avait été fait ; le seul problème venant de ce petit s

    • Pascal

      Bonjour,
      merci pour ta réponse.
      Effectivement comme cela c’est bon. J’aurais du y penser et non me contenter de recopier le le code.

    Reply to this message

  • 1
    Pascal

    Bonjour,
    près plusieurs tentatives d’installations, de réinitialisation...
    J’arrive à créer le plugin, mais lorsque que j’ai créé un objet éditorial, je n’arrive pas utiliser la commande : Pré-remplir cet objet.
    Je suis en PHP 7.2, SPIP 3.2.4
    Merci de me donner une piste pour trouver une solution...

    • Pascal

      l
      La console d’inspection affiche ce message :
      An invalid form control with name=’objets[0][nom]’ is not focusable.
      An invalid form control with name=’objets[0][table]’ is not focusable.

    Reply to this message

Add a comment

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 / PostgreSQL
  • 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 apparait.

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.

Who are you?
[Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom