joindre_document.php
Gestion du formulaire de téléversement de documents
Table of Contents
Functions
- joindre_determiner_mode() : string
- Déterminer le mode d'upload si la valeur au chargement du formulaire est "auto"
- joindre_document_galerie_valide() : bool
- Indique si une galerie demandée est valide
- formulaires_joindre_document_charger_dist() : array<string|int, mixed>
- Chargement du formulaire
- formulaires_joindre_document_verifier_dist() : array<string|int, mixed>
- Vérification du formulaire
- formulaires_joindre_document_traiter_dist() : array<string|int, mixed>
- Traitement du formulaire
- joindre_options_upload_ftp() : string
- Retourner le contenu du select HTML d'utilisation de fichiers envoyes par le serveur
- joindre_liste_contenu_tailles_archive() : string
- Lister les fichiers contenus dans un zip
- joindre_liste_erreurs_to_li() : string
- Lister les erreurs dans une archive jointe Utilisé formulaires/inc-lister_archive_jointe.html
Functions
joindre_determiner_mode()
Déterminer le mode d'upload si la valeur au chargement du formulaire est "auto"
joindre_determiner_mode(string $mode, int|string $id_document, string $objet) : string
Parameters
- $mode : string
-
Le mode passé au formulaire
- $id_document : int|string
-
L'identifiant numérique du document à remplacer ou "new" par défaut
- $objet : string
-
Le type d'objet sur lequel ajouter le document
Return values
string —$mode Le mode définitif
joindre_document_galerie_valide()
Indique si une galerie demandée est valide
joindre_document_galerie_valide(string|null $galerie) : bool
Parameters
- $galerie : string|null
-
Le fichier de galerie désiré
Tags
Return values
boolformulaires_joindre_document_charger_dist()
Chargement du formulaire
formulaires_joindre_document_charger_dist([int|string $id_document = 'new' ][, int $id_objet = 0 ][, string $objet = '' ][, string $mode = 'auto' ][, string $galerie = false ][, bool|string $proposer_media = true ][, bool|string $proposer_ftp = true ]) : array<string|int, mixed>
Parameters
- $id_document : int|string = 'new'
-
L'identidiant numérique du document s'il est à remplacer, sinon "new"
- $id_objet : int = 0
-
L'identifiant numérique de l'objet sur lequel on ajoute le document
- $objet : string = ''
-
Le type de l'objet sur lequel on ajoute le document
- $mode : string = 'auto'
-
Le mode du document (auto,choix,document,image,vignette...), par défaut auto
- $galerie : string = false
-
Deprecated 4.0 (SPIP 4.1) Passer optionnellement une galerie jointe au form, plus utilise nativement, on prefere la mise a jour apres upload par ajaxReload('documents')
- $proposer_media : bool|string = true
-
Doit on afficher la médiathèque ? par défaut oui Valeurs possibles si string : false,'non','no'.
- $proposer_ftp : bool|string = true
-
Doit on afficher le ftp ? par défaut oui Valeurs possibles si string : false,'non','no'.
Return values
array<string|int, mixed> —$valeurs Les valeurs chargées dans le formulaire
formulaires_joindre_document_verifier_dist()
Vérification du formulaire
formulaires_joindre_document_verifier_dist([int|string $id_document = 'new' ][, int $id_objet = 0 ][, string $objet = '' ][, string $mode = 'auto' ][, string $galerie = false ][, bool|string $proposer_media = true ][, bool|string $proposer_ftp = true ]) : array<string|int, mixed>
Parameters
- $id_document : int|string = 'new'
-
L'identidiant numérique du document s'il est à remplacer, sinon "new"
- $id_objet : int = 0
-
L'identifiant numérique de l'objet sur lequel on ajoute le document
- $objet : string = ''
-
Le type de l'objet sur lequel on ajoute le document
- $mode : string = 'auto'
-
Le mode du document (auto,choix,document,image,vignette...), par défaut auto
- $galerie : string = false
-
Deprecated 4.0 (SPIP 4.1) Passer optionnellement une galerie jointe au form, plus utilise nativement, on prefere la mise a jour apres upload par ajaxReload('documents')
- $proposer_media : bool|string = true
-
Doit on afficher la médiathèque ? par défaut oui Valeurs possibles si string : false,'non','no'.
- $proposer_ftp : bool|string = true
-
Doit on afficher le ftp ? par défaut oui Valeurs possibles si string : false,'non','no'.
Return values
array<string|int, mixed> —$erreurs Les erreurs éventuelles dans un tableau
formulaires_joindre_document_traiter_dist()
Traitement du formulaire
formulaires_joindre_document_traiter_dist([int|string $id_document = 'new' ][, int $id_objet = 0 ][, string $objet = '' ][, string $mode = 'auto' ][, string $galerie = false ][, bool|string $proposer_media = true ][, bool|string $proposer_ftp = true ]) : array<string|int, mixed>
Parameters
- $id_document : int|string = 'new'
-
L'identidiant numérique du document s'il est à remplacer, sinon "new"
- $id_objet : int = 0
-
L'identifiant numérique de l'objet sur lequel on ajoute le document
- $objet : string = ''
-
Le type de l'objet sur lequel on ajoute le document
- $mode : string = 'auto'
-
Le mode du document (auto,choix,document,image,vignette...), par défaut auto
- $galerie : string = false
-
Deprecated 4.0 (SPIP 4.1) Passer optionnellement une galerie jointe au form, plus utilise nativement, on prefere la mise a jour apres upload par ajaxReload('documents')
- $proposer_media : bool|string = true
-
Doit on afficher la médiathèque ? par défaut oui Valeurs possibles si string : false,'non','no'.
- $proposer_ftp : bool|string = true
-
Doit on afficher le ftp ? par défaut oui Valeurs possibles si string : false,'non','no'.
Return values
array<string|int, mixed> —$res Le tableau renvoyé par les CVT avec le message et editable
joindre_options_upload_ftp()
Retourner le contenu du select HTML d'utilisation de fichiers envoyes par le serveur
joindre_options_upload_ftp(string $dir[, string $mode = 'document' ]) : string
Parameters
- $dir : string
-
Le répertoire de recherche des documents
- $mode : string = 'document'
-
Le mode d'ajout de document
Return values
string —$texte Le contenu HTML du selecteur de documents
joindre_liste_contenu_tailles_archive()
Lister les fichiers contenus dans un zip
joindre_liste_contenu_tailles_archive(array<string|int, mixed> $files) : string
Parameters
- $files : array<string|int, mixed>
-
La liste des fichiers
Return values
string —$res La liste HTML des fichiers
joindre_liste_erreurs_to_li()
Lister les erreurs dans une archive jointe Utilisé formulaires/inc-lister_archive_jointe.html
joindre_liste_erreurs_to_li(array<string|int, mixed> $erreurs) : string
Parameters
- $erreurs : array<string|int, mixed>
-
La liste des erreurs
Return values
string —$res Le code HTML des erreurs