Documentation du code de SPIP et de ses plugins

Fabrique

Formulaires

Table of Contents

Functions

formulaires_fabriquer_peuple_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de fabrication de peuplement de table SQL
formulaires_fabriquer_peuple_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire de fabrication de peuplement de table SQL
formulaires_fabriquer_plugin_identifier_dist()  : string
Hash du formulaire de fabrication de plugin
formulaires_fabriquer_plugin_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de fabrication de plugin
formulaires_fabriquer_plugin_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire de fabrication de plugin
formulaires_fabriquer_plugin_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire de fabrication de plugin
fabriquer_fichier()  : mixed
Cherche un fichier dans la fabrique, le calcule et le copie dans le répertoire du futur plugin
fabriquer_miniatures()  : mixed
Réduit une image dont l'adresse est donnée, et la place dans prive/themes/spip/images du futur plugin
fabriquer_repertoire_themes_images()  : string
Crée et retourne le chemin vers le répertoire image du plugin, qui stocke les images/logos
fabriquer_miniature_svg()  : mixed
Prépare une image SVG dont l'adresse est donnée, et la place dans prive/themes/spip/images du futur plugin
fabriquer_miniature_png()  : mixed
Réduit une image dont l'adresse est donnée (autre que SVG), et la place dans prive/themes/spip/images du futur plugin
fabrique_fichiers_paquets()  : array<string|int, mixed>
Complète la description du paquet des fichiers indispensables pour les objets demandés
fabrique_remettre_contexte()  : mixed
Remet les infos de contexte dans l'environnement
fabrique_completer_contexte()  : array<string|int, mixed>
Complète les données connues avec des données qui servent souvent
fabrique_completer_contexte_images()  : array<string|int, mixed>
Complète les données connues avec les noms des fichiers d'images
fabrique_renseigner_objet()  : array<string|int, mixed>
Complète les informations d'un objet en fonction de la table SQL qui a été demandé.
fabrique_action_modification_formulaire()  : Tableau
Éffectue l'action demandée sur le formulaire de construction de plugin
fabrique_recuperer_et_stocker_les_images()  : void
Récupère les images uploadés et les stocke dans la session
fabrique_sauvegarde_tournante_export()  : void
Sauvegarder 10 exports de chaque plugins (en se basant sur le prefixe) ce qui permet de restaurer de vieilles versions.
fabrique_generer_diff()  : void
Générer un diff entre la précédente génération du plugin et cette nouvelle création
fabrique_executer_script()  : null|void
Exécute (uniquement si webmestre) des scripts saisis dans le formulaire de création de plugin.
formulaires_fabriquer_squelettes_fabrique_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'aide à la création de gabarits de squelette pour la fabrique
formulaires_fabriquer_squelettes_fabrique_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'aide à la création de gabarits de squelette pour la fabrique
formulaires_reinitialiser_plugin_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de réinitialisation de la fabrique de plugin
formulaires_reinitialiser_plugin_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire de réinitialisation de la fabrique de plugin
formulaires_restaurer_plugin_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de restauration d'une fabrique
formulaires_restaurer_plugin_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire de restauration d'une fabrique
formulaires_restaurer_plugin_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire de restauration d'une fabrique
fabrique_restaurer_images()  : array<string|int, mixed>
Restaurer une description de plusieurs images
fabrique_restaurer_image()  : array<string|int, mixed>
Enregistrer dans local/ l'image reçue
fabrique_migration()  : array<string|int, mixed>
Outil de migration de données de sauvegardes d'une fabrique
fabrique_migration_v2()  : array<string|int, mixed>
Migration v2
fabrique_migration_v3()  : array<string|int, mixed>
Migration v3
fabrique_migration_v4()  : array<string|int, mixed>
Migration v3
fabrique_migration_v5()  : array<string|int, mixed>
Migration v5
fabrique_migration_v6()  : array<string|int, mixed>
Migration v6
fabrique_migration_v7()  : array<string|int, mixed>
Migration v7

Functions

formulaires_fabriquer_peuple_charger_dist()

