Documentation du code de SPIP et de ses plugins

SPIP

Formulaires

Table of Contents

Packages

CVT

Functions

protege_champ()  : string|array<string|int, mixed>|null
Protéger les saisies d'un champ de formulaire
existe_formulaire()  : string|bool
Teste si un formulaire demandé possède un squelette pour l'afficher
test_formulaire_inclus_par_modele()  : false|array<string|int, mixed>
Tester si un formulaire est appele via un modele type <formulaire|...> et le cas echeant retourne les arguments passes au modele false sinon
balise_FORMULAIRE__dist()  : Champ
Balises Formulaires par défaut.
balise_FORMULAIRE__dyn()  : string|array<string|int, mixed>
Balise dynamiques par défaut des formulaires
balise_FORMULAIRE__contexte()  : array<string|int, mixed>|string
Calcule le contexte à envoyer dans le squelette d'un formulaire
formulaire__charger()  : array<string|int, mixed>
Charger les valeurs de saisie du formulaire
formulaire__identifier()  : bool
Vérifier que le formulaire en cours est celui qui est poste
balise_FORMULAIRE_ADMIN()  : Champ
Compile la balise dynamique `#FORMULAIRE_ADMIN` qui des boutons d'administration dans l'espace public
balise_FORMULAIRE_ADMIN_stat()  : array<string|int, mixed>|string
Calculs de paramètres de contexte automatiques pour la balise FORMULAIRE_ADMIN
balise_FORMULAIRE_ADMIN_dyn()  : array<string|int, mixed>|string
Retourne le squelette d'affichage et le contexte de la balise FORMULAIRE_ADMIN
admin_objet()  : array<string|int, mixed>
Préparer le contexte d'environnement pour les boutons
admin_preview()  : string|array<string|int, mixed>
Détermine si l'élément est previsualisable
admin_lang()  : string
Régler les boutons dans la langue de l'admin (sinon tant pis)
admin_valider()  : string
Retourne une URL vers un validateur
admin_debug()  : string
Retourne une URL vers le mode debug, si l'utilisateur a le droit, et si c'est utile
formulaires_configurer_preferences_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de préférences d'un auteur dans l'espace privé
formulaires_configurer_preferences_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire de préférences d'un auteur dans l'espace privé
formulaires_configurer_preferences_menus_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de préférence des menus d'un auteur dans l'espace privé
formulaires_configurer_preferences_menus_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire de préférence des menus d'un auteur dans l'espace privé
formulaires_configurer_reducteur_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de configuration de la librairie graphique
formulaires_configurer_reducteur_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire de configuration de la librairie graphique
url_vignette_choix()  : string
Indique si une librairie graphique peut être utilisée et retourne alors une URL pour tester la librairie
formulaires_dater_charger_dist()  : array<string|int, mixed>|false
Chargement du formulaire d'édition d'une date
dater_formater_saisie_jour()  : string
Formate la date
formulaires_dater_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité
formulaires_dater_verifier_dist()  : array<string|int, mixed>
Vérifications avant traitements du formulaire d'édition d'une date
formulaires_dater_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'édition d'une date
dater_recuperer_date_saisie()  : array<string|int, mixed>|string
Récupérer annee, mois, jour sur la date saisie
dater_recuperer_heure_saisie()  : array<string|int, mixed>
Récupérer heures,minutes sur l'heure saisie
determine_source_lien_objet()  : array<string|int, mixed>
Retrouve la source et l'objet de la liaison
formulaires_editer_liens_charger_dist()  : array<string|int, mixed>|false
Chargement du formulaire d'édition de liens
formulaires_editer_liens_traiter_dist()  : array<string|int, mixed>
Traiter le post des informations d'édition de liens
lien_gerer__oups()  : array<string|int, mixed>|string|null
Fonction de regroupement pour gerer le _oups de façon sécurisée sans passer par une globale ni par une _request
lien_gerer__oups_collecter_args()  : string
Collecter les args du form utilisant la fonction lien_gerer__oups()
formulaires_editer_logo_charger_dist()  : array<string|int, mixed>|false
Chargement du formulaire d'édition de logo
formulaires_editer_logo_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des parametres qui ne representent pas l'objet edite
formulaires_editer_logo_verifier_dist()  : array<string|int, mixed>
Verification avant traitement du formulaire d'édition de logo
formulaires_editer_logo_traiter_dist()  : array<string|int, mixed>
Traitement de l'upload d'un logo
formulaire_editer_logo_get_sources()  : array<string|int, mixed>
Extraction des sources des fichiers uploadés correspondant aux 2 logos (normal + survol) si leur upload s'est bien passé
choisir_rubriques_admin_restreint()  : string
Afficher le formulaire de choix de rubrique restreinte pour insertion dans le formulaire
lister_statuts_proposes()  : array<string|int, mixed>
Filtres les statuts utilisable selon les droits de publication
formulaires_instituer_objet_charger_dist()  : array<string|int, mixed>|bool
Chargement du formulaire instituer objet
formulaires_instituer_objet_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire instituer objet
formulaires_instituer_objet_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire instituer objet
is_url_prive()  : bool
Teste si une URL est une URL de l'espace privé (administration de SPIP) ou de l'espace public
formulaires_login_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de login
login_auth_http()  : string
Identification via HTTP (si pas de cookie)
formulaires_login_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire de login
login_autoriser()  : array<string|int, mixed>
Teste l'autorisation d'accéder à l'espace privé une fois une connexion réussie, si la cible est une URL privée.
formulaires_login_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire de login
formulaires_recherche_ecrire_charger_dist()  : array<string|int, mixed>
Chargement des valeurs par defaut des champs du formulaire de recherche de l'espace privé
formulaires_traduire_charger_dist()  : array<string|int, mixed>|bool
Charger les données de #FORMULAIRE_TRADUIRE
formulaires_traduire_verifier_dist()  : array<string|int, mixed>
Vérifier les saisies des valeurs du #FORMULAIRE_TRADUIRE
formulaires_traduire_traiter_dist()  : array<string|int, mixed>
Enregistrer en base les saisies du #FORMULAIRE_TRADUIRE

