Validateurs pour Zend_File_Transfer
Zend_File
Programmer's Reference Guide

Filtres pour Zend_File_Transfer

Zend_File_Transfer est fourni avec de multiples filtres qui peuvent être utilisés pour réaliser différentes tâches qui doivent être réalisées souvent sur les fichier. Notez que tout filtre est appliqué après la validation. De plus les filtres de fichiers se comportent légèrement différemment des autres filtres. Ils retourneront toujours le nom de fichier et non le contenu modifié (ce qui serait une mauvaise idée en travaillant avec un fichier d'1Go par exemple). Tous les filtres fournis avec Zend_File_Transfer peuvent être trouvés dans le composant Zend_Filter et sont nommés Zend_Filter_File_*. Les filtres suivants sont actuellement disponibles :

  • Decrypt : ce filtre peut décrypter un fichier.

  • Encrypt : ce filtre peut crypter un fichier.

  • LowerCase  : ce filtre peut mettre en minuscule le contenu d'un fichier texte.

  • Rename : ce filtre peut renommer les fichiers, changer leur localisation et même forcer l'écrasement de fichiers existants.

  • UpperCase  : ce filtre peut mettre en majuscule le contenu d'un fichier texte.

Utiliser les filtres avec Zend_File_Transfer

L'utilisation des filtres est assez simple. Il existe de multiples méthodes pour ajouter et manipuler les filtres.

  • addFilter($filter, $options = null, $files = null) : ajoute le filtre à la pile des filtres (optionnellement seul le(s) fichier(s) spécifié(s)). $filter peut être soit une instance d'un filtre réel, ou un nom court spécifiant le filtre (par exemple, "Rename").

  • addFilters(array $filters, $files = null) : ajoute les filtres à la pile des filtres. Chaque entrée peut être soit une paire type/options, ou un tableau avec la clé "filtre" spécifiant le filtre (tous les autres options seront considérées comme des options du filtre au moment de l'instanciation).

  • setFilters(array $filters, $files = null) : surcharge les filtres existants avec les filtres spécifiés. Les filtres doivent respecter la même syntaxe addFilters().

  • hasFilter($name) : indique si le filtre est enregistré.

  • getFilter($name) : retourne un filtre préalablement enregistré.

  • getFilters($files = null) : retourne les filtres enregistrés ; si $files est fourni, retourne les filtres pour ce fichier en particulier ou pour tous les fichiers.

  • removeFilter($name) : enlève le filtre préalablement enregistré.

  • clearFilters() : efface tous les filtres.

Example #1 Ajouter les filtres au fichier transféré

  1. $upload = new Zend_File_Transfer();
  2.  
  3. // Paramètre un dossier de destination
  4. $upload->addFilter('Rename', 'C:\image\uploads');
  5.  
  6. // Paramètre un nouveau dossier de destination
  7. // et surcharge pour les fichiers existants
  8. $upload->addFilter('Rename', array('target' => 'C:\picture\uploads', 'overwrite' => true));

Example #2 Limiter les filtres à des fichiers uniques

addFilter(), addFilters(), and setFilters() accepte chacun un argument final $files. Cet argument peut être utilisé pour spécifier un fichier en particulier ou un tableau de fichiers sur lequel appliqué le filtre donné.

  1. $upload = new Zend_File_Transfer();
  2.  
  3. // Paramètre un nouveau dossier de destination et
  4. // le limite seulement à "file2"
  5. $upload->addFilter('Rename', 'C:\image\uploads', 'file2');

Généralement vous devriez simplement utiliser la méthode addFilters(), qui peut être appelée plusieurs fois.

Example #3 Ajouter des filtres multiples

Souvent il est plus simple d'appeler plusieurs fois addFilter() : un appel pour chaque filtre. Ceci améliore aussi la lisibilité et rend votre code plus maintenable. Comme toutes les méthodes fournissent un interface fluide, vous pouvez enchaîner les appels comme montré ci-dessous :

  1. $upload = new Zend_File_Transfer();
  2.  
  3. // Renommer différemment chacun des fichiers
  4. $upload->addFilter('Rename', 'file1', 'C:\picture\newjpg')
  5.        ->addFilter('Rename', 'file2', 'C:\picture\newgif');

Note: Notez que même si l'ajout du même filtre plusieurs fois est autorisé, faire ceci peut entraîner des problèmes si vous utilisez différentes options pour le même filtre.

Filtre Decrypt

Le filtre Decrypt permet de décrypter un fichier crypté.

Ce filtre se sert de Zend_Filter_Decrypt. Il supporte les extensions PHP Mcrypt et OpenSSL. Reportez vous à la section associée pour voir les détails des possibilités d'options pour le décryptage et connaître les options supportées.

Ce filtre supporte une option additionnelle qui peut être utilisée pour sauvegarder le fichier décrypté avec un autre nom de fichier. Spécifiez l'option filename pour changer le nom de fichier dans lequel le fichier décrypté sera stocké. Si vous supprimez cette option le fichier décrypté écrasera le fichier chiffré original.

Example #4 Utiliser le filtre Decrypt avec Mcrypt

  1. $upload = new Zend_File_Transfer_Adapter_Http();
  2.  
  3. // Adds a filter to decrypt the uploaded encrypted file
  4. // with mcrypt and the key mykey
  5. $upload->addFilter('Decrypt',
  6.     array('adapter' => 'mcrypt', 'key' => 'mykey'));

Example #5 Utiliser le filtre Decrypt avec OpenSSL

  1. $upload = new Zend_File_Transfer_Adapter_Http();
  2.  
  3. // Adds a filter to decrypt the uploaded encrypted file
  4. // with openssl and the provided keys
  5. $upload->addFilter('Decrypt',
  6.     array('adapter' => 'openssl',
  7.           'private' => '/path/to/privatekey.pem',
  8.           'envelope' => '/path/to/envelopekey.pem'));

Filtre Encrypt

Le filtre Encrypt permet de crypter un fichier.

Ce filtre se sert de Zend_Filter_Encrypt. Il supporte les extensions PHP Mcrypt et OpenSSL. Reportez vous à la section associée pour voir les détails des possibilités d'options pour le chiffrement et connaître les options supportées.

Ce filtre supporte une option additionnelle qui peut être utilisée pour sauvegarder le fichier chiffré avec un autre nom de fichier. Spécifiez l'option filename pour changer le nom de fichier dans lequel le fichier chiffré sera stocké. Si vous supprimez cette option le fichier chiffré écrasera le fichier original.

Example #6 Utiliser le filtre Encrypt avec Mcrypt

  1. $upload = new Zend_File_Transfer_Adapter_Http();
  2.  
  3. // Adds a filter to encrypt the uploaded file
  4. // with mcrypt and the key mykey
  5. $upload->addFilter('Encrypt',
  6.     array('adapter' => 'mcrypt', 'key' => 'mykey'));

Example #7 Utiliser le filtre Encrypt avec OpenSSL

  1. $upload = new Zend_File_Transfer_Adapter_Http();
  2.  
  3. // Adds a filter to encrypt the uploaded file
  4. // with openssl and the provided keys
  5. $upload->addFilter('Encrypt',
  6.     array('adapter' => 'openssl',
  7.           'public' => '/path/to/publickey.pem'));

Filtre LowerCase

Le filtre LowerCase vous permet de mettre en minuscule le contenu d'un fichier. Vous devriez utiliser ce filtre seulement sur les fichiers texte.

Lors de l'initialisation vous pouvez fournir qui sera utilisée en tant qu'encodage. Ou vous pouvez utiliser la méthode setEncoding() pour le paramétrer plus tard.

Example #8 Utiliser le filtre LowerCase

  1. $upload = new Zend_File_Transfer_Adapter_Http();
  2. $upload->addValidator('MimeType', 'text');
  3.  
  4. // Ajoute un filtre pour mettre en minuscule les fichiers texte uploadés
  5. $upload->addFilter('LowerCase');
  6.  
  7. // Ajoute un filtre pour mettre en minuscule seulement le fichier uploadé "uploadfile1"
  8. $upload->addFilter('LowerCase', null, 'uploadfile1');
  9.  
  10. // Ajoute un filtre pour mettre en minuscule avec un encodage ISO-8859-1
  11. $upload->addFilter('LowerCase', 'ISO-8859-1');

Note: Notez que les options du filtre LowerCase sont optionnelles, vous devez fournir un NULL en second paramètre quand vous souhaitez limiter le filtre à un fichier unique.

Filtre Rename

Le filtre Rename vous permet de changer le dossier de destination du fichier uploadé, de changer le nom de fichier et aussi d'écraser des fichiers existants. Il supporte les options suivantes :

  • source : le nom et le dossier de l'ancien fichier qui doit être renommé.

  • target : le nouveau dossier ou nom du fichier.

  • overwrite : paramètre si l'ancien fichier écrase le nouveau fichier s'il existe déjà. La valeur par défaut est FALSE.

De plus vous pouvez utiliser la méthode setFile() pour paramétrer des fichiers, ce qui effacera ceux précédemment paramétrés, addFile() pour ajouter un nouveau fichier à ceux déjà présent, et getFile() pour récupérer les fichiers actuellement paramétrés. Pour simplifier les choses, ce filtre accepte de multiples notations et ces méthodes et constructeur comprennent les mêmes notations.

Example #9 Utiliser le filtre Rename

  1. $upload = new Zend_File_Transfer_Adapter_Http();
  2.  
  3. // Paramètre un nouveau dossier pour tous les fichiers
  4. $upload->addFilter('Rename', 'C:\mypics\new');
  5.  
  6. // Paramètre un nouveau dossier seulement pour uploadfile1
  7. $upload->addFilter('Rename', 'C:\mypics\newgifs', 'uploadfile1');

Vous pouvez utiliser différentes notations. Ci-dessous vous trouverez une table fournissant la description et le but des notations supportées. Notez que quand vous utilisez l'"Adapter" ou le "Form Element", vous ne pourrez pas utiliser toutes les notations décrites.

Notations différentes du filtre "Rename" et leurs significations
notation description
addFile('C:\uploads') Spécifie un nouveau dossier pour tous les fichiers quand la chaîne est un dossier. Notez que vous aurez une exception si le fichier existe déjà, voir le paramètre d'écrasement.
addFile('C:\uploads\file.ext') Spécifie un nouveau dossier et un nom de fichier pour tous les fichiers quand la chaîne n'est pas un dossier. Notez que vous aurez une exception si le fichier existe déjà, voir le paramètre d'écrasement.
addFile('C:\uploads\file.ext', 'overwrite' => true) Spécifie un nouveau dossier et un nom de fichier pour tous les fichiers quand la chaîne n'est pas un dossier et écrase le fichier existant si celui-ci existe. Notez que vous aurez pas de notification en cas d'écrasement.
addFile(array('source' => 'C:\temp\uploads', 'target' => 'C:\uploads')) Spécifie un nouveau dossier pour tous les fichiers qui sont présent dans l'ancien dossier quand la chaîne est un dossier. Notez que vous aurez une exception si le fichier existe déjà, voir le paramètre d'écrasement.
addFile(array('source' => 'C:\temp\uploads', 'target' => 'C:\uploads', 'overwrite' => true)) Spécifie un nouveau dossier pour tous les fichiers qui sont présent dans l'ancien dossier quand la chaîne est un dossier. Notez que vous aurez pas de notification en cas d'écrasement.

Filtre UpperCase

Le filtre UpperCase vous permet de mettre en minuscule le contenu d'un fichier. Vous devriez utiliser ce filtre seulement sur les fichiers texte.

Lors de l'initialisation vous pouvez fournir qui sera utilisée en tant qu'encodage. Ou vous pouvez utiliser la méthode setEncoding() pour le paramétrer plus tard.

Example #10 Utiliser le filtre UpperCase

  1. $upload = new Zend_File_Transfer_Adapter_Http();
  2. $upload->addValidator('MimeType', 'text');
  3.  
  4. // Ajoute un filtre pour mettre en majuscule les fichiers textes uploadés
  5. $upload->addFilter('UpperCase');
  6.  
  7. // Ajoute un filtre pour mettre en majuscule seulement le fichier uploadé "uploadfile1"
  8. $upload->addFilter('UpperCase', null, 'uploadfile1');
  9.  
  10. // Ajoute un filtre pour mettre en majuscule avec un encodage ISO-8859-1
  11. $upload->addFilter('UpperCase', 'ISO-8859-1');

Note: Notez que les options du filtre UpperCase sont optionnelles, vous devez fournir un NULL en second paramètre quand vous souhaitez limiter le filtre à un fichier unique.

Validateurs pour Zend_File_Transfer
Zend_File
Programmer's Reference Guide