API Documentation
Table of Contents
Constants
- _CVTUPLOAD_AGE_MAX = 6 * 3600
- _CVTUPLOAD_MAX_FILES = 200
Functions
- cvtupload_formulaire_charger() : array<string|int, mixed>
- Charger les informations qui correspondent aux champs fichiers du formulaire
- cvtupload_formulaire_receptionner() : array<string|int, mixed>
- Conserver les informations uploadés
- cvtupload_saisies_verifier() : array<string|int, mixed>
- Nettoyer le FILES s'il y a des erreurs dans les fichiers
- cvtupload_formulaire_fond() : array<string|int, mixed>
- Injecter le html de presentation du fichier deja uploade avant chaque input file
- cvtupload_insert_head_css() : string
- Ajouter la CSS dans le head du site public
- cvtupload_saisies_autonomes() : array<string|int, mixed>
- La saisie fichiers est autonome
- cvtupload_saisies_verifier_lister_disponibles() : array<string|int, mixed>
- La saisie fichiers ne peut utiliser que la vérification fichiers et elle doit obligatoirement l'utiliser
- supprimer_timestamp() : mixed
- _image_reduire_base64() : string
- Réduit une image, puis encode en base64, puis supprime la vignette qui a été créée.
- cvtupload_nom2classe() : string
- Passer un nom en une valeur compatible avec une classe css
- formulaires_test_upload_charger() : mixed
- formulaires_test_upload_fichiers() : mixed
- formulaires_test_upload_verifier() : mixed
- formulaires_test_upload_traiter() : mixed
- formulaires_test_upload_saisies() : mixed
- formulaires_test_upload_saisie_charger() : mixed
- formulaires_test_upload_saisie_fichiers() : mixed
- formulaires_test_upload_saisie_verifier() : mixed
- formulaires_test_upload_saisie_traiter() : mixed
- cvtupload_formulaire_id() : string
- Calculer un uniqid du formulaire et de ses args pour ne pas se melanger les pinceaux entre plusieurs formulaires
- cvtupload_chercher_fichiers() : array<string|int, mixed>
- Chercher si des champs fichiers ont été déclarés dans le fichier formulaires/xxx.php Sert de condition preliminaire pour les pipelines formulaire_charger, formulaire_verifier et formulaire_fond du plugin
- cvtupload_generer_html() : array<string|int, mixed>
- Génére le HTML de chaque fichier déjà uploadé
- cvtupload_generer_hidden() : string
- Return le hidden de chaque fichier déjà uploadé
- cvtupload_deplacer_fichier() : array<string|int, mixed>
- Déplace un fichier uploadé dans un endroit temporaire et retourne des informations dessus.
- cvtupload_modifier_files() : void
- Modifier $_FILES pour que le nom et le chemin du fichier temporaire correspondent à ceux qu'on a défini dans cvtupload_deplacer_fichier().
- cvtupload_nettoyer_files_selon_erreurs() : void
- Nettoyer $_FILES pour effacer les entrées dont on a vérifié qu'elle ne répondaient pas à certains critères
- cvt_upload_determiner_mime() : string
- Détermine un MIME lorsque les informations de PHP sont imprécises.
- cvtupload_nettoyer_repertoire() : void
- Nettoyer un répertoire suivant l'age et le nombre de ses fichiers
- cvtupload_vue_from_FILES() : array<string|int, mixed>
- Regarde le tableau des _FILES sous sa forme 'fichiers_1' => array( 'name' => array(0 =>), 'error' => array(0 =>), et renvoie une version utilisable pour afficher une vue 'fichiers_array( 0 => array( 'nom' => , 'extension' =>, 'vignette' =>, 'taille' => 'mime' => )
- inc_cvtupload_precharger_fichiers_dist() : array<string|int, mixed>
- Une fonction qui permet de précharger des fichiers.
- chercher_verifier_fichiers() : array<string|int, mixed>
- Chercher les options de la vérification de type 'fichiers' Soit directement dans #ENV{verifier} soit dans un de ses indexes
- saisies_afficher_si_js_fichiers() : string
- Génère les tests js pour les saisies fichiers Permet de tests @fichiers_1@:TOTAL > 3
Constants
_CVTUPLOAD_AGE_MAX
public
mixed
_CVTUPLOAD_AGE_MAX
= 6 * 3600
_CVTUPLOAD_MAX_FILES
public
mixed
_CVTUPLOAD_MAX_FILES
= 200
Functions
cvtupload_formulaire_charger()
Charger les informations qui correspondent aux champs fichiers du formulaire
cvtupload_formulaire_charger(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
- $flux : array<string|int, mixed>
Return values
array<string|int, mixed> —mixed
cvtupload_formulaire_receptionner()
Conserver les informations uploadés
cvtupload_formulaire_receptionner(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
- $flux : array<string|int, mixed>
Return values
array<string|int, mixed>cvtupload_saisies_verifier()
Nettoyer le FILES s'il y a des erreurs dans les fichiers
cvtupload_saisies_verifier(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
- $flux : array<string|int, mixed>
Return values
array<string|int, mixed>cvtupload_formulaire_fond()
Injecter le html de presentation du fichier deja uploade avant chaque input file
cvtupload_formulaire_fond(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
- $flux : array<string|int, mixed>
Return values
array<string|int, mixed> —mixed
cvtupload_insert_head_css()
Ajouter la CSS dans le head du site public
cvtupload_insert_head_css(string $flux[, bool $prive = false ]) : string
Parameters
- $flux : string
- $prive : bool = false
Return values
stringcvtupload_saisies_autonomes()
La saisie fichiers est autonome
cvtupload_saisies_autonomes(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
- $flux : array<string|int, mixed>
Return values
array<string|int, mixed> —$flux
cvtupload_saisies_verifier_lister_disponibles()
La saisie fichiers ne peut utiliser que la vérification fichiers et elle doit obligatoirement l'utiliser
cvtupload_saisies_verifier_lister_disponibles(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
- $flux : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>supprimer_timestamp()
supprimer_timestamp(mixed $url) : mixed
Parameters
- $url : mixed
_image_reduire_base64()
Réduit une image, puis encode en base64, puis supprime la vignette qui a été créée.
_image_reduire_base64(string $img, int $taille) : string
Ceci permet que la vignette ne soit pas conservée dans local/ et donc évite que la vignette d'une image potentiellement confidentielle soit visible. Note: le filtre ne commence pas par image, car SPIP applique automatiquement un image_graver dans ce cas -> ca plante
Parameters
- $img : string
-
la balise img
- $taille : int
-
la nouvelle taille
Return values
string —la balise img
cvtupload_nom2classe()
Passer un nom en une valeur compatible avec une classe css
cvtupload_nom2classe(string $nom) : string
- toto => toto,
- toto/truc => toto_truc,
- toto[truc] => toto_truc
Parameters
- $nom : string
Return values
stringformulaires_test_upload_charger()
formulaires_test_upload_charger() : mixed
formulaires_test_upload_fichiers()
formulaires_test_upload_fichiers() : mixed
formulaires_test_upload_verifier()
formulaires_test_upload_verifier() : mixed
formulaires_test_upload_traiter()
formulaires_test_upload_traiter() : mixed
formulaires_test_upload_saisies()
formulaires_test_upload_saisies() : mixed
formulaires_test_upload_saisie_charger()
formulaires_test_upload_saisie_charger() : mixed
formulaires_test_upload_saisie_fichiers()
formulaires_test_upload_saisie_fichiers() : mixed
formulaires_test_upload_saisie_verifier()
formulaires_test_upload_saisie_verifier() : mixed
formulaires_test_upload_saisie_traiter()
formulaires_test_upload_saisie_traiter() : mixed
cvtupload_formulaire_id()
Calculer un uniqid du formulaire et de ses args pour ne pas se melanger les pinceaux entre plusieurs formulaires
cvtupload_formulaire_id(mixed $form, mixed $args) : string
Parameters
- $form : mixed
- $args : mixed
Return values
stringcvtupload_chercher_fichiers()
Chercher si des champs fichiers ont été déclarés dans le fichier formulaires/xxx.php Sert de condition preliminaire pour les pipelines formulaire_charger, formulaire_verifier et formulaire_fond du plugin
cvtupload_chercher_fichiers(string $form, array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $form : string
-
le nom du formulaire
- $args : array<string|int, mixed>
-
- l'id de l'objet
Return values
array<string|int, mixed> —valeur(s) de l'attribut 'name' du ou des input de type file dans formulaires/xxx.html
cvtupload_generer_html()
Génére le HTML de chaque fichier déjà uploadé
cvtupload_generer_html([array<string|int, mixed> $infos_fichiers = null ]) : array<string|int, mixed>
Parameters
- $infos_fichiers : array<string|int, mixed> = null
-
Tableau contenant les informations pour chaque champ de fichier
Return values
array<string|int, mixed> —Retourne un tableau avec pour chaque champ une clé contenant le HTML
cvtupload_generer_hidden()
Return le hidden de chaque fichier déjà uploadé
cvtupload_generer_hidden([array<string|int, mixed> $infos_fichiers = null ]) : string
Parameters
- $infos_fichiers : array<string|int, mixed> = null
-
Tableau contenant les informations pour chaque champ de fichier
Return values
string —Retourne un tableau avec pour chaque champ une clé contenant le HTML
cvtupload_deplacer_fichier()
Déplace un fichier uploadé dans un endroit temporaire et retourne des informations dessus.
cvtupload_deplacer_fichier(array<string|int, mixed> $fichier, string $repertoire, string $form[, bool $deplacer = true ]) : array<string|int, mixed>
Parameters
- $fichier : array<string|int, mixed>
-
Le morceau de $_FILES concernant le ou les fichiers
- $repertoire : string
-
Chemin de destination des fichiers
- $form : string
-
Formulaire d'où ça vient
- $deplacer : bool = true
-
Mettre a False pour se contenter de copier
Return values
array<string|int, mixed> —Retourne un tableau d'informations sur le fichier ou un tableau de tableaux si plusieurs fichiers. Ce tableau est compatible avec l'action "ajouter_un_fichier" de SPIP.
cvtupload_modifier_files()
Modifier $_FILES pour que le nom et le chemin du fichier temporaire correspondent à ceux qu'on a défini dans cvtupload_deplacer_fichier().
cvtupload_modifier_files(mixed $infos_fichiers) : void
Cela permet aux traitements ultérieurs de ne pas avoir à se préoccuper de l'emploi ou non de cvtupload.
Parameters
- $infos_fichiers : mixed
-
Information sur les fichiers tels que déplacés par cvtupload_deplacer_fichier()
cvtupload_nettoyer_files_selon_erreurs()
Nettoyer $_FILES pour effacer les entrées dont on a vérifié qu'elle ne répondaient pas à certains critères
cvtupload_nettoyer_files_selon_erreurs(string $champ, array<string|int, string>|string $erreurs) : void
Parameters
- $champ : string
-
Le nom du champ concerné dans $_FILES
- $erreurs : array<string|int, string>|string
-
Si un upload multiple, un tableau des $erreurs avec comme clés les numéros des fichiers à supprimer dans $_FILES[$champ] Si un upload unique, une chaîne, qui si non vide, indique qu'il faut effacer le $_FILE[$champ]
cvt_upload_determiner_mime()
Détermine un MIME lorsque les informations de PHP sont imprécises.
cvt_upload_determiner_mime(string $mime_suppose, string $extension) : string
Par exemple PHP considère qu'un fichier .tex est de MIME application/octet-stream Ce qui n'est absolument pas utilse
Parameters
- $mime_suppose : string
- $extension : string
Return values
string —$mime_trouve
cvtupload_nettoyer_repertoire()
Nettoyer un répertoire suivant l'age et le nombre de ses fichiers
cvtupload_nettoyer_repertoire(string $repertoire[, int $age_max = _CVTUPLOAD_AGE_MAX ][, int $max_files = _CVTUPLOAD_MAX_FILES ]) : void
Parameters
- $repertoire : string
-
Répertoire à nettoyer
- $age_max : int = _CVTUPLOAD_AGE_MAX
-
Age maxium des fichiers en seconde
- $max_files : int = _CVTUPLOAD_MAX_FILES
-
Nombre maximum de fichiers dans le dossier
cvtupload_vue_from_FILES()
Regarde le tableau des _FILES sous sa forme 'fichiers_1' => array( 'name' => array(0 =>), 'error' => array(0 =>), et renvoie une version utilisable pour afficher une vue 'fichiers_array( 0 => array( 'nom' => , 'extension' =>, 'vignette' =>, 'taille' => 'mime' => )
cvtupload_vue_from_FILES() : array<string|int, mixed>
Return values
array<string|int, mixed>inc_cvtupload_precharger_fichiers_dist()
Une fonction qui permet de précharger des fichiers.
inc_cvtupload_precharger_fichiers_dist(array<string|int, mixed> $fichiers, string $form) : array<string|int, mixed>
Si la fonction formulaires_formidable_charger a un champ cvtupload_precharger_fichiers dans son tableau de retour, les fichiers sont préchargés. Ce champ est une simple liste de fichiers à précharger
Parameters
- $fichiers : array<string|int, mixed>
-
la liste des fichiers à précharger, structure sous forme de tableau champ/clé par exemple array( 'champ'=>array( 0 => array('chemin'=>chemin_du_fichier,'url'=>url_pour_lire_le_fichier), 1 => array('chemin'=>chemin_du_fichier,'url'=>url_pour_lire_le_fichier))
- $form : string
-
le formulaire d'où cela vient
Return values
array<string|int, mixed> —$infos_fichiers un tableau de description de fichiers à la mode cvtupload
chercher_verifier_fichiers()
Chercher les options de la vérification de type 'fichiers' Soit directement dans #ENV{verifier} soit dans un de ses indexes
chercher_verifier_fichiers([mixed $verifier = null ]) : array<string|int, mixed>
Parameters
- $verifier : mixed = null
Return values
array<string|int, mixed>saisies_afficher_si_js_fichiers()
Génère les tests js pour les saisies fichiers Permet de tests @fichiers_1@:TOTAL > 3
saisies_afficher_si_js_fichiers(array<string|int, mixed> $parse, array<string|int, mixed> $saisies_form) : string
Parameters
- $parse : array<string|int, mixed>
-
le parsage du test
- $saisies_form : array<string|int, mixed>
-
l'ensemble des saisies du formulaire, triées par nom
Return values
string —: du code JS qui peut passer par eval. Note : comme le besoin est limitée, on génère encore du JS dynamique, plutôt qu'un JS global qu'on chargerait systématiquement :
- alléger le chargement dans 90% des case
- flemme de Maïeul d'écrire ce JS générique