Zend_File_Transfer-Migration.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. <!-- EN-Revision: 12789 -->
  2. <sect1 id="zend.file.transfer.migration">
  3. <title>Migrer à partir des versions précédentes</title>
  4. <para>L'API de <classname>Zend_File_Transfer</classname> a changé au cours du temps. Si vous avez commencé à utiliser
  5. <classname>Zend_File_Transfer</classname> et ses sous-composants avec les versions précédentes, suivez les lignes directrices
  6. ci-dessous pour migrer vos scripts et ainsi utiliser la nouvelle API.</para>
  7. <sect2 id="zend.file.transfer.migration.fromonesixtooneseven">
  8. <title>Migrer de la version 1.6 vers 1.7 ou plus récent</title>
  9. <sect3 id="zend.file.transfer.migration.fromonesixtooneseven.validators">
  10. <title>Changements quand vous utilisez des filtres ou des validateurs</title>
  11. <para>Certaines remarques des utilisateurs indiquaient que les validateurs de
  12. <classname>Zend_File_Transfer</classname> ne fonctionnaient pas correctement avec <classname>Zend_Config</classname> dû au fait
  13. qu'ils n'utilisait pas de tableaux nommés.</para>
  14. <para>De plus, tous les filtres et validateurs de <classname>Zend_File_Transfer</classname> ont été réécrits. Même si
  15. les anciennes signatures continuent à fonctionner, elles ont été marqués comme dépréciées et émettent une
  16. notice PHP vous informant de faire le changement.</para>
  17. <para>La liste suivante vous montre les changements à réaliser pour une utilisation appropriée des
  18. paramètres.</para>
  19. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.rename">
  20. <title>Filtre <emphasis>Rename</emphasis></title>
  21. <itemizedlist>
  22. <listitem>
  23. <para>Ancienne API : <classname>Zend_Filter_File_Rename($oldfile, $newfile, $overwrite)</classname></para>
  24. </listitem>
  25. <listitem>
  26. <para>Nouvelle API : <classname>Zend_Filter_File_Rename($options)</classname> où <code>$options</code>
  27. accepte un tableau avec les clés suivantes : <emphasis>source</emphasis> est équivalent à
  28. <code>$oldfile</code>, <emphasis>target</emphasis> est équivalent à <code>$newfile</code>,
  29. <emphasis>overwrite</emphasis> est équivalent à <code>$overwrite.</code></para>
  30. </listitem>
  31. </itemizedlist>
  32. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.rename.example">
  33. <title>Changer le filtre rename entre 1.6 et 1.7</title>
  34. <programlisting role="php"><![CDATA[
  35. // Exemple pour 1.6
  36. $upload = new Zend_File_Transfer_Adapter_Http();
  37. $upload->addFilter('Rename',
  38. array('/path/to/oldfile', '/path/to/newfile', true));
  39. // Même exemple pour 1.7
  40. $upload = new Zend_File_Transfer_Adapter_Http();
  41. $upload->addFilter('Rename',
  42. array('source' => '/path/to/oldfile',
  43. 'target' => '/path/to/newfile',
  44. 'overwrite' => true));
  45. ]]></programlisting>
  46. </example>
  47. </sect4>
  48. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.count">
  49. <title>Validateur <emphasis>Count</emphasis></title>
  50. <itemizedlist>
  51. <listitem>
  52. <para>Ancienne API : <classname>Zend_Validate_File_Count($min, $max)</classname></para>
  53. </listitem>
  54. <listitem>
  55. <para>Nouvelle API : <classname>Zend_Validate_File_Count($options)</classname> où <code>$options</code>
  56. accepte un tableau avec les clés suivantes : <emphasis>min</emphasis> est équivalent à
  57. <code>$min</code>, <emphasis>max</emphasis> est équivalent à <code>$max</code>.</para>
  58. </listitem>
  59. </itemizedlist>
  60. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.count.example">
  61. <title>Changer le validateur count entre 1.6 et 1.7</title>
  62. <programlisting role="php"><![CDATA[
  63. // Exemple pour 1.6
  64. $upload = new Zend_File_Transfer_Adapter_Http();
  65. $upload->addValidator('Count',
  66. array(2, 3));
  67. // Même exemple pour 1.7
  68. $upload = new Zend_File_Transfer_Adapter_Http();
  69. $upload->addValidator('Count',
  70. false,
  71. array('min' => 2,
  72. 'max' => 3));
  73. ]]></programlisting>
  74. </example>
  75. </sect4>
  76. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.extension">
  77. <title>Validateur <emphasis>Extension</emphasis></title>
  78. <itemizedlist>
  79. <listitem>
  80. <para>Ancienne API : <classname>Zend_Validate_File_Extension($extension, $case)</classname></para>
  81. </listitem>
  82. <listitem>
  83. <para>Nouvelle API : <classname>Zend_Validate_File_Extension($options)</classname> où
  84. <code>$options</code> accepte un tableau avec les clés suivantes : <emphasis>*</emphasis> est
  85. équivalent à <code>$extension</code> et peut avoir tout autre clé, <emphasis>case</emphasis> est
  86. équivalent à <code>$case</code>.</para>
  87. </listitem>
  88. </itemizedlist>
  89. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.extension.example">
  90. <title>Changer le validateur extension entre 1.6 et 1.7</title>
  91. <programlisting role="php"><![CDATA[
  92. // Exemple pour 1.6
  93. $upload = new Zend_File_Transfer_Adapter_Http();
  94. $upload->addValidator('Extension',
  95. array('jpg,gif,bmp', true));
  96. // Même exemple pour 1.7
  97. $upload = new Zend_File_Transfer_Adapter_Http();
  98. $upload->addValidator('Extension',
  99. false,
  100. array('extension1' => 'jpg,gif,bmp',
  101. 'case' => true));
  102. ]]></programlisting>
  103. </example>
  104. </sect4>
  105. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.filessize">
  106. <title>Validateur <emphasis>FilesSize</emphasis></title>
  107. <itemizedlist>
  108. <listitem>
  109. <para>Ancienne API : <classname>Zend_Validate_File_FilesSize($min, $max, $bytestring)</classname></para>
  110. </listitem>
  111. <listitem>
  112. <para>Nouvelle API : <classname>Zend_Validate_File_FilesSize($options)</classname> où
  113. <code>$options</code> accepte un tableau avec les clés suivantes : <emphasis>min</emphasis> est
  114. équivalent à <code>$min</code>, <emphasis>max</emphasis> est équivalent à <code>$max</code>,
  115. <emphasis>bytestring</emphasis> est équivalent à <code>$bytestring</code>.</para>
  116. </listitem>
  117. </itemizedlist>
  118. <para>De plus la signature de la méthode <code>useByteString()</code> a changé. Elle peut être seulement
  119. utilisée pour tester si le validateur prévoie d'utiliser les chaînes lisibles ou la valeur brute dans
  120. les messages générées. Pour paramétrer la valeur de cette option, utilisez la méthode
  121. <code>setUseByteString()</code>.</para>
  122. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.filessize.example">
  123. <title>Changer le validateur filessize entre 1.6 et 1.7</title>
  124. <programlisting role="php"><![CDATA[
  125. // Exemple pour 1.6
  126. $upload = new Zend_File_Transfer_Adapter_Http();
  127. $upload->addValidator('FilesSize',
  128. array(100, 10000, true));
  129. // Même exemple pour 1.7
  130. $upload = new Zend_File_Transfer_Adapter_Http();
  131. $upload->addValidator('FilesSize',
  132. false,
  133. array('min' => 100,
  134. 'max' => 10000,
  135. 'bytestring' => true));
  136. // Exemple pour 1.6
  137. $upload->useByteString(true); // set flag
  138. // Même exemple pour 1.7
  139. $upload->setUseByteSting(true); // set flag
  140. ]]></programlisting>
  141. </example>
  142. </sect4>
  143. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.hash">
  144. <title>Validateur <emphasis>Hash</emphasis></title>
  145. <itemizedlist>
  146. <listitem>
  147. <para>Ancienne API : <classname>Zend_Validate_File_Hash($hash, $algorithm)</classname></para>
  148. </listitem>
  149. <listitem>
  150. <para>Nouvelle API : <classname>Zend_Validate_File_Hash($options)</classname> où <code>$options</code>
  151. accepte un tableau avec les clés suivantes : <emphasis>*</emphasis> est équivalent à
  152. <code>$hash</code> et peut avoir tout autre clé, <emphasis>algorithm</emphasis> est équivalent à
  153. <code>$algorithm</code>.</para>
  154. </listitem>
  155. </itemizedlist>
  156. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.hash.example">
  157. <title>Changer le validateur hash entre 1.6 et 1.7</title>
  158. <programlisting role="php"><![CDATA[
  159. // Exemple pour 1.6
  160. $upload = new Zend_File_Transfer_Adapter_Http();
  161. $upload->addValidator('Hash',
  162. array('12345', 'md5'));
  163. // Même exemple pour 1.7
  164. $upload = new Zend_File_Transfer_Adapter_Http();
  165. $upload->addValidator('Hash',
  166. false,
  167. array('hash1' => '12345',
  168. 'algorithm' => 'md5'));
  169. ]]></programlisting>
  170. </example>
  171. </sect4>
  172. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.imagesize">
  173. <title>Validateur <emphasis>ImageSize</emphasis></title>
  174. <itemizedlist>
  175. <listitem>
  176. <para>Ancienne API : <classname>Zend_Validate_File_ImageSize($minwidth, $minheight, $maxwidth,
  177. $maxheight)</classname></para>
  178. </listitem>
  179. <listitem>
  180. <para>Nouvelle API : <classname>Zend_Validate_File_FilesSize($options)</classname> où
  181. <code>$options</code> accepte un tableau avec les clés suivantes : <emphasis>minwidth</emphasis>
  182. est équivalent à <code>$minwidth</code>, <emphasis>maxwidth</emphasis> est équivalent à
  183. <code>$maxwidth</code>, <emphasis>minheight</emphasis> est équivalent à <code>$minheight</code>,
  184. <emphasis>maxheight</emphasis> est équivalent à <code>$maxheight</code>.</para>
  185. </listitem>
  186. </itemizedlist>
  187. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.imagesize.example">
  188. <title>Changer le validateur imagesize entre 1.6 et 1.7</title>
  189. <programlisting role="php"><![CDATA[
  190. // Exemple pour 1.6
  191. $upload = new Zend_File_Transfer_Adapter_Http();
  192. $upload->addValidator('ImageSize',
  193. array(10, 10, 100, 100));
  194. // Même exemple pour 1.7
  195. $upload = new Zend_File_Transfer_Adapter_Http();
  196. $upload->addValidator('ImageSize',
  197. false,
  198. array('minwidth' => 10,
  199. 'minheight' => 10,
  200. 'maxwidth' => 100,
  201. 'maxheight' => 100));
  202. ]]></programlisting>
  203. </example>
  204. </sect4>
  205. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.size">
  206. <title>Validateur <emphasis>Size</emphasis></title>
  207. <itemizedlist>
  208. <listitem>
  209. <para>Ancienne API : <classname>Zend_Validate_File_Size($min, $max, $bytestring)</classname></para>
  210. </listitem>
  211. <listitem>
  212. <para>Nouvelle API : <classname>Zend_Validate_File_Size($options)</classname> où <code>$options</code>
  213. accepte un tableau avec les clés suivantes : <emphasis>min</emphasis> est équivalent à
  214. <code>$min</code>, <emphasis>max</emphasis> est équivalent à <code>$max</code>,
  215. <emphasis>bytestring</emphasis> est équivalent à <code>$bytestring</code></para>
  216. </listitem>
  217. </itemizedlist>
  218. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.size.example">
  219. <title>Changer le validateur size entre 1.6 et 1.7</title>
  220. <programlisting role="php"><![CDATA[
  221. // Exemple pour 1.6
  222. $upload = new Zend_File_Transfer_Adapter_Http();
  223. $upload->addValidator('Size',
  224. array(100, 10000, true));
  225. // Même exemple pour 1.7
  226. $upload = new Zend_File_Transfer_Adapter_Http();
  227. $upload->addValidator('Size',
  228. false,
  229. array('min' => 100,
  230. 'max' => 10000,
  231. 'bytestring' => true));
  232. ]]></programlisting>
  233. </example>
  234. </sect4>
  235. </sect3>
  236. </sect2>
  237. <sect2 id="zend.file.transfer.migration.fromonesixonetoonesixtwo">
  238. <title>Migrer de la version 1.6.1 vers 1.6.2 ou plus récent</title>
  239. <sect3 id="zend.file.transfer.migration.fromonesixonetoonesixtwo.validators">
  240. <title>Changements quand vous utilisez des validateurs</title>
  241. <para>Certaines remarques des utilisateurs indiquaient que les validateurs de
  242. <classname>Zend_File_Transfer</classname> ne fonctionnaient pas comme ceux par défaut fournis avec
  243. <classname>Zend_Form</classname>. <classname>Zend_Form</classname> permet par exemple l'utilisation du paramètre
  244. <code>breakChainOnFailure</code> qui stoppe la validation de tous les validateurs suivants dès qu'une erreur
  245. de validation apparaît.</para>
  246. <para>Nous avons donc ajouter ce paramètre à tous les validateurs existants pour
  247. <classname>Zend_File_Transfer</classname>.</para>
  248. <itemizedlist>
  249. <listitem>
  250. <para>Ancienne API : <code>addValidator($validator, $options, $files)</code>.</para>
  251. </listitem>
  252. <listitem>
  253. <para>Nouvelle API : <code>addValidator($validator, $breakChainOnFailure, $options,
  254. $files)</code>.</para>
  255. </listitem>
  256. </itemizedlist>
  257. <para>Pour migrer vos scripts vers la nouvelle API, ajoutez simplement un a <code>false</code> après voir
  258. défini le validateur souhaité.</para>
  259. <example id="zend.file.transfer.migration.fromonesixonetoonesixtwo.example">
  260. <title>Changer les validateurs de fichiers de 1.6.1 vers 1.6.2</title>
  261. <programlisting role="php"><![CDATA[
  262. // Exemple pour 1.6.1
  263. $upload = new Zend_File_Transfer_Adapter_Http();
  264. $upload->addValidator('FilesSize', array('1B', '100kB'));
  265. // Même exemple pour 1.6.2 et plus récent
  266. // Notez l'ajout du booléen false
  267. $upload = new Zend_File_Transfer_Adapter_Http();
  268. $upload->addValidator('FilesSize', false, array('1B', '100kB'));]]></programlisting>
  269. </example>
  270. </sect3>
  271. </sect2>
  272. </sect1>