-= Aide du module "FILEUPLOAD" =-

Nom du module : FileUpload
Version : 1.0
License : GNU/GPL
Compatibilité : client et serveur : Scol 4.0 et sup., éditeur : 4.6 et sup

Auteur : iri
Website : http://www.irizone.net
Date : juillet 2007


_____________________________________


Ce module permet à un client enregistré d'uploader des fichiers sur le serveur Scol.
Il est à placer dans le sous-dossier "dms/fileutilities" de l'arborescence du serveur Scol.


Edition :

- Dossier de stockage : indique dans quel dossier seront stockés les fichiers uploadés.

- Extensions acceptées : indique les extensions acceptées (les entrer une par une ..., 
avec le ".", par exemple .jpg)
Note : le module ne vérifiera pas la validité du format, uniquement l'identité de l'extension.

- Taille maximale d'un fichier (ko) : indique la taille maximale d'un fichier uploadable.
Pour le transfert, le fichier sera compressé (sans perte).

Note : les fichiers à uploader doivent se trouver dans une partition Scol ouverte en lecture.
Dans le cas d'un site DMS, il s'agit par défaut du Cache du client. Dans le cas où un fichier
se situerait en dehors, la demande de transfert serait ignorée.


Liens :

Le module se trouve dans le dossier "fileutilities" de l'arbre de création du SCS.

- Actions disponibles :

* module.event -> fileupload.start : démarre le module chez un client
* module.event -> fileupload.register : enregistre le client auprès du serveur (l'autorise à uploader)
* module.event -> fileupload.unregister : désenregistre le client auprès du serveur (n'est plus 
autorisé à uploader)
* module.event -> fileupload.getfolder : retourne en paramètre le chemin du dossier contenant les 
fichiers uploadés
* module.event -> fileupload.setfolder : change le chemin du dossier contenant les fichiers uploadés
(ce chemin est passé en paramètre du lien)
* module.event -> fileupload.getextension : retourne en paramètre la liste des extensions acceptées
* module.event -> fileupload.setextension : change la liste des extensions acceptées (format
strbuild dans le paramètre du lien)
* module.event -> fileupload.getsize : retourne en paramètre la taille maximale d'un fichier uploadable
* module.event -> fileupload.setsize : change la taille maximale d'un fichier uploadable
* module.event -> fileupload.upfile : upload un fichier dont le chemin est passé en paramètre
* module.event -> fileupload.choiceFile : ouvre une boite de dialogue de choix de fichier et uploade
le fichier sélectionné.

- Evénements disponibles :

* fileupload.succeed -> module.event : le serveur indique au client que le transfert a réussi.
Le chemin du fichier uploadé sur le serveur est passé en paramètre
* fileupload.notvalide -> module.event : le serveur indique au client que le transfert a échoué.
Le nom court du fichier est passé en paramètre
* fileupload.upfileok -> module.event : indique que le fichier à uploader est valide et que le transfert
commence
* fileupload.upfilefailed -> module.event : indique que le fichier à uploader n'est pas valide et que 
le transfert est annulé


Zones :

Aucune zone n'est associée à ce module