SPIP Code

Documentation du code de SPIP et de ses plugins

Fabrique

fabriquer_plugin.php

Gestion du formulaire de fabrication de plugin

Table of Contents

Functions

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é.

Functions

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


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results