SPIP Code

Documentation du code de SPIP et de ses plugins

Fabrique

Fonctions

Table of Contents

Functions

fabrique_destination()  : string
Déterminer le répertoire de travail de la Fabrique.
sous_repertoire_complet()  : void
Crée l'arborescence manquante
fabrique_implode_recursif()  : string|bool
Concatène en utilisant implode, un tableau, de maniere récursive
balise_PHP_dist()  : Champ
Écrit une ouverture de code PHP
chaine_de_langue()  : string
Convertie une chaîne pour en faire une chaîne de langue
cle_de_langue()  : string
Modifie le nom de la clé de langue pour utiliser le vrai nom de l'objet
tab_cle_de_langue()  : array<string|int, mixed>
Identique à |cle_de_langue sur toutes les valeurs d'un tableau
tab_cle_traduite_ajoute_dans_valeur()  : array<string|int, mixed>
Cherche s'il existe une chaîne de langue pour les clés de tableaux et ajoute alors la traduction dans la valeur de ce tableau
tab_wrap()  : array<string|int, mixed>
Équivalent de wrap() sur les valeurs du tableau
fabriquer_tableau_chaines()  : array<string|int, mixed>
Fabrique un tableau de chaînes de langues avec des clés d'origines passées dans la fonctions cle_de_langue, et trie.
fabrique_description_roles()  : array<string|int, mixed>
Retourne la description des rôles pour un objet
champ_present()  : string
Indique si le champ est présent dans l'objet
options_presentes()  : string
Indique si toutes les options sont présentes dans l'objet
option_presente()  : string
Indique si une option est présente dans l'objet
saisie_presente()  : string
Indique si une saisie est présente dans l'objet
champ_option_presente()  : string
Indique si une option donnée est presente dans la définition d'un champ de la fabrique
champ_saisie_presente()  : string
Indique si une saisie donnée est presente dans la définition d'un champ de la fabrique
objets_champ_present()  : array<string|int, mixed>
Retourne les objets possédant un certain champ SQL
objets_option_presente()  : array<string|int, mixed>
Retourne les objets possédant une certaine option
objets_saisie_presente()  : array<string|int, mixed>
Retourne les objets possédant une certaine saisie
objets_options_presentes()  : array<string|int, mixed>
Retourne les objets possédant plusieurs options
champs_option_presente()  : array<string|int, mixed>
Retourne des champs en fonction d'une option trouvée
champs_options_presentes()  : array<string|int, mixed>
Retourne des champs en fonction des options trouvées
champs_saisie_presente()  : array<string|int, mixed>
Retourne des champs en fonction d'une option trouvée
_tableau_option_presente()  : array<string|int, mixed>
Fonction générique pour retourner une liste de choses dans un tableau
_tableau_options_presentes()  : array<string|int, mixed>
Fonction générique pour retourner une liste de choses multiples dans un tableau
fabrique_objets_enfants_directs()  : mixed
Retrouve si cet objet a des enfants déclarés dans un autre objet
criteres_champs_id()  : string
Retourne une écriture de critères `{id_xxx ?}`
fabrique_lister_tables()  : array<string|int, mixed>
Retourne un tableau de toutes les tables SQL pour tous les objets.
fabrique_lister_objet_champs()  : array<string|int, mixed>
Retourne la liste des noms de certains champs pour cet objet
fabrique_necessite_pipeline()  : array<string|int, mixed>
Indique si un des objets a besoin du pipeline demandé
ecrire_tableau()  : string
Crée le code PHP de création d'un tableau
ecrire_tableau_sinon_rien()  : string
Crée le code PHP de création d'un tableau sauf s'il est vide
espacer()  : Texte
Ajoute autant des espaces à la fin d'une chaîne jusqu'à la taille indiquée
fabrique_tabulations()  : string
Tabule à gauche chaque ligne du nombre de tabulations indiquées + on enleve les espaces sur les lignes vides
fabrique_mb_strtoupper()  : string
Passer en majuscule en utilisant mb de préférence s'il est disponible.
fabrique_mb_strtolower()  : string
Passer en minuscule en utilisant mb de préférence s'il est disponible.
filtre_fabrique_miniature_image()  : string
Crée une balise HTML <img> à partir d'un fichier, réactualisée à chaque calcul, selon une réduction donnée.
fabrique_chemin_themes_images()  : string
Retourne le chemin vers le répertoire themes d’une image, différent si c’est svg ou png.
filtre_fabrique_lister_objets_editoriaux()  : array<string|int, mixed>
Retourne un tableau table_sql=>Nom des objets de SPIP complété des objets declares dans la fabrique ainsi que de tables indiquees même si elles ne font pas parties de declarations connues.
fabrique_parent()  : array<string|int, mixed>
Indique si cet objet a un parent direct déclaré
fabrique_array_map()  : array<string|int, mixed>
Appliquer un équivalent d'array_map sur une des fonctions de la fabrique
fabrique_id_table_objet()  : string
Retrouve la clé primaire d'un objet éditorial
fabrique_table_objet()  : string
Retrouve le nom d'objet d'un objet éditorial
fabrique_objet_type()  : string
Retrouve le type d'un objet éditorial
fabrique_code_autorisation()  : string
Retourne le code pour tester un type d'autorisation
fabrique_autorisation_defaut()  : string
Retourne la valeur de type d'autorisation qui s'applique par defaut pour une autorisation donnee
fabrique_code_autorisation_defaut()  : string
Retourne le code d'autorisation indique sinon celui par defaut pour une fonction d'autorisation
objets_autorisation_presente()  : bool
Retourne vrai si un test d'autorisation est d'un type spécifié dans l'ensemble des autorisations à configurer de tous les objets
objets_autorisations_presentes()  : bool
Retourne vrai si au moins une autorisation est d'un des types spécifiés dans l'ensemble des autorisations à configurer de tous les objets
autorisation_presente()  : bool
Retourne vrai si un test d'autorisation est d'un type spécifié dans l'ensemble des autorisations à configurer d'un objet
fabrique_type_autorisation()  : string
Retourne le type pour le nom d'une fonction d'autorisation 'article' => 'article' 'truc_muche' => 'trucmuche'
lister_tables_sql()  : array<string|int, mixed>
Liste les tables sql de chaque base déclarée Avec la connexion par defaut - spip_articles - spip_truc Avec d'autres connexions - autre:spip_articles - autre:spip_truc

