 |
Guide de référence du programmeur
Zend_File
|
 |
|---|
|
Guide de référence du programmeur
Zend_File
|
|
|---|
Table des matières
Zend_File_TransferZend_File_Transfer permet aux développeurs de contrôler l'upload de fichiers mais aussi le
téléchargement. Il vous permet d'utiliser les validateurs incorporés pour le traitement de fichier et même la
possibilité de changer les fichiers avec des filtres. Zend_File_Transfer fonctionne avec des
adaptateurs ce qui vous permet d'utiliser la même API pour différents protocoles de transfert HTTP, FTP, WEBDAV et
plus encore.
![[Note]](images/note.png) |
Limitation |
|---|---|
L'implémentation actuelle de |
|
Formulaires |
|---|---|
Quand vous utilisez |
L'utilisation de Zend_File_Transfer est assez simple. Il consiste en deux parties. Le formulaire
HTTP qui réalise l'upload, et la gestion des fichiers uploadés avec Zend_File_Transfer. Regardez
l'exemple suivant :
Exemple 270. Formulaire simple d'upload de fichier
Cet exemple illustre un upload de fichier basique avec Zend_File_Transfer. La première partie
est le formulaire. Dans notre exemple, il n'y a qu'un seul fichier que nous souhaitons uploadé.
<form enctype="multipart/form-data" action="/file/upload" method="POST">
<input type="hidden" name="MAX_FILE_SIZE" value="100000" />
Choose a file to upload:
<input name="uploadedfile" type="file" />
<br />
<input type="submit" value="Upload File" />
</form>Notez que vous devriez utiliser Zend_Form_Element_File par simplicité plutôt que de créer le HTML manuellement.
L'étape suivante est de créer le récepteur de l'upload. Dans notre exemple le récepteur est
"/file/upload". Donc nous créons le contrôleur file avec l'action
upload.
$adapter = new Zend_File_Transfer_Adapter_Http();
$adapter->setDestination('C:\temp');
if (!$adapter->receive()) {
$messages = $adapter->getMessages();
echo implode("\n", $messages);
}Comme vous le voyez, l'utilisation la plus simple est de définir une destination avec la méthode
setDestination et d'appeler la méthode receive(). S'il apparaît des erreurs au cours
de l'upload, alors vous les récupérerez grâce à une exception qui sera retournée.
|
Attention |
|---|---|
Maintenez à l'esprit qu'il s'agit de l'utilisation la plus simple. Vous ne devez jamais utiliser cet exemple en environnement de production car il causerait de graves problèmes de sécurité. Vous devez toujours utiliser des validateurs pour accroître la sécurité. |
Zend_File_Transfer est construit pur supporter différents adaptateurs et différentes
directions. Il est conçu pour permettre l'upload, le téléchargement et même l'envoi bidirectionnel (upload avec
un adaptateur et télécharge avec un autre adaptateur en même temps) de fichiers. Cependant avec la version 1.6
du Zend Framework, il n'y a qu'un seul adaptateur disponible, l'adaptateur Http.
Puisqu'il n'y a qu'un seul adaptateur disponible pour le moment, la classe principale n'est pas prête à
l'utilisation. Si vous souhaitez utiliser Zend_File_Transfer, vous devez utiliser l'adaptateur
directement.
Zend_File_Transfer et ses adaptateurs supportent plusieurs options. Vous pouvez paramétrer
toutes les options soit en les fournissant au constructeur, ou en utilisant setOptions($options).
getOptions() retournera les options actuellement paramétrées. Ci-dessous, vous trouverez la liste
des options supportées :
ignoreNoFile : si cette option vaut true, tous les validateurs
ignoreront le fait que le fichier à été uploadé ou non par le formulaire. Cette option vaut par défaut
false, ce qui lance une erreur indiquant que le fichier n'a pas été fourni.
Zend_File_Transfer possède plusieurs méthodes qui permettent de vérifier suivant différentes
considérations. Ceci est particulièrement utile quand vous devez travailler avec des fichiers qui ont été
uploadés.
isValid($files = null) : cette méthode vérifie si le(s) fichier(s) est(sont)
valide(s), en se basant sur les validateurs affectés à chacun de ces fichiers. Si aucun fichier n'est
fourni, tous les fichiers seront vérifiés. Notez que cette méthode sera appelée en dernier quand les
fichiers seront reçus.
isUploaded($files = null) : cette méthode vérifie si le(s) fichier(s) fourni(s) a
(ont) été uploadé(s) par l'utilisateur. Ceci est utile si vous avez défini que certains fichiers sont
optionnels. Si aucun fichier n'est fourni, tous les fichiers seront vérifiés.
isReceived($files = null) : cette méthode vérifie si le(s) fichier(s) fourni(s) a
(ont) bien été reçu(s). Si aucun fichier n'est fourni, tous les fichiers seront vérifiés.
Exemple 271. Vérification de fichiers
$upload = new Zend_File_Transfer();
// Retourne toutes les informations connues sur le fichier
$files = $upload->getFileInfo();
foreach ($files as $file => $info) {
// Fichier uploadé ?
if (!$upload->isUploaded($file)) {
print "Pourquoi n'avez-vous pas uploadé ce fichier ?";
continue;
}
// Les validateurs sont-ils OK ?
if (!$upload->isValid($file)) {
print "Désolé mais $file ne correspond à ce que nous attendons";
continue;
}
}
$upload->receive();Zend_File_Transfer peut fournir de multiples informations complémentaires sur les fichiers.
Les méthodes suivantes sont disponibles :
getFileName($file = null, $path = true) : cette méthode retourne le vrai nom de
fichier d'un fichier transféré.
getFileInfo($file = null) : cette méthode retourne tous les informations internes
concernant un fichier transféré donné.
getHash($hash = 'crc32', $files = null) : cette méthode retourne la valeur de hachage
du contenu d'un fichier transféré donné.
getFileName() accepte le nom d'un élément entant que premier paramètre. Si aucun n'est
fourni, tous les fichiers connus seront retournées sous la forme d'un tableau. Si le fichier est un "multifile",
vous le récupérerez aussi sous la forme d'un tableau. S'il n'y a qu'un seul fichier alors une chaîne sera
retournée.
Par défaut les noms de fichier sont retournés avec leur chemin d'accès complet. Si vous souhaitez
seulement le nom de fichier sans le chemin, vous pouvez paramétrer le second paramètre $path à
false ce qui tronquera le chemin.
Exemple 272. Récupération du nom de fichier
$upload = new Zend_File_Transfer();
$upload->receive();
// Retourne le nom de fichier pour tous les fichiers
$names = $upload->getFileName();
// Retourne le nom de fichier de l'élément de formulaire "foo"
$names = $upload->getFileName('foo'); |
Note |
|---|---|
Notez que le nom de fichier peut changer quand vous recevez le fichier. Ceci est du au fait qu'après
la réception, tous les filtres sot appliqués. Donc vous ne devriez appeler |
getHash() accepte le nom de l'algorithme de hachage en tant que premier paramètre. Pour avoir
une liste des algorithmes connus, regardez la
méthode hash_algos de PHP. Si vous ne fournissez aucun algorithme, celui par défaut sera
crc32.
Exemple 273. Récupération d'un hash de fichier
$upload = new Zend_File_Transfer();
$upload->receive();
// Retourne le hachage de fichier pour tous les fichiers sous la forme
// d'un tableau si plusieurs fichiers sont fournis
$hash = $upload->getHash('md5');
// Retourne le hachage de l'élément de formulaire "foo"
$names = $upload->getHash('crc32', 'foo'); |
Note |
|---|---|
Notez que si un fichier ou un élément de formulaire donné contient plus d'un fichier, la valeur retournée sera un tableau. |
|
8. Classes personnalisées pour les flux et entrées |
|
2. Validateurs pour Zend_File_Transfer |