4.2.11 Type file
4.2.11.1 Description
Les attributs de type file permettent d'insérer un fichier.
4.2.11.2 Représentation
-
consultation :
Un lien permettant de télécharger le fichier
-
modification :
Un
input
de typetext
présentant le nom du fichier, suivi de 3 boutons :- pour choisir un nouveau fichier,
- restaurer le fichier préalablement enregistré,
- effacer le fichier.
S'il s'agit d'une modification de document et que le fichier est déjà enregistré alors le clic sur le nom du fichier permet de le télécharger.
Des différences de comportement sont présentes en fonction des navigateur. Sur IE < 11, le bouton original "Parcourir" est affiché lorsqu'on clique sur le bouton "...". Le paramètre applicatif "FDL_OLDFILEINPUTCOMPAT" indique si l'attribut doit présenter, de manière systématique, le bouton original "Parcourir"
-
odt :
Le titre du fichier
4.2.11.3 Comportement
Lors de l'enregistrement du document, le fichier est stocké dans le vault.
4.2.11.4 Format de stockage
La valeur stockée est l'identifiant vault du fichier
(sous la forme <type-mime>|<vaultid>|<file-name>
).
Le type utilisé en base de donnée est text
.
4.2.11.5 Options
En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :
- hideindav
-
Indique si le fichier apparaît lors de l'accès au moyen du protocole webdav.
Les valeurs possibles sont :
yes
(comportement par défaut)no
- inline
-
Si le paramètre est
yes
, il indique que le fichier doit être consulté directement dans le navigateur. Seuls les types de fichiers supportés par le navigateur peuvent être affichés directement.
Si le paramètre estno
, le téléchargement est proposé par le navigateur. Le nom du fichier proposé au téléchargement est celui du fichier enregistré. Si le nom du fichier comporte des double-quotes"
, ils sont remplacés par des tirets-
.Les valeurs possibles sont :
yes
no
(comportement par défaut)
- pdffile
-
Utilisé conjointement avec l'option viewfiletype, indique l'attribut contenant le fichier pdf à afficher.
Les valeurs possibles sont :
- tout id d'attribut de la famille en cours.
- preventfilechange
-
Ajoute une contrainte pour que le fichier à remplacer provienne de la dernière version du serveur.
Cela ne bloque pas un changement de fichier mais avertit l'utilisateur dans le cas où le fichier ne correspond pas à cette dernière version.
Lors du téléchargement du fichier un code identifiant la version est ajouté dans le nom du fichier (exemple foo{i47307-56}.ods pour le fichier foo.ods). Lorsque l'utilisateur envoie à nouveau le fichier, le serveur vérifie ce numéro de version. Si le numéro correspond à la dernière version, alors le fichier est accepté. Dans le cas contraire, une confirmation est demandée à l'utilisateur.
Attention: si l'utilisateur renomme le fichier, la vérification échoue, et le serveur demande la confirmation.
Les valeurs possibles sont :
yes
no
(comportement par défaut)
- rn
-
Indique que le fichier sera renommé sur le serveur.
Les valeurs possibles sont :
- un nom de méthode de la famille courante (par exemple
::myNewName()
). La méthode prend en entrée le nom du fichier et doit retourner le nouveau nom sous la forme d'une chaîne de caractères.
Note: Il est recommandé que la méthode fournisse une extension compatible avec le type mime pour l'utilisation ultérieure sur le poste client et les transformations. Pour récupérer l'extension d'un nom de fichier vous pouvez utiliser la fonction
getFileExtension
de la librairieLib.FileMime.php
- un nom de méthode de la famille courante (par exemple
- search
-
Indique si l'attribut est indexé pour la recherche plein-texte.
Les valeurs possibles sont :
yes
(comportement par défaut)no
- template
-
Indique si l'attribut file est un template.
se reporter à la documentation des templates OOO pour les explications
Les valeurs possibles sont :
static
dynamic
- viewfileheigth
-
Utilisé conjointement avec l'option viewfiletype, indique la hauteur du rendu affiché sur le navigateur.
Les valeurs possibles sont :
- Une taille en pixels (par exemple
150px
). - Une taille en pourcentage de la hauteur de la fenêtre (par exemple
80%
)
Il n'y a pas de valeur par défaut
- Une taille en pixels (par exemple
- viewfiletype
-
Indique qu'une prévisualisation du fichier sera disponible dans le navigateur, ne nécessitant donc pas de logiciel tiers.
Les valeurs possibles sont :
-
pdf
: Dans ce cas, l'attribut indiqué par l'option pdffile sera utilisé comme prévisualisation ; -
image
: Dans ce cas, le moteur de transformation génère une visualisation sous forme d'images avec tourne pages du pdf référencé par l'option pdffile.
-