Pxxo_Widget_FilePreview

Ce widget permet de pré-visualiser et/ou télécharger un fichier. La pré-visualisation du fichier est disponible en fonction du type de document (uniquement les images actuellement). Au besoin, le widget peut proposer le téléchargement du fichier du serveur vers le poste du client.

Remarque : Ce widget est utilisé par le Widget Input_File

Paramètres

Nom Type Valeur par défaut Description
file String - Le chemin physique complet du fichier à pré-visualiser et/ou télécharger
meta Array array() Les éventuelles méta-données associées au fichier (cf explications plus bas)
thumbnail_size Array array(120,120) Un tableau contenant la largeur et la hauteur maximum de l'aperçu du fichier en pixels.
force_binary_download boolean true Permet de forcer ou non la visualisation dans le navigateur du fichier téléchargé.
display_name boolean true Permet d'afficher ou de cacher le nom du fichier
display_meta boolean true Permet d'afficher ou de cacher les méta-données du fichier
display_thumbnail boolean true Affiche ou non la pré-visualisation de l'image
display_icon boolean true Permet d'afficher ou de cacher la petite icone symbolisant le mime-type du fichier
clickable boolean true Permet de rendre clickable ou non la pré-visualisation

La structure du paramètre meta est la suivante. C'est un tableau ayant pour clés :

  • name : le nom du fichier tel qu'il doit s'afficher et tel qu'il sera téléchargé
  • type : le mime-type du fichier
  • size : la taille en octets du fichier (si rien n'est indiqué, elle sera calculée automatiquement)

Dans le cas où le paramètre meta n'est pas renseigné, le widget essayera de récupérer les meta données depuis le contenu d'un éventuel fichier ayant comme chemin le même que celui indiqué dans le paramètre file suffixé par la chaîne de caractères ”.meta”. Par exemple si le chemin indiqué dans file est /tmp/monimage.jpg alors le programme va essayer de rechercher un fichier /tmp/monimage.jpg.meta pour en extraire les valeurs de name, type et size (valeurs attendus par le paramètre meta).

Exemple de fichier de méta données (syntaxe similaire au fichiers .ini):

name = Mon image d'athlète
type = image/jpeg
size = 56930

Si ce fichier de méta données n'existe pas alors le widget tentera de se débrouiller lui même par divers mécanismes pour deviner le type-mime du fichier.

Exemple

Exemple ultra simple où les méta données du fichier seront calculées automatiquement :

require_once "Pxxo/Widget/FilePreview.php";
 
$params = array();
$params['file'] = 'C:/Athlete.png';
$o = new Pxxo_Widget_FilePreview($params);
$o->addDecorator('Pxxo_Widget_Decorator_Core');
$o->main();
$o->dump();

Ici on indique les méta données associées au fichier et une taille max (largeur, hauteur) de 40 pixels pour le thumbnail (120px par défaut) :

require_once "Pxxo/Widget/FilePreview.php";
 
$params = array();
$params['file'] = 'C:/Athlete.png';
$params['meta'] = array('name' => 'Athlete.png',
                        'type' => 'image/png',
                        'size' => 17848,
                       );
$params['thumbnail_size'] = array(40,40);
 
 
$o = new Pxxo_Widget_FilePreview($params);
$o->addDecorator('Pxxo_Widget_Decorator_Core');
$o->main();
$o->dump();
fr/doc/pxxo_widget_filepreview.txt · Dernière modification: 2009/06/19 09:19 (édition externe)
 
 

©2003-2010 Pxxo

Partenaires : INIST-CNRS | Sourcesup | Web2.0 chat server | Micropolia | Jeux gratuits | Areno