Functions

protege_champ()

Protéger les saisies d'un champ de formulaire

protege_champ(mixed $valeur[, mixed $max_prof = 128 ]) : string|array<string|int, mixed>|null

Proteger les ' et les " dans les champs que l'on va injecter, sans toucher aux valeurs sérialisées

Parameters
$valeur : mixed

Saisie à protéger

$max_prof : mixed = 128
Tags
see
spip_htmlspecialchars()
Return values
string|array<string|int, mixed>|null

Saisie protégée

existe_formulaire()

Teste si un formulaire demandé possède un squelette pour l'afficher

existe_formulaire(string $form) : string|bool
Parameters
$form : string

Nom du formulaire

Tags
see
trouver_fond()
Return values
string|bool
  • string : chemin du squelette
  • false : pas de squelette trouvé

test_formulaire_inclus_par_modele()

Tester si un formulaire est appele via un modele type <formulaire|...> et le cas echeant retourne les arguments passes au modele false sinon

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

balise_FORMULAIRE__dist()

Balises Formulaires par défaut.

balise_FORMULAIRE__dist(Champ $p) : Champ

Compilé en un appel à une balise dynamique.

Parameters
$p : Champ

Description de la balise formulaire

Return values
Champ

Description complétée du code compilé appelant la balise dynamique

balise_FORMULAIRE__dyn()

Balise dynamiques par défaut des formulaires

balise_FORMULAIRE__dyn(string $form, array<string|int, mixed> ...$args) : string|array<string|int, mixed>
Parameters
$form : string

Nom du formulaire

$args : array<string|int, mixed>

Arguments envoyés à l'appel du formulaire

Tags
note

Deux moyen d'arriver ici : soit #FORMULAIRE_XX reroute avec 'FORMULAIRE_XX' ajoute en premier arg soit #FORMULAIRE_{xx}