Functions

fabrique_destination()

Déterminer le répertoire de travail de la Fabrique.

fabrique_destination() : string

Dans :

  • plugins/fabrique_auto si possible, sinon dans
  • tmp/cache/fabrique
Return values
string —

Le chemin de destination depuis la racine de SPIP.

sous_repertoire_complet()

Crée l'arborescence manquante

sous_repertoire_complet(string $arbo) : void

Crée tous les répertoires manquants dans une arborescence donnée. Les répertoires sont séparés par des '/'

Parameters
$arbo : string

Arborescence, tel que 'prive/squelettes/contenu'

Tags
example

sous_repertoire_complet('a/b/c/d'); appelle sous_repertoire() autant de fois que nécéssaire.

fabrique_implode_recursif()

Concatène en utilisant implode, un tableau, de maniere récursive

fabrique_implode_recursif(array<string|int, mixed> $tableau[, string $glue = '' ]) : string|bool
Parameters
$tableau : array<string|int, mixed>

Tableau à transformer

$glue : string = ''

Chaine insérée entre les valeurs

Return values
string|bool —
  • False si pas un tableau
  • Chaine concaténée sinon

balise_PHP_dist()

Écrit une ouverture de code PHP

balise_PHP_dist(Champ $p) : Champ

Fait écrire '<?php' sans que ce php soit executé par SPIP !

Parameters
$p : Champ

Pile au niveau de la balise

Return values
Champ —

Pile complétée du code à produire

chaine_de_langue()

Convertie une chaîne pour en faire une chaîne de langue

chaine_de_langue(string $texte) : string

Permet d'insérer un texte comme valeur d'une clé de langue, lorsqu'on crée un fichier de langue avec la fabrique.

Transforme les caractères &# et échappe les apostrophes :

  • &#xxx => le bon caractère
  • ' => '
Parameters
$texte : string

Le texte à écrire dans la chaîne de langue

Tags
example

'#ENV{prefixe}_description' => '[(#ENV{paquet/description}|chaine_de_langue)]',

link
http://www.php.net/manual/fr/function.html-entity-decode.php#104617
Return values
string —

Le texte transformé

cle_de_langue()

Modifie le nom de la clé de langue pour utiliser le vrai nom de l'objet

