Zend Framework 1.8
Zend Framework Migration Notes
Programmer's Reference Guide

Zend Framework 1.7

Lors de la migration d'un version précédente vers Zend Framework 1.7 ou plus récent vous devriez prendre note de ce qui suit.

Zend_Controller

Changement dans l'interface Dispatcher

Les utilisateurs ont portés l'attention sur le fait que Zend_Controller_Action_Helper_ViewRenderer utilisait une méthode de la classe abstraite du distributeur standard qui n'était pas présente dans l'interface Dispatcher.La méthode suivante a donc été ajoutée pour s'assurer que les distributeurs personnalisés continueront à fonctionner avec les implémentations embarquées :

  • formatModuleName() : devrait être utilisé pour prendre un nom de contrôleur brut, comme un qui aurait été embarqué dans un objet requête, et pour le formater en un nom de classe approprié qu'une classe étendant Zend_Controller_Action pourra utiliser.

Zend_File_Transfer

Changements quand vous utilisez des filtres ou des validateurs

Certaines remarques des utilisateurs indiquaient que les validateurs de Zend_File_Transfer ne fonctionnaient pas correctement avec Zend_Config dû au fait qu'ils n'utilisait pas de tableaux nommés.

De plus, tous les filtres et validateurs de Zend_File_Transfer ont été réécrits. Même si les anciennes signatures continuent à fonctionner, elles ont été marqués comme dépréciées et émettent une notice PHP vous informant de faire le changement.

La liste suivante vous montre les changements à réaliser pour une utilisation appropriée des paramètres.

Filtre Rename

  • Ancienne API : Zend_Filter_File_Rename($oldfile, $newfile, $overwrite)

  • Nouvelle API : Zend_Filter_File_Rename($options) où $options accepte un tableau avec les clés suivantes : source est équivalent à $oldfile, target est équivalent à $newfile, overwrite est équivalent à $overwrite.

Example #1 Changer le filtre rename entre 1.6 et 1.7

  1. // Exemple pour 1.6
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addFilter('Rename',
  4.                    array('/path/to/oldfile', '/path/to/newfile', true));
  5.  
  6. // Même exemple pour 1.7
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addFilter('Rename',
  9.                    array('source' => '/path/to/oldfile',
  10.                          'target' => '/path/to/newfile',
  11.                          'overwrite' => true));

Validateur Count

  • Ancienne API : Zend_Validate_File_Count($min, $max)

  • Nouvelle API : Zend_Validate_File_Count($options) où $options accepte un tableau avec les clés suivantes : min est équivalent à $min, max est équivalent à $max.

Example #2 Changer le validateur count entre 1.6 et 1.7

  1. // Exemple pour 1.6
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('Count',
  4.                       array(2, 3));
  5.  
  6. // Même exemple pour 1.7
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('Count',
  9.                       false,
  10.                       array('min' => 2,
  11.                             'max' => 3));

Validateur Extension

  • Ancienne API : Zend_Validate_File_Extension($extension, $case)

  • Nouvelle API : Zend_Validate_File_Extension($options) où $options accepte un tableau avec les clés suivantes : * est équivalent à $extension et peut avoir tout autre clé, case est équivalent à $case.

Example #3 Changer le validateur extension entre 1.6 et 1.7

  1. // Exemple pour 1.6
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('Extension',
  4.                    array('jpg,gif,bmp', true));
  5.  
  6. // Même exemple pour 1.7
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('Extension',
  9.                       false,
  10.                       array('extension1' => 'jpg,gif,bmp',
  11.                             'case' => true));

Validateur FilesSize

  • Ancienne API : Zend_Validate_File_FilesSize($min, $max, $bytestring)

  • Nouvelle API : Zend_Validate_File_FilesSize($options) où $options accepte un tableau avec les clés suivantes : min est équivalent à $min, max est équivalent à $max, bytestring est équivalent à $bytestring.

De plus la signature de la méthode useByteString() a changé. Elle peut être seulement utilisée pour tester si le validateur prévoie d'utiliser les chaînes lisibles ou la valeur brute dans les messages générées. Pour paramétrer la valeur de cette option, utilisez la méthode setUseByteString().

Example #4 Changer le validateur filessize entre 1.6 et 1.7

  1. // Exemple pour 1.6
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('FilesSize',
  4.                       array(100, 10000, true));
  5.  
  6. // Même exemple pour 1.7
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('FilesSize',
  9.                       false,
  10.                       array('min' => 100,
  11.                             'max' => 10000,
  12.                             'bytestring' => true));
  13.  
  14. // Exemple pour 1.6
  15. $upload->useByteString(true); // set flag
  16.  
  17. // Même exemple pour 1.7
  18. $upload->setUseByteSting(true); // set flag