Return values
string|array<string|int, mixed>
  • array : squelette à appeler, durée du cache, contexte
  • string : texte à afficher directement

balise_FORMULAIRE__contexte()

Calcule le contexte à envoyer dans le squelette d'un formulaire

balise_FORMULAIRE__contexte(string $form, array<string|int, mixed> $args) : array<string|int, mixed>|string
Parameters
$form : string

Nom du formulaire

$args : array<string|int, mixed>

Arguments envoyés à l'appel du formulaire

Return values
array<string|int, mixed>|string

array: contexte d'environnement à envoyer au squelette string: Formulaire non applicable (message d’explication)

formulaire__charger()

Charger les valeurs de saisie du formulaire

formulaire__charger(string $form, array<string|int, mixed> $args, bool $poste) : array<string|int, mixed>
Parameters
$form : string
$args : array<string|int, mixed>
$poste : bool
Return values
array<string|int, mixed>

formulaire__identifier()

Vérifier que le formulaire en cours est celui qui est poste

formulaire__identifier(string $form, array<string|int, mixed> $args, array<string|int, mixed> $p) : bool

On se base sur la fonction identifier (si elle existe) qui fournit une signature identifiant le formulaire a partir de ses arguments significatifs

En l'absence de fonction identifier, on se base sur l'egalite des arguments, ce qui fonctionne dans les cas simples

Parameters
$form : string
$args : array<string|int, mixed>
$p : array<string|int, mixed>
Return values
bool

balise_FORMULAIRE_ADMIN()

Compile la balise dynamique `#FORMULAIRE_ADMIN` qui des boutons d'administration dans l'espace public

balise_FORMULAIRE_ADMIN(Champ $p) : Champ

Cette balise permet de placer les boutons d'administrations dans un endroit spécifique du site. Si cette balise n'est pas présente, les boutons seront automatiquement ajoutés par SPIP si l'auteur a activé le cookie de correspondance.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
f_admin()
example
#FORMULAIRE_ADMIN
Return values
Champ

Pile complétée du code compilé

balise_FORMULAIRE_ADMIN_stat()

Calculs de paramètres de contexte automatiques pour la balise FORMULAIRE_ADMIN

balise_FORMULAIRE_ADMIN_stat(array<string|int, mixed> $args, array<string|int, mixed> $context_compil) : array<string|int, mixed>|string

On ne peut rien dire au moment de l'execution du squelette

Parameters
$args : array<string|int, mixed>
  • Classe CSS éventuelle
$context_compil : array<string|int, mixed>

Tableau d'informations sur la compilation

Return values
array<string|int, mixed>|string
  • Liste (statut, id) si un mode d'inscription est possible
  • chaîne vide sinon.

balise_FORMULAIRE_ADMIN_dyn()

Retourne le squelette d'affichage et le contexte de la balise FORMULAIRE_ADMIN

balise_FORMULAIRE_ADMIN_dyn([string $float = '' ][, string|array<string|int, mixed> $debug = '' ]) : array<string|int, mixed>|string
Parameters
$float : string = ''

Classe CSS éventuelle

$debug : string|array<string|int, mixed> = ''

Informations sur la page contenant une erreur de compilation

Tags
note

Les boutons admin sont mis d'autorité si absents donc une variable statique contrôle si FORMULAIRE_ADMIN a été vu.

Toutefois, si c'est le debuger qui appelle, il peut avoir recopié le code dans ses données et il faut le lui refournir. Pas question de recompiler: ca fait boucler ! Le debuger transmet donc ses données, et cette balise y retrouve son petit.

Return values
array<string|int, mixed>|string

Liste : Chemin du squelette, durée du cache, contexte

admin_objet()

Préparer le contexte d'environnement pour les boutons

admin_objet() : array<string|int, mixed>

Permettra d'afficher le bouton 'Modifier ce...' s'il y a un $id_XXX défini dans le contexte de la page

Tags
note