cle_de_langue(string $cle, array<string|int, mixed> $desc_objet) : string

Remplace 'objets' par le nom de l'objet, et 'objet' par le type d'objet, mais ne touche pas à '\objets' ou '\objet'.

Parameters
$cle : string

La clé à transformer

$desc_objet : array<string|int, mixed>

Couples d'information sur l'objet en cours, avec les index 'objet' et 'type' définis

Tags
note

Cette fonction ne sert pas uniquement à définir des clés pour les fichiers de chaînes de langue, et pourrait être renommée

example 
cle_de_langue('titre_objets') => titre_chats
cle_de_langue('icone_creer_objet') => icone_creer_chat
cle_de_langue('prive/\objets/infos/objet.html') => prive/objets/infos/chat.html
Return values
string —

La clé transformée

tab_cle_de_langue()

Identique à |cle_de_langue sur toutes les valeurs d'un tableau

tab_cle_de_langue(array<string|int, mixed> $tableau, array<string|int, mixed> $desc_objet) : array<string|int, mixed>
Parameters
$tableau : array<string|int, mixed>

Tableau dont on veut transformer les valeurs

$desc_objet : array<string|int, mixed>

Couples d'information sur l'objet en cours, avec les index 'objet' et 'type' définis

Tags
see
cle_de_langue()
Return values
array<string|int, mixed> —

Tableau avec les valeurs transformées

tab_cle_traduite_ajoute_dans_valeur()

Cherche s'il existe une chaîne de langue pour les clés de tableaux et ajoute alors la traduction dans la valeur de ce tableau

tab_cle_traduite_ajoute_dans_valeur(array<string|int, mixed> $tableau[, string $prefixe_cle = '' ][, string $sep = '&nbsp;: ' ]) : array<string|int, mixed>
Parameters
$tableau : array<string|int, mixed>

Couples (clé => texte)

$prefixe_cle : string = ''

Préfixe ajouté aux clés pour chercher les trads

$sep : string = '&nbsp;: '

Séparateur entre l'ancienne valeur et la concaténation de traduction

Return values
array<string|int, mixed> —

Couples (clé => texte complété de la traduction si elle existe)

tab_wrap()

Équivalent de wrap() sur les valeurs du tableau

tab_wrap(array<string|int, mixed> $tableau, string $balise) : array<string|int, mixed>
Parameters
$tableau : array<string|int, mixed>

Tableau cle => texte

$balise : string

Balise qui encapsule

Return values
array<string|int, mixed> —

$tableau Tableau clé => texte

fabriquer_tableau_chaines()

Fabrique un tableau de chaînes de langues avec des clés d'origines passées dans la fonctions cle_de_langue, et trie.

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

Description de l'objet dans la fabrique

Return values
array<string|int, mixed> —

Couples (clé de langue => Texte)

fabrique_description_roles()

Retourne la description des rôles pour un objet

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

Descrption de l'objet

Return values
array<string|int, mixed> —

Description des rôles. 4 index :

  • roles_colonne : la colonne utilisée, toujours 'role'
  • roles_titre : couples clé du role, clé de langue du role
  • roles_objets : tableau objet => liste des clés de roles
  • roles_trads : couples clé de langue => Texte
  • roles_defaut : la clé du role par défaut

champ_present()

Indique si le champ est présent dans l'objet

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

Champ, au sens de colonne SQL

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

Descrption de l'objet

$champ : string

Nom du champ SQL à tester

Return values
string —

Même retour que le filtre |oui :

  • Un espace si le champ SQL exsitera dans l'objet
  • Chaîne vide sinon

options_presentes()

Indique si toutes les options sont présentes dans l'objet

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

Option au sens de clé de configuration, pas un nom de champ SQL

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

Descrption de l'objet

$champs : array<string|int, mixed>

Liste de nom d'options à tester

Return values
string —

Même retour que le filtre |oui :

  • Un espace si toutes les options sont présentes dans l'objet
  • Chaîne vide sinon

option_presente()

Indique si une option est présente dans l'objet

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

Option au sens de clé de configuration, pas un nom de champ SQL

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

Descrption de l'objet

$champ : string

Nom de l'option à tester

Return values
string —

Même retour que le filtre |oui :

  • Un espace si l'option est présente dans l'objet
  • Chaîne vide sinon

saisie_presente()

Indique si une saisie est présente dans l'objet