Chargement du formulaire de fabrication de peuplement de table SQL

formulaires_fabriquer_peuple_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_fabriquer_peuple_traiter_dist()

Traitement du formulaire de fabrication de peuplement de table SQL

formulaires_fabriquer_peuple_traiter_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Retour des traitements

formulaires_fabriquer_plugin_identifier_dist()

Hash du formulaire de fabrication de plugin

formulaires_fabriquer_plugin_identifier_dist() : string
Return values
string

Hash du formulaire

formulaires_fabriquer_plugin_charger_dist()

Chargement du formulaire de fabrication de plugin

formulaires_fabriquer_plugin_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_fabriquer_plugin_verifier_dist()

Vérifications du formulaire de fabrication de plugin

formulaires_fabriquer_plugin_verifier_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Erreurs du formulaire

formulaires_fabriquer_plugin_traiter_dist()

Traitements du formulaire de fabrication de plugin

formulaires_fabriquer_plugin_traiter_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Retours du traitement

fabriquer_fichier()

Cherche un fichier dans la fabrique, le calcule et le copie dans le répertoire du futur plugin

fabriquer_fichier(string $chemin, array<string|int, mixed> $data) : mixed
Parameters
$chemin : string

Chemin du fichier (depuis la racine du répertoire de fabrique)

$data : array<string|int, mixed>

Environnement du calcul

fabriquer_miniatures()

Réduit une image dont l'adresse est donnée, et la place dans prive/themes/spip/images du futur plugin

fabriquer_miniatures(string $prefixe, string $src, string $nom[, mixed $tailles = [] ][, mixed $specfiques = false ][, array<string|int, string> $variante = '' ]) : mixed
Parameters
$prefixe : string

Préfixe du plugin

$src : string

Source de l'image

$nom : string

Nom du fichier d'image

$tailles : mixed = []
$specfiques : mixed = false
$variante : array<string|int, string> = ''

Variantes tel que del, edit, new, add

fabriquer_repertoire_themes_images()

Crée et retourne le chemin vers le répertoire image du plugin, qui stocke les images/logos

fabriquer_repertoire_themes_images(string $prefixe) : string
Parameters
$prefixe : string

préfixe du plugin...

Return values
string

fabriquer_miniature_svg()

Prépare une image SVG dont l'adresse est donnée, et la place dans prive/themes/spip/images du futur plugin

fabriquer_miniature_svg(string $prefixe, string $src, string $nom[, int $taille = 0 ][, mixed $specifique = false ][, mixed $variante = '' ]) : mixed
Parameters
$prefixe : string

Préfixe du plugin

$src : string

Source de l'image

$nom : string

Nom du fichier d'image

$taille : int = 0

Taille de l'image en pixels

$specifique : mixed = false
$variante : mixed = ''

fabriquer_miniature_png()

Réduit une image dont l'adresse est donnée (autre que SVG), et la place dans prive/themes/spip/images du futur plugin

fabriquer_miniature_png(string $prefixe, string $src, string $nom[, int $taille = 128 ][, string $variante = '' ]) : mixed
Parameters
$prefixe : string

Préfixe du plugin

$src : string

Source de l'image

$nom : string

Nom du fichier d'image

$taille : int = 128

Taille de l'image en pixels

$variante : string = ''

Variante tel que del, edit, new, add

fabrique_fichiers_paquets()

Complète la description du paquet des fichiers indispensables pour les objets demandés