Validateur Hash

  • Ancienne API : Zend_Validate_File_Hash($hash, $algorithm)

  • Nouvelle API : Zend_Validate_File_Hash($options) où $options accepte un tableau avec les clés suivantes : * est équivalent à $hash et peut avoir tout autre clé, algorithm est équivalent à $algorithm.

Example #5 Changer le validateur hash entre 1.6 et 1.7

  1. // Exemple pour 1.6
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('Hash',
  4.                       array('12345', 'md5'));
  5.  
  6. // Même exemple pour 1.7
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('Hash',
  9.                       false,
  10.                       array('hash1' => '12345',
  11.                             'algorithm' => 'md5'));

Validateur ImageSize

  • Ancienne API : Zend_Validate_File_ImageSize($minwidth, $minheight, $maxwidth, $maxheight)

  • Nouvelle API : Zend_Validate_File_FilesSize($options) où $options accepte un tableau avec les clés suivantes : minwidth est équivalent à $minwidth, maxwidth est équivalent à $maxwidth, minheight est équivalent à $minheight, maxheight est équivalent à $maxheight.

Example #6 Changer le validateur imagesize entre 1.6 et 1.7

  1. // Exemple pour 1.6
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('ImageSize',
  4.                       array(10, 10, 100, 100));
  5.  
  6. // Même exemple pour 1.7
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('ImageSize',
  9.                       false,
  10.                       array('minwidth' => 10,
  11.                             'minheight' => 10,
  12.                             'maxwidth' => 100,
  13.                             'maxheight' => 100));

Validateur Size

  • Ancienne API : Zend_Validate_File_Size($min, $max, $bytestring)

  • Nouvelle API : Zend_Validate_File_Size($options) où $options accepte un tableau avec les clés suivantes : min est équivalent à $min, max est équivalent à $max, bytestring est équivalent à $bytestring

Example #7 Changer le validateur size entre 1.6 et 1.7

  1. // Exemple pour 1.6
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('Size',
  4.                       array(100, 10000, true));
  5.  
  6. // Même exemple pour 1.7
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('Size',
  9.                       false,
  10.                       array('min' => 100,
  11.                             'max' => 10000,
  12.                             'bytestring' => true));

Zend_Locale

Changement dans l'utilisation de isLocale()

Conformément aux standards de codage isLocale() a été changé pour retourner un booléen. Dans les versions précédentes une chaîne était retournée lors du succès. Pour la version 1.7 un mode de compatibilité a été ajouté qui vous permet d'utiliser l'ancien comportement (avec une chaîne retournée), mais ceci émet un warning pour vous informer de changer vers le nouveau comportement. Le reroutage que l'ancien comportement de isLocale() pouvait avoir à faire n'est plus nécessaire car tous les composants de l'I18N traiteront maintenant eux-mêmes le reroutage.

Pour migrer vos scripts vers la nouvelle API, utilisez simplement la méthode décrite ci-dessous.

Example #8 Comment changer l'appel de isLocale() de 1.6 vers 1.7 ?

  1. // Exemple pour ZF 1.6
  2. if ($locale = Zend_Locale::isLocale($locale)) {
  3.     // faire qqch
  4. }
  5.  
  6. // Même exemple pour ZF 1.7
  7.  
  8. // Vous devez changer le mode de compatibilité pour empêcher l'émission de warning
  9. // Mais ceci peut être fait dans votre bootstrap
  10. Zend_Locale::$compatibilityMode = false;
  11.  
  12. if (Zend_Locale::isLocale($locale)) {
  13. }

Notez que vous pouvez utiliser le second paramètre pour voir si la locale est correcte sans nécessiter de reroutage.

  1. // Exemple pour ZF 1.6
  2. if ($locale = Zend_Locale::isLocale($locale, false)) {
  3.     // do something
  4. }
  5.  
  6. // Même exemple pour ZF 1.7
  7.  
  8. // Vous devez changer le mode de compatibilité pour empêcher l'émission de warning
  9. // Mais ceci peut être fait dans votre bootstrap
  10. Zend_Locale::$compatibilityMode = false;
  11.  
  12. if (Zend_Locale::isLocale($locale, false)) {
  13.     if (Zend_Locale::isLocale($locale, true)) {
  14.         // pas de locale du tout
  15.     }
  16.  
  17.     // original string is no locale but can be rerouted
  18. }

Changement dans l'utilisation de getDefault()