saisie_presente(array<string|int, mixed> $objet, array<string|int, mixed> $saisie) : string
Parameters
$objet : array<string|int, mixed>

Descrption de l'objet

$saisie : array<string|int, mixed>

Nom de la saisie à tester

Return values
string —

Même retour que le filtre |oui :

  • Un espace si l'option est présente dans l'objet
  • Chaîne vide sinon

champ_option_presente()

Indique si une option donnée est presente dans la définition d'un champ de la fabrique

champ_option_presente(array<string|int, mixed> $champ, string $option) : string
Parameters
$champ : array<string|int, mixed>

Description d'un champ SQL d'un objet créé avec la fabrique

$option : string

Option testée

Return values
string —

Même retour que le filtre |oui :

  • Un espace si l'option est présente dans le champ de l'objet
  • Chaîne vide sinon

champ_saisie_presente()

Indique si une saisie donnée est presente dans la définition d'un champ de la fabrique

champ_saisie_presente(array<string|int, mixed> $champ, string $saisie) : string
Parameters
$champ : array<string|int, mixed>

Description d'un champ SQL d'un objet créé avec la fabrique

$saisie : string

Saisie testée

Return values
string —

Même retour que le filtre |oui :

  • Un espace si l'option est présente dans le champ de l'objet
  • Chaîne vide sinon

objets_champ_present()

Retourne les objets possédant un certain champ SQL

objets_champ_present(array<string|int, mixed> $objets, string $champ[, string $type = '' ]) : array<string|int, mixed>

Cela simplifie des boucles DATA

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

Liste des descriptions d'objets créés avec la fabrique

$champ : string

Type de champ sélectionné

$type : string = ''

Information de retour désiré :

  • vide pour toute la description de l'objet
  • clé dans la description de l'objet pour obtenir uniquement ces descriptions
Tags
example
  • #OBJETS|objets_champ_present{id_rubrique}
  • On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet) #OBJETS|objets_champ_present{id_rubrique, objet} // chats,souris
Return values
array<string|int, mixed> —
  • tableau de description des objets sélectionnés (si type non défini)
  • tableau les valeurs du type demandé dans les objets sélectionnés (si type défini)

objets_option_presente()

Retourne les objets possédant une certaine option

objets_option_presente(array<string|int, mixed> $objets, string $option[, string $type = '' ]) : array<string|int, mixed>

Option au sens des clés du formulaire de configuration de l'objet

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

Liste des descriptions d'objets créés avec la fabrique

$option : string

Type d'option sélectionnée

$type : string = ''

Information de retour désiré :

  • vide pour toute la description de l'objet
  • clé dans la description de l'objet pour obtenir uniquement ces descriptions
Tags
example
  • #OBJETS|objets_option_presente{vue_rubrique}
  • #OBJETS|objets_option_presente{auteurs_liens}
  • On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet) #OBJETS|objets_option_presente{auteurs_liens, objet} // chats,souris
Return values
array<string|int, mixed> —
  • tableau de description des objets sélectionnés (si type non défini)
  • tableau les valeurs du type demandé dans les objets sélectionnés (si type défini)

objets_saisie_presente()

Retourne les objets possédant une certaine saisie

objets_saisie_presente(array<string|int, mixed> $objets, string $saisie[, string $type = '' ]) : array<string|int, mixed>
Parameters
$objets : array<string|int, mixed>

Liste des descriptions d'objets créés avec la fabrique

$saisie : string

Type de saisie sélectionnée

$type : string = ''

Information de retour désiré :

  • vide pour toute la description de l'objet
  • clé dans la description de l'objet pour obtenir uniquement ces descriptions
Tags
example
  • #OBJETS|objets_saisie_presente{date}
  • On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet) #OBJETS|objets_saisie_presente{date, objet} // chats,souris
Return values
array<string|int, mixed> —
  • tableau de description des objets sélectionnés (si type non défini)
  • tableau les valeurs du type demandé dans les objets sélectionnés (si type défini)

objets_options_presentes()

Retourne les objets possédant plusieurs options

objets_options_presentes(array<string|int, mixed> $objets, array<string|int, mixed> $options[, string $type = '' ]) : array<string|int, mixed>

Option au sens des clés du formulaire de configuration de l'objet

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

Liste des descriptions d'objets créés avec la fabrique

$options : array<string|int, mixed>