fabrique_fichiers_paquets(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Informations sur le plugin à construire

Return values
array<string|int, mixed>

Liste des fichiers indispensables au plugin (et ceux qui étaient déjà demandés)

fabrique_remettre_contexte()

Remet les infos de contexte dans l'environnement

fabrique_remettre_contexte(array<string|int, mixed> $data) : mixed

Certaines infos sont remises dans l'environnement

  • parce qu'on en ajoute par rapport à ce qui est posté - afin de réafficher correctement le formulaire si on a des erreurs dans la partie traiter(), car dans ce cas, le formulaire ne repasse pas dans le charger().
Parameters
$data : array<string|int, mixed>

Les infos postées

fabrique_completer_contexte()

Complète les données connues avec des données qui servent souvent

fabrique_completer_contexte(array<string|int, mixed> $data) : array<string|int, mixed>

Ceci pour se simplifier (un peu) les squelettes, et éviter de multiples calculs (type, table, id_objet, objet...)

Parameters
$data : array<string|int, mixed>

Les infos du plugin à construire connues

Return values
array<string|int, mixed>

Les mêmes infos complétées

fabrique_completer_contexte_images()

Complète les données connues avec les noms des fichiers d'images

fabrique_completer_contexte_images(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Les infos du plugin à construire connues

Return values
array<string|int, mixed>

Les mêmes infos complétées

fabrique_renseigner_objet()

Complète les informations d'un objet en fonction de la table SQL qui a été demandé.

fabrique_renseigner_objet(array<string|int, mixed> $objet) : array<string|int, mixed>

On essaie d'extraire de la table le plus d'info possibles.

Parameters
$objet : array<string|int, mixed>

Description connue de l'objet éditorial désiré

Return values
array<string|int, mixed>

$objet Description éventuellement complétée si une table SQL source était renseignée

fabrique_action_modification_formulaire()

Éffectue l'action demandée sur le formulaire de construction de plugin

fabrique_action_modification_formulaire(string $f_action, array<string|int, mixed> $data) : Tableau
Parameters
$f_action : string

Nom de l'action dans le constructeur de plugin de la fabrique, tel que 'ajouter_objet', 'supprimer_champ', ...

$data : array<string|int, mixed>

Données de construction du plugin

Return values
Tableau

de retour de traitement du formulaire

fabrique_recuperer_et_stocker_les_images()

Récupère les images uploadés et les stocke dans la session

fabrique_recuperer_et_stocker_les_images(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

Données de construction du plugin

fabrique_sauvegarde_tournante_export()

Sauvegarder 10 exports de chaque plugins (en se basant sur le prefixe) ce qui permet de restaurer de vieilles versions.

fabrique_sauvegarde_tournante_export(string $fichier, string $destination) : void
Parameters
$fichier : string

Fichier source à sauver

$destination : string

Répertoire de backup

Tags
note

Attention, cela ne sauve que le fichier d'export / import pour la Fabrique.

fabrique_generer_diff()

Générer un diff entre la précédente génération du plugin et cette nouvelle création

fabrique_generer_diff(string $ancien, string $nouveau, string $prefixe) : void

Ce diff est affiché ensuite au retour du formulaire de création et également stocké dans le plugin crée, dans le fichier 'fabrique_diff.diff'

Parameters
$ancien : string

Chemin du répertoire de l'ancienne création de plugin

$nouveau : string

Chemin du répertoire de la nouvelle création

$prefixe : string

Préfixe du plugin construit

fabrique_executer_script()

Exécute (uniquement si webmestre) des scripts saisis dans le formulaire de création de plugin.

fabrique_executer_script(string $quoi, array<string|int, mixed> $data[, array<string|int, mixed> $contexte = [] ]) : null|void
Parameters
$quoi : string

Nom du type de script

$data : array<string|int, mixed>

Données de construction du plugin

$contexte : array<string|int, mixed> = []

Variables disponibles pour les scripts (nom => valeur)

Return values
null|void

Null si le type de script n'est pas trouvé ou pas d'autorisation Void sinon.

formulaires_fabriquer_squelettes_fabrique_charger_dist()

Chargement du formulaire d'aide à la création de gabarits de squelette pour la fabrique

formulaires_fabriquer_squelettes_fabrique_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_fabriquer_squelettes_fabrique_traiter_dist()

Traitement du formulaire d'aide à la création de gabarits de squelette pour la fabrique

formulaires_fabriquer_squelettes_fabrique_traiter_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Retour des traitements

formulaires_reinitialiser_plugin_charger_dist()

Chargement du formulaire de réinitialisation de la fabrique de plugin

formulaires_reinitialiser_plugin_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_reinitialiser_plugin_traiter_dist()

Traitement du formulaire de réinitialisation de la fabrique de plugin

formulaires_reinitialiser_plugin_traiter_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Retour des traitements

formulaires_restaurer_plugin_charger_dist()

Chargement du formulaire de restauration d'une fabrique

formulaires_restaurer_plugin_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_restaurer_plugin_verifier_dist()

Vérifications du formulaire de restauration d'une fabrique

formulaires_restaurer_plugin_verifier_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Erreurs du formulaire

formulaires_restaurer_plugin_traiter_dist()

Traitements du formulaire de restauration d'une fabrique

formulaires_restaurer_plugin_traiter_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

Retour des traitements

fabrique_restaurer_images()

Restaurer une description de plusieurs images

fabrique_restaurer_images(string $nom_de_base, array<string|int, mixed> $images) : array<string|int, mixed>
Parameters
$nom_de_base : string

Nom de base de l'image à restaurer

$images : array<string|int, mixed>

Description des images Tableau [type][taille] = [description]

Tags
uses
fabrique_restaurer_image()
Return values
array<string|int, mixed>

Description complétée des images

fabrique_restaurer_image()

Enregistrer dans local/ l'image reçue

fabrique_restaurer_image(string $nom_de_base, array<string|int, mixed> $l[, int $taille = 0 ]) : array<string|int, mixed>
Parameters
$nom_de_base : string

Nom de base de l'image à enregistrer.

$l : array<string|int, mixed>

Description de l'image. Possède les clés contenu (image en base64) et èxtension

$taille : int = 0

Taille de l'image à enregistrer

Tags
used-by
fabrique_restaurer_images()
Return values
array<string|int, mixed>

Description complétée des images avec la clé fichier ayant le chemin de l'image enregistrée.

fabrique_migration()

Outil de migration de données de sauvegardes d'une fabrique

fabrique_migration(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Toutes les données de sauvegarde (à une certaine version)

Return values
array<string|int, mixed>

Données de sauvegardes migrés à la dernière version de la fabrique.

fabrique_migration_v2()

Migration v2

fabrique_migration_v2(array<string|int, mixed> $data) : array<string|int, mixed>

Passage de certains fichiers dans un tableau 'fichiers'

Parameters
$data : array<string|int, mixed>

Données à migrer

Return values
array<string|int, mixed>

Données migrées

fabrique_migration_v3()

Migration v3

fabrique_migration_v3(array<string|int, mixed> $data) : array<string|int, mixed>

Déplacer les logos dans une clé images spécifique

Parameters
$data : array<string|int, mixed>

Données à migrer

Return values
array<string|int, mixed>

Données migrées

fabrique_migration_v4()

Migration v3

fabrique_migration_v4(array<string|int, mixed> $data) : array<string|int, mixed>

Renommer le fabricant en fabrique

Parameters
$data : array<string|int, mixed>

Données à migrer

Return values
array<string|int, mixed>

Données migrées

fabrique_migration_v5()

Migration v5

fabrique_migration_v5(array<string|int, mixed> $data) : array<string|int, mixed>

Échafaudage n'a qu'un F !

Parameters
$data : array<string|int, mixed>

Données à migrer

Return values
array<string|int, mixed>

Données migrées

fabrique_migration_v6()

Migration v6

fabrique_migration_v6(array<string|int, mixed> $data) : array<string|int, mixed>

Les fichiers indiqués spécialement à créer vont dans une entrée 'fichiers' spécifique.

  • fichiers/echafaudages
  • fichiers/explicites
  • fichiers/...
Parameters
$data : array<string|int, mixed>

Données à migrer

Return values
array<string|int, mixed>

Données migrées

fabrique_migration_v7()

Migration v7

fabrique_migration_v7(array<string|int, mixed> $data) : array<string|int, mixed>

L’entrée 'logo_variantes' est supprimée

Parameters
$data : array<string|int, mixed>

Données à migrer

Return values
array<string|int, mixed>

Données migrées


        
On this page

Search results