API Documentation
Table of Contents
Functions
- action_iextras_dist() : mixed
- action_associer_champ_sql_comme_champ_extra() : mixed
- action_supprimer_champ_sql() : mixed
- action_iextras_exporter_dist() : mixed
- Exporte des champs extras
- iextras_exporter_tous() : mixed
- Retourne tous les champs extras par table SQL
- iextras_exporter_objet_tous() : mixed
- Retourne tous les champs extras d'un objet
- iextras_exporter_objet_champ() : mixed
- Retourne un champ extra d'un objet
- iextras_envoyer_export() : mixed
- Exporte un contenu (description de champs extras) au format YAML
- iextras_preparer_export_php() : array<string|int, mixed>
- Prépare les saisies (les simplifie) pour un export au format PHP
- iextras_preparer_export_php_saisie() : array<string|int, mixed>
- Simplifie l'écriture d'une saisie de champs extras
- iextras_ecrire_export_php() : string
- Écrit le code PHP de l'export PHP
- iextras_declarer_champs_extras() : mixed
- formulaires_editer_champs_extras_charger_dist() : mixed
- formulaires_editer_champs_extras_verifier_dist() : mixed
- formulaires_editer_champs_extras_traiter_dist() : mixed
- formulaires_importer_champs_extras_charger_dist() : mixed
- formulaires_importer_champs_extras_verifier_dist() : mixed
- formulaires_importer_champs_extras_traiter_dist() : mixed
- iextras_importer_description() : bool
- Importe une description de champs extras donnée
- iextras_champs_extras_definis() : array<string|int, mixed>
- Retourne la liste des saisies extras pour un objet donné.
- compter_champs_extras() : int
- Compter les saisies extras d'une table
- iextras_saisies_construire_formulaire_config() : array<string|int, mixed>
- Ajouter les saisies - SQL - recherche - vu sur les options de config d'une saisie (de champs extras)
- iextras_autoriser() : mixed
- Fonction d'appel pour le pipeline autoriser
- autoriser_iextras_configurer_dist() : bool
- Autorisation de configurer les champs extras
- verifier_nom_champ_extra_dist() : string
- Vérifié une valeur comme devant être un nom de champ extra
- iextras_sql_reserved_keywords() : mixed
Functions
action_iextras_dist()
action_iextras_dist() : mixed
action_associer_champ_sql_comme_champ_extra()
action_associer_champ_sql_comme_champ_extra(mixed $table, mixed $champ) : mixed
Parameters
- $table : mixed
- $champ : mixed
action_supprimer_champ_sql()
action_supprimer_champ_sql(mixed $table, mixed $champ) : mixed
Parameters
- $table : mixed
- $champ : mixed
action_iextras_exporter_dist()
Exporte des champs extras
action_iextras_exporter_dist() : mixed
Crée un fichier PHP contenant des informations relatives (array) aux saisies utilisées par les champs extras sur un ou plusieurs objets
Paramètres d'action :
- yaml/tous Tous les champs extras de tous les objets
- php/tous Tous les champs extras de tous les objets (export PHP)
- yaml/objet/{type}/tous Tous les champs extras de l'objet {type}.
yaml/objet/auteur/tous
- yaml/objet/{type}/champ/{nom} Le champ {nom} de l'objet {type}.
yaml/objet/auteur/champ/date_naissance
iextras_exporter_tous()
Retourne tous les champs extras par table SQL
iextras_exporter_tous() : mixed
iextras_exporter_objet_tous()
Retourne tous les champs extras d'un objet
iextras_exporter_objet_tous(string $objet) : mixed
Parameters
- $objet : string
iextras_exporter_objet_champ()
Retourne un champ extra d'un objet
iextras_exporter_objet_champ(string $objet, string $champ) : mixed
Parameters
- $objet : string
- $champ : string
iextras_envoyer_export()
Exporte un contenu (description de champs extras) au format YAML
iextras_envoyer_export(array<string|int, mixed> $export, string $nom_fichier[, string $format = 'yaml' ]) : mixed
Envoie les données au navigateur !
Parameters
- $export : array<string|int, mixed>
- $nom_fichier : string
- $format : string = 'yaml'
-
Format d'export (yaml ou php)
iextras_preparer_export_php()
Prépare les saisies (les simplifie) pour un export au format PHP
iextras_preparer_export_php(array<string|int, mixed> $export) : array<string|int, mixed>
Parameters
- $export : array<string|int, mixed>
-
Liste des saisies, par table SQL
Return values
array<string|int, mixed> —Idem, simplifié
iextras_preparer_export_php_saisie()
Simplifie l'écriture d'une saisie de champs extras
iextras_preparer_export_php_saisie(mixed $saisie) : array<string|int, mixed>
Parameters
- $saisie : mixed
Return values
array<string|int, mixed>iextras_ecrire_export_php()
Écrit le code PHP de l'export PHP
iextras_ecrire_export_php(array<string|int, mixed> $export) : string
Parameters
- $export : array<string|int, mixed>
-
Liste des saisies, par table SQL
Return values
string —Code PHP
iextras_declarer_champs_extras()
iextras_declarer_champs_extras([mixed $saisies_tables = array() ]) : mixed
Parameters
- $saisies_tables : mixed = array()
formulaires_editer_champs_extras_charger_dist()
formulaires_editer_champs_extras_charger_dist(mixed $objet[, mixed $redirect = '' ]) : mixed
Parameters
- $objet : mixed
- $redirect : mixed = ''
formulaires_editer_champs_extras_verifier_dist()
formulaires_editer_champs_extras_verifier_dist(mixed $objet[, mixed $redirect = '' ]) : mixed
Parameters
- $objet : mixed
- $redirect : mixed = ''
formulaires_editer_champs_extras_traiter_dist()
formulaires_editer_champs_extras_traiter_dist(mixed $objet[, mixed $redirect = '' ]) : mixed
Parameters
- $objet : mixed
- $redirect : mixed = ''
formulaires_importer_champs_extras_charger_dist()
formulaires_importer_champs_extras_charger_dist() : mixed
formulaires_importer_champs_extras_verifier_dist()
formulaires_importer_champs_extras_verifier_dist() : mixed
formulaires_importer_champs_extras_traiter_dist()
formulaires_importer_champs_extras_traiter_dist() : mixed
iextras_importer_description()
Importe une description de champs extras donnée
iextras_importer_description(array<string|int, mixed> $description, string &$message[, bool $fusionner_doublons = false ]) : bool
Parameters
- $description : array<string|int, mixed>
-
description des champs extras (table sql => liste des champs extras)
- $message : string
-
message de retour, rempli par cette fonction
- $fusionner_doublons : bool = false
-
true si on fusionne les champs présents dans la sauvegarde et aussi présents sur le site. False pour les ignorer.
Return values
bool —true si tout s'est bien passé, false sinon
iextras_champs_extras_definis()
Retourne la liste des saisies extras pour un objet donné.
iextras_champs_extras_definis([string $table = '' ]) : array<string|int, mixed>
Parameters
- $table : string = ''
-
Nom de la table SQL de l'objet éditorial
Return values
array<string|int, mixed> —Liste de saisies
compter_champs_extras()
Compter les saisies extras d'une table
compter_champs_extras(string $table) : int
Parameters
- $table : string
-
Table sql
Return values
int —Nombre d'éléments.
iextras_saisies_construire_formulaire_config()
Ajouter les saisies - SQL - recherche - vu sur les options de config d'une saisie (de champs extras)
iextras_saisies_construire_formulaire_config(mixed $flux) : array<string|int, mixed>
Parameters
- $flux : mixed
Return values
array<string|int, mixed>iextras_autoriser()
Fonction d'appel pour le pipeline autoriser
iextras_autoriser() : mixed
Tags
autoriser_iextras_configurer_dist()
Autorisation de configurer les champs extras
autoriser_iextras_configurer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Il faut être webmestre !
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
verifier_nom_champ_extra_dist()
Vérifié une valeur comme devant être un nom de champ extra
verifier_nom_champ_extra_dist(string $valeur[, array<string|int, mixed> $options = array() ]) : string
Ce champ ne doit pas être utilisé par SPIP ou un plugin, et ne doit pas être un mot clé de mysql.
Si c'est bon, doit aussi vérifier une expression régulière donnée
Options :
- modele : chaine représentant l'expression régulière tolérée
Parameters
- $valeur : string
-
La valeur à vérifier.
- $options : array<string|int, mixed> = array()
-
Contient une chaine représentant l'expression.
Return values
string —Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
iextras_sql_reserved_keywords()
iextras_sql_reserved_keywords() : mixed