Liste de type d'option à sélectionner

$type : string = ''

Information de retour désiré :

  • vide pour toute la description de l'objet
  • clé dans la description de l'objet pour obtenir uniquement ces descriptions
Tags
example
  • #OBJETS|objets_options_presentes{#LISTE{table_liens,vue_liens}}
  • On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet) #OBJETS|objets_options_presentes{#LISTE{table_liens,vue_liens}, objet} // chats,souris
Return values
array<string|int, mixed> —
  • tableau de description des objets sélectionnés (si type non défini)
  • tableau les valeurs du type demandé dans les objets sélectionnés (si type défini)

champs_option_presente()

Retourne des champs en fonction d'une option trouvée

champs_option_presente(array<string|int, mixed> $champs, string $option[, string $type = '' ]) : array<string|int, mixed>
Parameters
$champs : array<string|int, mixed>

Liste des descriptions de champs d'un objet créé avec la fabrique

$option : string

Type d'option sélectionnée

$type : string = ''

Information de retour désiré :

  • vide pour toute la description du champ
  • clé dans la description du champ pour obtenir uniquement ces descriptions
Tags
example
  • #CHAMPS|champs_option_presente{editable}
  • #CHAMPS|champs_option_presente{versionne}
Return values
array<string|int, mixed> —
  • tableau de description des champs sélectionnés (si type non défini)
  • tableau les valeurs du type demandé dans les champs sélectionnés (si type défini)

champs_options_presentes()

Retourne des champs en fonction des options trouvées

champs_options_presentes(array<string|int, mixed> $champs, array<string|int, mixed> $options[, string $type = '' ]) : array<string|int, mixed>
Parameters
$champs : array<string|int, mixed>

Liste des descriptions de champs d'un objet créé avec la fabrique

$options : array<string|int, mixed>

Liste de type d'options à sélectionner

$type : string = ''

Information de retour désiré :

  • vide pour toute la description du champ
  • clé dans la description du champ pour obtenir uniquement ces descriptions
Tags
example

#CHAMPS|champs_options_presentes{#LISTE{obligatoire,saisie}}

Return values
array<string|int, mixed> —
  • tableau de description des champs sélectionnés (si type non défini)
  • tableau les valeurs du type demandé dans les champs sélectionnés (si type défini)

champs_saisie_presente()

Retourne des champs en fonction d'une option trouvée

champs_saisie_presente(array<string|int, mixed> $champs, string $saisie[, string $type = '' ]) : array<string|int, mixed>
Parameters
$champs : array<string|int, mixed>

Liste des descriptions de champs d'un objet créé avec la fabrique

$saisie : string

Type de saisie sélectionnée

$type : string = ''

Information de retour désiré :

  • vide pour toute la description du champ
  • clé dans la description du champ pour obtenir uniquement ces descriptions
Tags
example

#CHAMPS|champs_saisie_presente{date}

Return values
array<string|int, mixed> —
  • tableau de description des champs sélectionnés (si type non défini)
  • tableau les valeurs du type demandé dans les champs sélectionnés (si type défini)

_tableau_option_presente()

Fonction générique pour retourner une liste de choses dans un tableau

_tableau_option_presente(string $func, array<string|int, mixed> $tableau, string $option[, string $type = '' ]) : array<string|int, mixed>
Parameters
$func : string

Nom de la fonction à appeler, tel que

  • champ_option_presente
  • option_presente
  • ...
$tableau : array<string|int, mixed>

Tableau de descriptions (descriptions d'objet ou descriptions de champ d'objet)

$option : string

Nom de l'option dont on teste la présence

$type : string = ''

Information de retour désiré :

  • vide pour toute la description
  • clé dans la description pour obtenir uniquement ces descriptions
Return values
array<string|int, mixed> —

Liste des descriptions correspondant à l'option demandée

_tableau_options_presentes()

Fonction générique pour retourner une liste de choses multiples dans un tableau

_tableau_options_presentes(string $func, array<string|int, mixed> $tableau, array<string|int, mixed> $options[, string $type = '' ]) : array<string|int, mixed>
Parameters
$func : string

Nom de la fonction à appeler, tel que

  • champ_option_presente
  • option_presente
  • ...
$tableau : array<string|int, mixed>

Tableau de descriptions (descriptions d'objet ou descriptions de champ d'objet)

$options : array<string|int, mixed>

