Fichier plugins-dist/bigup/bigup_fonctions.php

Fonctions utiles au plugin Big Upload

Plugin

  • Big Upload

Copyright

  • 2015

Author

  • Matthieu Marcillaud

Licence

  • GNU/GPL

Source

Proposer une amélioration

Liste des fonctions

balise_BIGUP_TOKEN()

Compile la balise #BIGUP_TOKEN qui calcule un token autorisant l'envoi de fichiers par morceaux

À utiliser à l'intérieur d'un formulaire CVT ou dans un fichier de saisies. Dans une utilisation dans 'saisies/', il faut transmettre form et formulaire_args du formulaire pour le calcul.

Le token généré se base sur la valeur de l'attribut name de l'input que l'on peut recevoir soit :

  • en écriture html : fichiers[images]
  • en écriture comprise par Saisies : fichiers/images

Si l'input est voué à recevoir plusieurs fichiers (attribut multiple et name avec [] tel que fichiers[images][] il faut aussi l'indiquer, soit:

  • en écriture html : fichiers[images][]
  • en écriture Saisies : fichiers/images/

Par habitude d'usage avec le plugin Saisies, on accepte aussi une forme plus habituelle en transmettant un paramètre multiple (en 2è paramètre de la balise, valant par défaut #ENV{multiple}) indiquant que le token concerne un input recevant plusieurs fichiers. On l'écrit :

  • en écriture html : fichiers[images]
  • en écriture Saisies : fichiers/images

La balise accepte 4 paramètres, tous automatiquement récupérés dans l'environnement s'ils ne sont pas renseignés :

  • nom : la valeur de l'attribut name. Défaut #ENV{nom}
  • form : le nom du formulaire. Défaut #ENV{form}
  • formulaire_args : hash des arguments du formulaire. Défaut #ENV{formulaire_args}
  • multiple : indication d'un champ multiple, si valeur 'oui' ou 'multiple'. Défaut #ENV{multiple}
\Champ balise_BIGUP_TOKEN( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

    • #BIGUP_TOKEN utilisera #ENV{nom} en nom de champ par défaut
    • #BIGUP_TOKEN{#ENV{nom}, #ENV{multiple}, #ENV{form}, #ENV{formulaire_args}} : valeurs par défaut.
    • #BIGUP_TOKEN{file} : champ unique
    • #BIGUP_TOKEN{file\[\]} : champ multiple
    • #BIGUP_TOKEN{file/} : champ multiple
    • #BIGUP_TOKEN{file, multiple} : champ multiple

    • Le token sera calculé dans la saisie bigup : [(#SAISIE{bigup, file, form, formulaire_args, label=Fichier, ... })]
    • Le token est calculé dans l'appel : [(#SAISIE{bigup, file, token=#BIGUP_TOKEN{file}, label=Fichier, ... })]

Voir également

Utilise

Package

Syntaxe

  • #BIGUP_TOKEN{name, multiple, form, formulaire_args}

Note

  • La signature complète est #BIGUP_TOKEN{champ, multiple, form, formulaire_args} 
    La balise nécessite de connaître le nom du formulaire
(par défaut `#ENV{form}` ainsi que le hash de ses arguments
(par défaut `#ENV{formulaire_args}`.

Si cette balise est utilisée dans une inclusion (tel que `#INCLURE` ou `#SAISIE`),
il faut penser à transmettre à l'inclure `form` et `formulaire_args`.
La balise `#SAISIE_FICHIER` s'en occupe.

Balise

  • BIGUP_TOKEN

Source

Proposer une amélioration
bigup_get_mime_type_extension()

Transforme une extension en mime-type (de façon simpliste)
string bigup_get_mime_type_extension( string $extension )

Paramètres

  1. string $extension

Retour

  • string

    mime type

Package

Source

Proposer une amélioration
bigup_lister_fichiers()

Retrouve les fichiers correspondant à un name d'input donné, s'il y en a.
array bigup_lister_fichiers( array $fichiers , string $nom , string $multiple )

Paramètres

  1. array $fichiers
  2. string $nom

    Name utilisé, tel que 'oiseaux/bleus' ou 'oiseaux[bleus]'

  3. string $multiple

    Si contenu, le champ est considéré multiple

Retour

  • array

Package

Source

Proposer une amélioration
bigup_name2nom()

Passer un name en un format de nom compris de saisies
  • toto => toto,
  • toto[truc] => toto/truc,
  • toto[truc][] => toto/truc/
  • toto/truc => toto/truc
string bigup_name2nom( string $name )

Paramètres

  1. string $name

Retour

  • string

Voir également

  • saisie_nom2name() : pour l'inverse.

Package

Source

Proposer une amélioration
bigup_nom2classe()

Passer un nom en une valeur compatible avec une classe css
  • toto => toto,
  • toto/truc => toto_truc,
  • toto[truc] => toto_truc
void bigup_nom2classe( string $nom )

Paramètres

  1. string $nom

    return string

Package

Source

Proposer une amélioration
bigup_nom2name()

Passer un nom en une valeur compatible avec un name de formulaire
  • toto => toto,
  • toto/truc => toto[truc],
  • toto[truc] => toto[truc]
void bigup_nom2name( string $nom )

Paramètres

  1. string $nom

    return string

Package

Source

Proposer une amélioration
calculer_balise_BIGUP_TOKEN()

Calcule un token en fonction de l'utilisateur, du champ, du formulaire…

Retourne un token de la forme champ:time:clé

string | false calculer_balise_BIGUP_TOKEN( string $champ , string | boolean $multiple , string $form , string $form_args )

Paramètres

  1. string $champ

    Nom du champ input du formulaire

  2. string | boolean $multiple

    Indique si le champ est multiple

  3. string $form

    Nom du formulaire

  4. string $form_args

    Hash du contexte ajax du formulaire

Retour

  • string | false

    String : Le token false : Erreur : un des arguments est vide.

Voir également

  • \Spip\Bigup\Flow::verifier_token()

Utilise

Utilisé par

Package

Source

Proposer une amélioration

Liste des erreurs

GravitéLigneDescription
Notice 86
  • Référence de @see introuvable dans balise_BIGUP_TOKEN : \saisies/bigup.html
Notice 129
  • Référence de @see introuvable dans calculer_balise_BIGUP_TOKEN : \Spip\Bigup\Flow::verifier_token()
Notice 230
  • Référence de @see introuvable dans bigup_name2nom : \saisie_nom2name()