Attention à l'ordre dans la boucle: on ne veut pas la rubrique si un autre bouton est possible

Return values
array<string|int, mixed>

Tableau de l'environnement calculé

admin_preview()

Détermine si l'élément est previsualisable

admin_preview(string $type, int $id[, array<string|int, mixed>|null $desc = null ]) : string|array<string|int, mixed>
Parameters
$type : string

Type d'objet

$id : int

Identifinant de l'objet

$desc : array<string|int, mixed>|null = null

Description de la table

Return values
string|array<string|int, mixed>
  • Chaine vide si on est déjà en prévisu ou si pas de previsualisation possible
  • Tableau d'un élément sinon.

admin_lang()

Régler les boutons dans la langue de l'admin (sinon tant pis)

admin_lang() : string
Return values
string

Code de langue

admin_valider()

Retourne une URL vers un validateur

admin_valider() : string
Return values
string

admin_debug()

Retourne une URL vers le mode debug, si l'utilisateur a le droit, et si c'est utile

admin_debug() : string
Return values
string

formulaires_configurer_preferences_charger_dist()

Chargement du formulaire de préférences d'un auteur dans l'espace privé

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

Environnement du formulaire

formulaires_configurer_preferences_traiter_dist()

Traitements du formulaire de préférences d'un auteur dans l'espace privé

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

Retours des traitements

formulaires_configurer_preferences_menus_charger_dist()

Chargement du formulaire de préférence des menus d'un auteur dans l'espace privé

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

Environnement du formulaire

formulaires_configurer_preferences_menus_traiter_dist()

Traitements du formulaire de préférence des menus d'un auteur dans l'espace privé

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

Retours des traitements

formulaires_configurer_reducteur_charger_dist()

Chargement du formulaire de configuration de la librairie graphique

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

Environnement du formulaire

formulaires_configurer_reducteur_traiter_dist()

Traitements du formulaire de configuration de la librairie graphique

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

Retours des traitements

url_vignette_choix()

Indique si une librairie graphique peut être utilisée et retourne alors une URL pour tester la librairie

url_vignette_choix(string $process) : string
Parameters
$process : string

Code de la libriairie, parmi gd2, netpbm, imagick ou convert

Return values
string

URL d'action pour tester la librairie graphique en créant une vignette

formulaires_dater_charger_dist()

Chargement du formulaire d'édition d'une date

formulaires_dater_charger_dist(string $objet, int $id_objet[, string $retour = '' ][, array<string|int, mixed>|string $options = [] ]) : array<string|int, mixed>|false
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de redirection après le traitement

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

Options. Si string, unserialize pour obtenir un tableau.

  • date_redac : Permet de modifier en plus la date de rédaction antérieure
  • champ_date : permet de preciser le champ date qu'on utilise
  • label_date : label optionnel pour la saisie du champ date
  • champ_date_redac : permet de preciser le champ date_redac qu'on utilise
  • label_date_redac : label optionnel pour la saisie du champ date_redac
  • texte_sans_date_redac : texte optionnel affiche pour vider la date_redac
  • class : une classe ajoutable au formulaire pour le distinguer si on a plusieurs occurences
Return values
array<string|int, mixed>|false

Environnement du formulaire

dater_formater_saisie_jour()

Formate la date

dater_formater_saisie_jour(string|int $jour, string|int $mois, string|int $annee[, string $sep = '/' ]) : string
Parameters
$jour : string|int

Numéro du jour

$mois : string|int

Numéro du mois

$annee : string|int

Année

$sep : string = '/'

Séparateur

Return values
string

Date formatée tel que 02/10/2012

formulaires_dater_identifier_dist()

Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité

formulaires_dater_identifier_dist(string $objet, int $id_objet[, string $retour = '' ][, array<string|int, mixed>|string $options = [] ]) : string
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de redirection après le traitement

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

Options.

Return values
string

Hash du formulaire

formulaires_dater_verifier_dist()

Vérifications avant traitements du formulaire d'édition d'une date