Nom des l'options dont on teste leur présence

$type : string = ''

Information de retour désiré :

  • vide pour toute la description
  • clé dans la description pour obtenir uniquement ces descriptions
Return values
array<string|int, mixed> —

Liste des descriptions correspondant aux options demandées

fabrique_objets_enfants_directs()

Retrouve si cet objet a des enfants déclarés dans un autre objet

fabrique_objets_enfants_directs(array<string|int, mixed> $objet, array<string|int, mixed> $objets) : mixed
Parameters
$objet : array<string|int, mixed>

Description de l'objet dans la fabrique

$objets : array<string|int, mixed>

Description de tous les objets dans la fabrique

Tags
@return

criteres_champs_id()

Retourne une écriture de critères `{id_xxx ?}`

criteres_champs_id(array<string|int, mixed> $objet, array<string|int, mixed> $objets[, bool $avec_cle_primaire = true ]) : string

Tous les champs déclarés commençant par id_x sont retournés sous forme d'une écriture de critère, tel que {id_parent?}{id_documentation?}

La clé primaire est également ajoutée, sauf contre indication.

Les champs indirects {B_liens.id_B ?} sont aussi ajoutés s'ils sont déclarés dans la Fabrique en même temps.

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

Description de l'objet dans la fabrique

$objets : array<string|int, mixed>

Description de tous les objets dans la fabrique

$avec_cle_primaire : bool = true

Ajouter la clé primaire de la table également

Return values
string —

L'écriture des critères de boucle

fabrique_lister_tables()

Retourne un tableau de toutes les tables SQL pour tous les objets.

fabrique_lister_tables(array<string|int, mixed> $objets[, string $quoi = 'tout' ]) : array<string|int, mixed>
Parameters
$objets : array<string|int, mixed>

Liste des descriptions d'objets créés avec la fabrique

$quoi : string = 'tout'

Choix du retour désiré :

  • 'tout' => toutes les tables (par défaut)
  • 'objets' => les tables d'objet (spip_xx, spip_yy)
  • 'liens' => les tables de liens (spip_xx_liens, spip_yy_liens)
Return values
array<string|int, mixed> —

Liste des tables

fabrique_lister_objet_champs()

Retourne la liste des noms de certains champs pour cet objet

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

Champs déclarés complétés des champs spéciaux (editable, versionne, obligatoire)

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

Description de l'objet concerné

$option : string

Option souhaitée.

Return values
array<string|int, mixed> —

Liste des champs concernés

fabrique_necessite_pipeline()

Indique si un des objets a besoin du pipeline demandé

fabrique_necessite_pipeline(array<string|int, mixed> $objets, string $pipeline) : array<string|int, mixed>
Parameters
$objets : array<string|int, mixed>

Liste des descriptions d'objets créés avec la fabrique

$pipeline : string

Nom du pipeline

Return values
array<string|int, mixed> —

Liste des objets (descriptions) utilisant le pipeline

ecrire_tableau()

Crée le code PHP de création d'un tableau

ecrire_tableau(array<string|int, mixed> $tableau[, bool $quote = false ][, string $defaut = 'array()' ]) : string

Fonction un peu équivalente à var_export()

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

Le tableau dont on veut obtenir le code de création array( ... )

$quote : bool = false

Appliquer sql_quote() sur chaque valeur (dans le code retourne)

$defaut : string = 'array()'

Si $tableau est vide ou n'est pas une chaîne, la fonction retourne cette valeur

Return values
string —
  • Le code de création du tableau, avec éventuellement le code pour appliquer sql_quote.
  • $defaut si le tableau est vide

ecrire_tableau_sinon_rien()

Crée le code PHP de création d'un tableau sauf s'il est vide

ecrire_tableau_sinon_rien(array<string|int, mixed> $tableau[, bool $quote = false ]) : string

Identique à ecrire_tableau() mais ne retourne rien si le tableau est vide

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

Le tableau dont on veut obtenir le code de création array( ... )

$quote : bool = false

Appliquer sql_quote() sur chaque valeur (dans le code retourne)

Tags
see
ecrire_tableau()
Return values
string —
  • Le code de création du tableau, avec éventuellement le code pour appliquer sql_quote.
  • Chaîne vide si le tableau est vide

espacer()

Ajoute autant des espaces à la fin d'une chaîne jusqu'à la taille indiquée