La signification de la méthode getDefault() a été changé étant donné que nous avons intégré une locale de framework qui peut être paramétrée avec setDefault(). Ceci ne renvoie plus la chaîne de la locale mais seulement la locale du framework.

Pour migrer vos scripts vers la nouvelle API, utilisez simplement la méthode décrite ci-dessous.

Example #9 Comment changer l'appel de getDefaut() de 1.6 vers 1.7 ?

  1. // Exemple pour ZF 1.6
  2. $locales = $locale->getDefault(Zend_Locale::BROWSER);
  3.  
  4. // Même exemple pour ZF 1.7
  5.  
  6. // Vous devez changer le mode de compatibilité pour empêcher l'émission de warning
  7. // Mais ceci peut être fait dans votre bootstrap
  8. Zend_Locale::$compatibilityMode = false;
  9.  
  10. $locale = Zend_Locale::getOrder(Zend_Locale::BROWSER);

Notez que le second paramètre de l'ancienne implémentation de getDefault() n'est plus disponible non plus, mais les valeurs retournées sont les mêmes.

Note: Par défaut l'ancien comportement est toujours actif, mais émet un warning. Quand vous avez changé votre code vers le nouveau comportement, vous devriez aussi changer le mode de compatibilité à FALSE ainsi aucun nouveau warning ne sera émis.

Zend_Translate

Paramétrer les langues

Lors de l'utilisation de la détection automatique des langues, ou du réglage manuel des langues de Zend_Translate, vous avez peut-être remarqué que de temps en temps une notice est envoyée concernant le non-ajout de traductions vides. Dans certaines versions précédentes, une exception était levée dans certains cas.

Ceci intervient quand un utilisateur requête une langue non existante, vous n'avez alors aucun moyen simple de détecter ce qui ne va pas. Nous avons donc ajouté ces notices qui apparaîtront dans votre historisation et qui vous diront qu'un utilisateur a requêté une langue que vous ne supportez pas. Notez bien que votre code, même si une notice est déclenchée, fonctionnera sans problèmes.

Mais quand vous utilisez votre propre gestionnaire d'erreur ou d'exception, comme xDebug, toutes les notices vous seront retournées, même si ce n'est pas votre intention initiale. Ceci est du au fait, que ces gestionnaires surchargent tous les réglages internes de PHP.

Pour vous affranchir de ces notices, vous pouvez simplement paramétrer la nouvelle option disableNotices à TRUE, sa valeur par défaut étant FALSE.

Example #10 Paramétrer les langues sans avoir de notices

Assumons que "fr" soit disponible et qu'un utilisateur requête pour "de" qui ne fait pas partie de votre portefeuille de traductions.

  1. $language = new Zend_Translate('gettext',
  2.                                '/chemin/vers/les/traductions',
  3.                                'auto');

Dans ce cas nous aurons une notice indiquant la non-disponibilité de la langue "de". Ajoutez simplement l'option et les notices seront désactivées.

  1. $language = new Zend_Translate('gettext',
  2.                                '/chemin/vers/les/traductions',
  3.                                'auto',
  4.                                array('disableNotices' => true));

Zend_View

Note: Les changements de l'API de Zend_View sont seulement notables pour vous si vous mettez à jour vers les version 1.7.5 ou plus récent.

Avant la version 1.7.5, l'équipe de Zend Framework a été avertie d'une faille potentielle d'inclusion de fichier local ("Local File Inclusion" (LFI)) dans la méthode Zend_View::render(). Avant 1.7.5, la méthode acceptait par défaut la possibilité de spécifier des scripts de vue comportant des indications de dossier parent (comme, "../" ou "..\"). Ceci ouvre la possibilité à une attaque LFI si des données utilisateurs non filtrées sont passées directement à la méthode render():

  1. // Ici, $_GET['foobar'] = '../../../../etc/passwd'
  2. echo $view->render($_GET['foobar']); // inclusion LFI

Zend_View émet maintenant une exception dans un tel cas.

Désactiver la protection LFI de render()

Comme des développeurs utilisaient de telles notations, mais qui n'étaient pas des données en provenance de l'extérieur, un drapeau spécial a été crée, il permet de désactiver la protection. Pour manipuler ce drapeau, il existe 2 moyens : le paramètre 'lfiProtectionOn' du constructeur de votre vue, ou encore la méthode setLfiProtection().

  1. // Désactivation de la protection par le constructeur
  2. $view = new Zend_View(array('lfiProtectionOn' => false));
  3.  
  4. // Désactivation de la protection par la méthode dédiée
  5. $view = new Zend_View();
  6. $view->setLfiProtection(false);
Zend Framework 1.8
Zend Framework Migration Notes
Programmer's Reference Guide