formulaires_dater_verifier_dist(string $objet, int $id_objet[, string $retour = '' ][, array<string|int, mixed>|string $options = [] ]) : array<string|int, mixed>
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de redirection après le traitement

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

Options.

Return values
array<string|int, mixed>

Tableau des erreurs

formulaires_dater_traiter_dist()

Traitement du formulaire d'édition d'une date

formulaires_dater_traiter_dist(string $objet, int $id_objet[, string $retour = '' ][, array<string|int, mixed>|string $options = [] ]) : array<string|int, mixed>
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de redirection après le traitement

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

Options.

Return values
array<string|int, mixed>

Retours des traitements

dater_recuperer_date_saisie()

Récupérer annee, mois, jour sur la date saisie

dater_recuperer_date_saisie(string $post[, string $quoi = 'date' ]) : array<string|int, mixed>|string
Parameters
$post : string
$quoi : string = 'date'
Return values
array<string|int, mixed>|string

Chaîne vide si date invalide, tableau (année, mois, jour) sinon.

dater_recuperer_heure_saisie()

Récupérer heures,minutes sur l'heure saisie

dater_recuperer_heure_saisie(string $post) : array<string|int, mixed>
Parameters
$post : string
Return values
array<string|int, mixed>

determine_source_lien_objet()

Retrouve la source et l'objet de la liaison

determine_source_lien_objet(string $a, string|int $b, int|string $c) : array<string|int, mixed>

À partir des 3 premiers paramètres transmis au formulaire, la fonction retrouve :

  • l'objet dont on utilise sa table de liaison (table_source)
  • l'objet et id_objet sur qui on lie des éléments (objet, id_objet)
  • l'objet que l'on veut lier dessus (objet_lien)
Parameters
$a : string
$b : string|int
$c : int|string
Return values
array<string|int, mixed>

($table_source,$objet,$id_objet,$objet_lien)

formulaires_editer_liens_charger_dist()

Chargement du formulaire d'édition de liens

formulaires_editer_liens_charger_dist(string $a, string|int $b, int|string $c[, array<string|int, mixed>|bool $options = [] ]) : array<string|int, mixed>|false

#FORMULAIRE_EDITER_LIENS{auteurs,article,23} pour associer des auteurs à l'article 23, sur la table pivot spip_auteurs_liens #FORMULAIRE_EDITER_LIENS{article,23,auteurs} pour associer des auteurs à l'article 23, sur la table pivot spip_articles_liens #FORMULAIRE_EDITER_LIENS{articles,auteur,12} pour associer des articles à l'auteur 12, sur la table pivot spip_articles_liens #FORMULAIRE_EDITER_LIENS{auteur,12,articles} pour associer des articles à l'auteur 12, sur la table pivot spip_auteurs_liens

Parameters
$a : string
$b : string|int
$c : int|string
$options : array<string|int, mixed>|bool = []
  • Si array, tableau d'options
  • Si bool : valeur de l'option 'editable' uniquement
Return values
array<string|int, mixed>|false

formulaires_editer_liens_traiter_dist()

Traiter le post des informations d'édition de liens

formulaires_editer_liens_traiter_dist(string $a, string|int $b, int|string $c[, array<string|int, mixed>|bool $options = [] ]) : array<string|int, mixed>

Les formulaires peuvent poster dans quatre variables

  • ajouter_lien et supprimer_lien
  • remplacer_lien
  • qualifier_lien
  • ordonner_lien
  • desordonner_liens