espacer(string $texte[, int $taille = 0 ]) : Texte

Fonction un peu equivalente à str_pad() mais avec une valeur par défaut définie par la constante _FABRIQUE_ESPACER

Parameters
$texte : string

Texte à compléter

$taille : int = 0

Taille spécifique, utilisée à la place de la constante si renseignée

Return values
Texte —

complété des espaces de fin

fabrique_tabulations()

Tabule à gauche chaque ligne du nombre de tabulations indiquées + on enleve les espaces sur les lignes vides

fabrique_tabulations(string $texte, int $nb_tabulations) : string
Parameters
$texte : string

Un texte, qui peut avoir plusieurs lignes

$nb_tabulations : int

Nombre de tabulations à appliquer à gauche de chaque ligne

Return values
string —

Texte indenté du nombre de tabulations indiqué

fabrique_mb_strtoupper()

Passer en majuscule en utilisant mb de préférence s'il est disponible.

fabrique_mb_strtoupper(string $str) : string
Parameters
$str : string

La chaine à passer en majuscule

Return values
string —

La chaine en majuscule

fabrique_mb_strtolower()

Passer en minuscule en utilisant mb de préférence s'il est disponible.

fabrique_mb_strtolower(string $str) : string
Parameters
$str : string

La chaine à passer en minuscule

Return values
string —

La chaine en minuscule

filtre_fabrique_miniature_image()

Crée une balise HTML <img> à partir d'un fichier, réactualisée à chaque calcul, selon une réduction donnée.

filtre_fabrique_miniature_image(string $fichier[, int $taille = 256 ]) : string

Cela évite un |array_shift qui ne passe pas en PHP 5.4

Attention à bien rafraîchir l'image réduite lorsqu'on change de logo.

Parameters
$fichier : string

Chemin du fichier

$taille : int = 256

Taille de réduction de l'image

Tags
example

#URL_IMAGE|fabrique_miniature_image{128} Applique l'équivalent de :

#URL_IMAGE
    |image_reduire{128}|extraire_attribut{src}
    |explode{?}|array_shift|timestamp|balise_img
Return values
string —

Balise HTML IMG de l'image réduite et à jour

fabrique_chemin_themes_images()

Retourne le chemin vers le répertoire themes d’une image, différent si c’est svg ou png.

fabrique_chemin_themes_images(string $fichier, string $nom[, int $taille = 0 ]) : string

..

Parameters
$fichier : string

nom du fichier enregistré dans la fabrique

$nom : string

nom du fichier dans le chemin des images

$taille : int = 0

taille désirée du fichier

Return values
string

filtre_fabrique_lister_objets_editoriaux()

Retourne un tableau table_sql=>Nom des objets de SPIP complété des objets declares dans la fabrique ainsi que de tables indiquees même si elles ne font pas parties de declarations connues.

filtre_fabrique_lister_objets_editoriaux(array<string|int, mixed> $objets_fabrique[, array<string|int, mixed> $inclus = [] ][, array<string|int, mixed> $exclus = [] ]) : array<string|int, mixed>
Parameters
$objets_fabrique : array<string|int, mixed>

Déclaration d'objets de la fabrique

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

Liste de tables SQL que l'on veut forcement presentes meme si l'objet n'est pas declare

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

Liste de tables SQL que l'on veut forcement exclues meme si l'objet n'est pas declare

Return values
array<string|int, mixed> —

Tableau table_sql => Nom

fabrique_parent()

Indique si cet objet a un parent direct déclaré

fabrique_parent(array<string|int, mixed> $objet, array<string|int, mixed> $objets) : array<string|int, mixed>
Parameters
$objet : array<string|int, mixed>

Déclaration d'un objet dans la Fabrique

$objets : array<string|int, mixed>

Déclaration de tous les objets dans la Fabrique

Return values
array<string|int, mixed> —

Description du parent

fabrique_array_map()

Appliquer un équivalent d'array_map sur une des fonctions de la fabrique

fabrique_array_map(array<string|int, mixed> $tableau, string $fonction, array<string|int, mixed> $objets) : array<string|int, mixed>
Parameters
$tableau : array<string|int, mixed>
$fonction : string
$objets : array<string|int, mixed>
Return values
array<string|int, mixed>

fabrique_id_table_objet()

Retrouve la clé primaire d'un objet éditorial

