Voir la source de Upload de fichier

Cette fonctionnalités propose une interface de chargement pour un seul fichier, une page peut contenir plusieurs interfaces, les fichiers sont référencés par des ID uniques.

pour un interface de chargement de plusieurs fichiers, utiliser la fonctionnalité [[Upload de fichier multiple]]


{{Fonctionnalité|path=FileUploader|addon=[[LibFileManagement]]|version=0.0.2}}

== setFileUid ==

Définir l'ID unique du fichier. la méthode retourne un booléen.

<source lang="php">

 $instance->setFileUid($uid);

</source>


* $uid : la paramètre uid doit contenir que des caractère alpha-numériques /\w+/


== getFilePath ==

Obtenir le chemin complet vers le ficher ou FALSE si il n'y a pas de fichier chargé.

<source lang="php">

 $instance->getFilePath();

</source>


== setFile ==

Cette méthode permet d'écrire le fichier par le programme sans utiliser l'interface de chargement.

<source lang="php">

 $instance->setFile($fileObj);

</source>

* $fileObj : le paramètre est un objet '''bab_fileHandler''', c'est un objet présent dans le noyau d'ovidentia (ovidentia/utilit/uploadincl.php) qui permet de réaliser des transfert de fichier a partir de différentes méthodes de transfert (upload, déplacement, copie).


== getDownloadUrl ==

Cette méthode retourne l'url de téléchargement du fichier chargé ou FALSE si il n'y a pas de fichier chargé.

<source lang="php">

 $instance->getDownloadUrl();

</source>


== deleteFile ==

Supprimer le fichier chargé si il existe.

<source lang="php">

 $instance->deleteFile();

</source>


== getHtml ==

Obtenir le html nécéssaire pour présenter l'interface de chargement. Le formulaire d'upload retourné par cette méthode est contenu dans une iframe, l'intégration de ce html peut donc ce faire n'importe où.

La méthode retourne toujours une chaîne de caractère.

<source lang="php">

 $instance->getHtml();

</source>


== getIconFilePath ==

Obtenir l'icône ou la miniature du fichier chargé. la méthode renvoie false si il n'y a pas de fichier. L'image accessible par l'url retournée par cette méthode tiens toujours dans un carré de 32 pixel de coté.

<source lang="php">

 $instance->getIconFilePath();

</source>


== getWidget ==

Obtenir le html généré sour la forme d'un widget si le module widgets est installé