Les deux premières peuvent être de trois formes différentes : ajouter_lien[]="objet1-id1-objet2-id2" ajouter_lien[objet1-id1-objet2-id2]="nimportequoi" ajouter_lien['clenonnumerique']="objet1-id1-objet2-id2" Dans ce dernier cas, la valeur ne sera prise en compte que si _request('clenonnumerique') est vrai (submit associé a l'input)

remplacer_lien doit être de la forme remplacer_lien[objet1-id1-objet2-id2]="objet3-id3-objet2-id2" ou objet1-id1 est celui qu'on enleve et objet3-id3 celui qu'on ajoute

qualifier_lien doit être de la forme, et sert en complément de ajouter_lien qualifier_lien[objet1-id1-objet2-id2][role] = array("role1", "autre_role") qualifier_lien[objet1-id1-objet2-id2][valeur] = array("truc", "chose") produira 2 liens chacun avec array("role"=>"role1","valeur"=>"truc") et array("role"=>"autre_role","valeur"=>"chose")

ordonner_lien doit être de la forme, et sert pour trier les liens ordonner_lien[objet1-id1-objet2-id2] = nouveau_rang

desordonner_liens n'a pas de forme précise, il doit simplement être non nul/non vide

Parameters
$a : string
$b : string|int
$c : int|string
$options : array<string|int, mixed>|bool = []
  • Si array, tableau d'options
  • Si bool : valeur de l'option 'editable' uniquement
Return values
array<string|int, mixed>

lien_gerer__oups()

Fonction de regroupement pour gerer le _oups de façon sécurisée sans passer par une globale ni par une _request

lien_gerer__oups(string $form, string $action[, array<string|int, mixed>|null $valeur = null ]) : array<string|int, mixed>|string|null
Parameters
$form : string
$action : string
$valeur : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>|string|null

lien_gerer__oups_collecter_args()

Collecter les args du form utilisant la fonction lien_gerer__oups()

lien_gerer__oups_collecter_args(string $form, array<string|int, mixed> $trace) : string
Parameters
$form : string
$trace : array<string|int, mixed>
Return values
string

formulaires_editer_logo_charger_dist()

Chargement du formulaire d'édition de logo

formulaires_editer_logo_charger_dist(string $objet, int $id_objet[, string $retour = '' ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|false
Parameters
$objet : string

Objet SPIP auquel sera lie le document (ex. article)

$id_objet : int

Identifiant de l'objet

$retour : string = ''

Url de redirection apres traitement

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

Tableau d'option (exemple : image_reduire => 50)

Return values
array<string|int, mixed>|false

Variables d'environnement pour le fond

formulaires_editer_logo_identifier_dist()

Identifier le formulaire en faisant abstraction des parametres qui ne representent pas l'objet edite

formulaires_editer_logo_identifier_dist(string $objet, int $id_objet[, string $retour = '' ][, array<string|int, mixed> $options = [] ]) : string
Parameters
$objet : string

Objet SPIP auquel sera lie le document (ex. article)

$id_objet : int

Identifiant de l'objet

$retour : string = ''

Url de redirection apres traitement

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

Tableau d'option (exemple : image_reduire => 50)

Return values
string

Hash du formulaire

formulaires_editer_logo_verifier_dist()

Verification avant traitement du formulaire d'édition de logo

formulaires_editer_logo_verifier_dist(string $objet, int $id_objet[, string $retour = '' ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

On verifie que l'upload s'est bien passe et que le document recu est une image (d'apres son extension)

Parameters
$objet : string

Objet SPIP auquel sera lie le document (ex. article)

$id_objet : int

Identifiant de l'objet

$retour : string = ''

Url de redirection apres traitement

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

Tableau d'option (exemple : image_reduire => 50)

Return values
array<string|int, mixed>

Erreurs du formulaire

formulaires_editer_logo_traiter_dist()

Traitement de l'upload d'un logo

formulaires_editer_logo_traiter_dist(string $objet, int $id_objet[, string $retour = '' ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Il est affecte au site si la balise n'est pas dans une boucle, sinon a l'objet concerne par la boucle ou indiquee par les parametres d'appel

Parameters
$objet : string

Objet SPIP auquel sera lie le document (ex. article)

$id_objet : int

Identifiant de l'objet

$retour : string = ''

Url de redirection apres traitement

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

Tableau d'option (exemple : image_reduire => 50)

Return values
array<string|int, mixed>

Retour des traitements

formulaire_editer_logo_get_sources()

Extraction des sources des fichiers uploadés correspondant aux 2 logos (normal + survol) si leur upload s'est bien passé

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

Sources des fichiers dans les clés on ou off

choisir_rubriques_admin_restreint()

Afficher le formulaire de choix de rubrique restreinte pour insertion dans le formulaire

choisir_rubriques_admin_restreint(int $id_auteur[, string $label = '' ][, string $sel_css = '#liste_rubriques_restreintes' ][, string $img_remove = '' ]) : string
Parameters
$id_auteur : int
$label : string = ''
$sel_css : string = '#liste_rubriques_restreintes'

Sélecteur CSS déterminant le conteneur de l'input reçevant les rubriques sélectionnées

$img_remove : string = ''

Balise <img...> pour enlever des rubriques

Return values
string

Code HTML et javascript

lister_statuts_proposes()

Filtres les statuts utilisable selon les droits de publication

lister_statuts_proposes(array<string|int, mixed> $desc[, bool $publiable = true ]) : array<string|int, mixed>
Parameters
$desc : array<string|int, mixed>
$publiable : bool = true
Return values
array<string|int, mixed>

formulaires_instituer_objet_charger_dist()

Chargement du formulaire instituer objet

formulaires_instituer_objet_charger_dist(string $objet, int $id_objet[, string $retour = '' ][, bool $editable = true ]) : array<string|int, mixed>|bool
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de redirection après le traitement

$editable : bool = true

Indique si le statut est éditable ou non. Dans tous les cas, si l'on n'a pas la permission de modifier l'objet, cette option sera mise à false.

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

Environnement du formulaire ou false si aucun affichage à faire.

formulaires_instituer_objet_verifier_dist()

Vérifications du formulaire instituer objet

formulaires_instituer_objet_verifier_dist(string $objet, int $id_objet[, string $retour = '' ][, bool $editable = true ]) : array<string|int, mixed>
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de redirection après le traitement

$editable : bool = true

Indique si le statut est éditable ou non.

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

Tableau des erreurs

formulaires_instituer_objet_traiter_dist()

Traitements du formulaire instituer objet

formulaires_instituer_objet_traiter_dist(string $objet, int $id_objet[, string $retour = '' ][, bool $editable = true ]) : array<string|int, mixed>
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de redirection après le traitement

$editable : bool = true

Indique si le statut est éditable ou non.

Return values
array<string|int, mixed>

Retour des traitements

is_url_prive()

Teste si une URL est une URL de l'espace privé (administration de SPIP) ou de l'espace public

is_url_prive(string $cible) : bool
Parameters
$cible : string

URL

Return values
bool

true si espace privé, false sinon.

formulaires_login_charger_dist()

Chargement du formulaire de login

formulaires_login_charger_dist([string $cible = '' ][, array<string|int, mixed> $options = [] ][, null $deprecated = null ]) : array<string|int, mixed>

Si on est déjà connecté, on redirige directement sur l'URL cible !

Parameters
$cible : string = ''

URL de destination après identification. Cas spécifique : la valeur @page_auteur permet d'être redirigé après connexion sur le squelette public de l'auteur qui se connecte.

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

string $login : Login de la personne à identifier (si connu) null|bool $prive : Identifier pour l'espace privé (true), public (false) ou automatiquement (null) en fonction de la destination de l'URL cible.

$deprecated : null = null
Tags
uses
auth_informer_login()
uses
is_url_prive()
uses
login_auth_http()
Return values
array<string|int, mixed>

Environnement du formulaire

login_auth_http()

Identification via HTTP (si pas de cookie)

login_auth_http() : string

Gére le cas où un utilisateur ne souhaite pas de cookie : on propose alors un formulaire pour s'authentifier via http

Tags
used-by
formulaires_login_charger_dist()
Return values
string
  • Si connection possible en HTTP : URL pour réaliser cette identification,
  • chaîne vide sinon.

formulaires_login_verifier_dist()

Vérifications du formulaire de login

formulaires_login_verifier_dist([string $cible = '' ][, array<string|int, mixed> $options = [] ][, null $deprecated = null ]) : array<string|int, mixed>

Connecte la personne si l'identification réussie.

Parameters
$cible : string = ''

URL de destination après identification. Cas spécifique : la valeur @page_auteur permet d'être redirigé après connexion sur le squelette public de l'auteur qui se connecte.

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

string $login : Login de la personne à identifier (si connu) null|bool $prive : Identifier pour l'espace privé (true), public (false) ou automatiquement (null) en fonction de la destination de l'URL cible.

$deprecated : null = null
Tags
uses
auth_identifier_login()
uses
auth_loger()
uses
login_autoriser()
Return values
array<string|int, mixed>

Erreurs du formulaire

login_autoriser()

Teste l'autorisation d'accéder à l'espace privé une fois une connexion réussie, si la cible est une URL privée.

login_autoriser() : array<string|int, mixed>

Dans le cas contraire, un message d'erreur est retourné avec un lien pour se déconnecter.

Tags
used-by
formulaires_login_verifier_dist()
Return values
array<string|int, mixed>
  • Erreur si un connecté n'a pas le droit d'acceder à l'espace privé
  • tableau vide sinon.

formulaires_login_traiter_dist()

Traitements du formulaire de login

formulaires_login_traiter_dist([string $cible = '' ][, array<string|int, mixed> $options = [] ][, null $deprecated = null ]) : array<string|int, mixed>

On arrive ici une fois connecté. On redirige simplement sur l'URL cible désignée.

Parameters
$cible : string = ''

URL de destination après identification. Cas spécifique : la valeur @page_auteur permet d'être redirigé après connexion sur le squelette public de l'auteur qui se connecte.

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

string $login : Login de la personne à identifier (si connu) null|bool $prive : Identifier pour l'espace privé (true), public (false) ou automatiquement (null) en fonction de la destination de l'URL cible.

$deprecated : null = null
Return values
array<string|int, mixed>

Retours du traitement

formulaires_recherche_ecrire_charger_dist()

Chargement des valeurs par defaut des champs du formulaire de recherche de l'espace privé

formulaires_recherche_ecrire_charger_dist([string $action = '' ][, string $class = '' ]) : array<string|int, mixed>

Le formulaire dirige son action directement sur la page de l'action demandée. Il n'y a pas de vérification ni de traitement dans ce formulaire.

Parameters
$action : string = ''

URL de la page exec qui reçoit la recherche. Par défaut l'URL de l'exec 'recherche'.

$class : string = ''

Classe CSS supplémentaire appliquée sur le formulaire

Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_traduire_charger_dist()

Charger les données de #FORMULAIRE_TRADUIRE

formulaires_traduire_charger_dist(string $objet, int $id_objet[, string $retour = '' ][, bool $traduire = true ]) : array<string|int, mixed>|bool
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de retour

$traduire : bool = true

Permet de désactiver la gestion de traduction sur un objet ayant id_trad

Return values
array<string|int, mixed>|bool

False si l'identifiant n'est pas numérique ou si l'objet n'a pas de langue Contexte à transmettre au squelette du formulaire sinon

formulaires_traduire_verifier_dist()

Vérifier les saisies des valeurs du #FORMULAIRE_TRADUIRE

formulaires_traduire_verifier_dist(string $objet, int $id_objet[, string $retour = '' ][, bool $traduire = true ]) : array<string|int, mixed>
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de retour

$traduire : bool = true

Permet de désactiver la gestion de traduction sur un objet ayant id_trad

Return values
array<string|int, mixed>

Erreurs des saisies

formulaires_traduire_traiter_dist()

Enregistrer en base les saisies du #FORMULAIRE_TRADUIRE

formulaires_traduire_traiter_dist(string $objet, int $id_objet[, string $retour = '' ][, bool $traduire = true ]) : array<string|int, mixed>
Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$retour : string = ''

URL de retour

$traduire : bool = true

Permet de désactiver la gestion de traduction sur un objet ayant id_trad

Return values
array<string|int, mixed>

Retour des traitements


        
On this page

Search results