fabrique_id_table_objet(string $table, array<string|int, mixed> $objets) : string

D'abord en cherchant dans les déclaration de la Fabrique, sinon en cherchant dans les objets actifs sur ce SPIP.

Parameters
$table : string

Table SQL

$objets : array<string|int, mixed>

Description des objets générés par la Fabrique.

Return values
string

fabrique_table_objet()

Retrouve le nom d'objet d'un objet éditorial

fabrique_table_objet(string $table, array<string|int, mixed> $objets) : string

D'abord en cherchant dans les déclaration de la Fabrique, sinon en cherchant dans les objets actifs sur ce SPIP.

Parameters
$table : string

Table SQL

$objets : array<string|int, mixed>

Description des objets générés par la Fabrique.

Return values
string

fabrique_objet_type()

Retrouve le type d'un objet éditorial

fabrique_objet_type(string $table, array<string|int, mixed> $objets) : string

D'abord en cherchant dans les déclaration de la Fabrique, sinon en cherchant dans les objets actifs sur ce SPIP.

Parameters
$table : string

Table SQL

$objets : array<string|int, mixed>

Description des objets générés par la Fabrique.

Return values
string

fabrique_code_autorisation()

Retourne le code pour tester un type d'autorisation

fabrique_code_autorisation(string $type, string $prefixe, array<string|int, mixed> $objet) : string
Parameters
$type : string

Quel type d'autorisation est voulue

$prefixe : string

Préfixe du plugin généré

$objet : array<string|int, mixed>

Description de l'objet dans la Fabrique

Return values
string —

Code de test de l'autorisation

fabrique_autorisation_defaut()

Retourne la valeur de type d'autorisation qui s'applique par defaut pour une autorisation donnee

fabrique_autorisation_defaut(string $autorisation) : string
Parameters
$autorisation : string

Nom de l'autorisation (objet et objets remplacent le veritable type et nom d'objet)

Return values
string —

Type d'autorisation par defaut (jamais, toujours, redacteur, ...)

fabrique_code_autorisation_defaut()

Retourne le code d'autorisation indique sinon celui par defaut pour une fonction d'autorisation

fabrique_code_autorisation_defaut(array<string|int, mixed> $autorisations, string $autorisation, string $prefixe, array<string|int, mixed> $objet) : string
Parameters
$autorisations : array<string|int, mixed>

Les autorisations renseignees par l'interface pour un objet

$autorisation : string

Le nom de l'autorisation souhaitee

$prefixe : string

Préfixe du plugin généré

$objet : array<string|int, mixed>

Description le l'objet dans la Fabrique

Return values
string —

Code de l'autorisation

objets_autorisation_presente()

Retourne vrai si un test d'autorisation est d'un type spécifié dans l'ensemble des autorisations à configurer de tous les objets

objets_autorisation_presente(array<string|int, mixed> $objets, string $recherche) : bool
Parameters
$objets : array<string|int, mixed>

Descriptions des objets de la Fabrique

$recherche : string

Le type d'autorisation recherché

Return values
bool

objets_autorisations_presentes()

Retourne vrai si au moins une autorisation est d'un des types spécifiés dans l'ensemble des autorisations à configurer de tous les objets

objets_autorisations_presentes(array<string|int, mixed> $objets, array<string|int, string> $recherches) : bool
Parameters
$objets : array<string|int, mixed>

Descriptions des objets de la Fabrique

$recherches : array<string|int, string>

Les types d'autorisations recherchés

Return values
bool

autorisation_presente()

Retourne vrai si un test d'autorisation est d'un type spécifié dans l'ensemble des autorisations à configurer d'un objet

autorisation_presente(array<string|int, mixed> $objet, string $recherche) : bool
Parameters
$objet : array<string|int, mixed>

Description d'un objet de la Fabrique

$recherche : string

Le type d'autorisation recherché

Return values
bool

fabrique_type_autorisation()

Retourne le type pour le nom d'une fonction d'autorisation 'article' => 'article' 'truc_muche' => 'trucmuche'

fabrique_type_autorisation(string $type) : string
Parameters
$type : string

Type ou objet

Return values
string —

Type pour le nom d'autorisation

lister_tables_sql()

Liste les tables sql de chaque base déclarée Avec la connexion par defaut - spip_articles - spip_truc Avec d'autres connexions - autre:spip_articles - autre:spip_truc

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

Liste des tables.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results