Zend_File_Transfer-Migration.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15854 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.file.transfer.migration">
  5. <title>Migration von vorhergehenden Versionen</title>
  6. <para>
  7. Die API von <classname>Zend_File_Transfer</classname> wurde von Zeit zu Zeit verändert. Wenn
  8. man bereits angefangen hat <classname>Zend_File_Transfer</classname> und dessen
  9. Subkomponenten in vorhergehenden Versionen zu verwenden sollte man den anbei beschriebenen
  10. Richtlinien folgen um eigene Skripts auf die neue API zu migrieren.
  11. </para>
  12. <sect2 id="zend.file.transfer.migration.fromonesixtooneseven">
  13. <title>Migration von 1.6 zu 1.7 oder neuer</title>
  14. <sect3 id="zend.file.transfer.migration.fromonesixtooneseven.validators">
  15. <title>Änderungen bei der Verwendung von Filtern und Prüfungen</title>
  16. <para>
  17. Wie von Benutzern erwähnt, arbeiteten die Prüfungen von
  18. <classname>Zend_File_Transfer</classname> nicht in Verbindung mit
  19. <classname>Zend_Config</classname> zusammen, durch den Fakt das Sie keine benannten
  20. Arrays verwendet haben.
  21. </para>
  22. <para>
  23. Deswegen wurden alle Filter und Prüfungen für
  24. <classname>Zend_File_Transfer</classname> überarbeitet. Wärend die alten Signaturen
  25. weiterhin funktionieren, wurden sie als veraltet markiert, und werfen eine PHP Notiz
  26. mit der Aufforderung das zu beheben.
  27. </para>
  28. <para>
  29. Die folgende Liste zeigt die Änderungen und was für die richtige Verwendung der
  30. Parameter getan werden muß.
  31. </para>
  32. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.rename">
  33. <title>Filter: Rename</title>
  34. <itemizedlist>
  35. <listitem><para>
  36. Alte API der Methode: <classname>Zend_Filter_File_Rename($oldfile, $newfile,
  37. $overwrite)</classname>
  38. </para></listitem>
  39. <listitem><para>
  40. Neue API der Methode:
  41. <classname>Zend_Filter_File_Rename($options)</classname> wobei $options
  42. die folgenden Schlüssel für das Array akzeptiert:
  43. <emphasis>source</emphasis> identisch mit $oldfile,
  44. <emphasis>target</emphasis> identisch mit $newfile,
  45. <emphasis>overwrite</emphasis> identisch mit $overwrite
  46. </para></listitem>
  47. </itemizedlist>
  48. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.rename.example">
  49. <title>Änderungen für den Rename Filter von 1.6 zu 1.7</title>
  50. <programlisting language="php"><![CDATA[
  51. // Beispiel für 1.6
  52. $upload = new Zend_File_Transfer_Adapter_Http();
  53. $upload->addFilter('Rename',
  54. array('/path/to/oldfile', '/path/to/newfile', true));
  55. // Gleiches Beispiel für 1.7
  56. $upload = new Zend_File_Transfer_Adapter_Http();
  57. $upload->addFilter('Rename',
  58. array('source' => '/path/to/oldfile',
  59. 'target' => '/path/to/newfile',
  60. 'overwrite' => true));
  61. ]]></programlisting>
  62. </example>
  63. </sect4>
  64. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.count">
  65. <title>Prüfung: Count</title>
  66. <itemizedlist>
  67. <listitem><para>
  68. Alte API der Methode: <classname>Zend_Validate_File_Count($min,
  69. $max)</classname>
  70. </para></listitem>
  71. <listitem><para>
  72. Neue API der Methode:
  73. <classname>Zend_Validate_File_Count($options)</classname> wobei $options
  74. die folgenden Schlüssel für das Array akzeptiert:
  75. <emphasis>min</emphasis> identisch mit $min,
  76. <emphasis>max</emphasis> identisch mit $max,
  77. </para></listitem>
  78. </itemizedlist>
  79. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.count.example">
  80. <title>Änderungen für die Count Prüfung von 1.6 zu 1.7</title>
  81. <programlisting language="php"><![CDATA[
  82. // Beispiel für 1.6
  83. $upload = new Zend_File_Transfer_Adapter_Http();
  84. $upload->addValidator('Count',
  85. array(2, 3));
  86. // Gleiches Beispiel für 1.7
  87. $upload = new Zend_File_Transfer_Adapter_Http();
  88. $upload->addValidator('Count',
  89. false,
  90. array('min' => 2,
  91. 'max' => 3));
  92. ]]></programlisting>
  93. </example>
  94. </sect4>
  95. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.extension">
  96. <title>Prüfung: Extension</title>
  97. <itemizedlist>
  98. <listitem><para>
  99. Alte API der Methode:
  100. <classname>Zend_Validate_File_Extension($extension, $case)</classname>
  101. </para></listitem>
  102. <listitem><para>
  103. Neue API der Methode:
  104. <classname>Zend_Validate_File_Extension($options)</classname> wobei $options
  105. die folgenden Schlüssel für das Array akzeptiert:
  106. <emphasis>*</emphasis> identisch mit $extension und kann jeden anderen
  107. Schlüssel haben <emphasis>case</emphasis> identisch mit $case,
  108. </para></listitem>
  109. </itemizedlist>
  110. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.extension.example">
  111. <title>Änderungen für die Extension Prüfung von 1.6 zu 1.7</title>
  112. <programlisting language="php"><![CDATA[
  113. // Beispiel für 1.6
  114. $upload = new Zend_File_Transfer_Adapter_Http();
  115. $upload->addValidator('Extension',
  116. array('jpg,gif,bmp', true));
  117. // Gleiches Beispiel für 1.7
  118. $upload = new Zend_File_Transfer_Adapter_Http();
  119. $upload->addValidator('Extension',
  120. false,
  121. array('extension1' => 'jpg,gif,bmp',
  122. 'case' => true));
  123. ]]></programlisting>
  124. </example>
  125. </sect4>
  126. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.filessize">
  127. <title>Prüfung: FilesSize</title>
  128. <itemizedlist>
  129. <listitem><para>
  130. Alte API der Methode:
  131. <classname>Zend_Validate_File_FilesSize($min, $max, $bytestring)</classname>
  132. </para></listitem>
  133. <listitem><para>
  134. Neue API der Methode:
  135. <classname>Zend_Validate_File_FilesSize($options)</classname> wobei $options
  136. die folgenden Schlüssel für das Array akzeptiert:
  137. <emphasis>min</emphasis> identisch mit $min,
  138. <emphasis>max</emphasis> identisch mit $max,
  139. <emphasis>bytestring</emphasis> identisch mit $bytestring
  140. </para></listitem>
  141. </itemizedlist>
  142. <para>
  143. Zustätzlich wurde die Signatur der <code>useByteString()</code> Methode
  144. geändert. Sie kann nur verwendet werden um zu testen ob die Prüfung ByteStrings
  145. in den erzeugten Meldungen verwendet oder ncht. Um den Wert dieses Flags zu
  146. setzen muß die <code>setUseByteString()</code> Methode verwendet werden.
  147. </para>
  148. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.filessize.example">
  149. <title>Änderungen für die FilesSize Prüfung von 1.6 zu 1.7</title>
  150. <programlisting language="php"><![CDATA[
  151. // Beispiel für 1.6
  152. $upload = new Zend_File_Transfer_Adapter_Http();
  153. $upload->addValidator('FilesSize',
  154. array(100, 10000, true));
  155. // Gleiches Beispiel für 1.7
  156. $upload = new Zend_File_Transfer_Adapter_Http();
  157. $upload->addValidator('FilesSize',
  158. false,
  159. array('min' => 100,
  160. 'max' => 10000,
  161. 'bytestring' => true));
  162. // Beispiel für 1.6
  163. $upload->useByteString(true); // Flag setzen
  164. // Gleiches Beispiel für 1.7
  165. $upload->setUseByteSting(true); // Flag setzen
  166. ]]></programlisting>
  167. </example>
  168. </sect4>
  169. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.hash">
  170. <title>Prüfung: Hash</title>
  171. <itemizedlist>
  172. <listitem><para>
  173. Alte API der Methode:
  174. <classname>Zend_Validate_File_Hash($hash, $algorithm)</classname>
  175. </para></listitem>
  176. <listitem><para>
  177. Neue API der Methode:
  178. <classname>Zend_Validate_File_Hash($options)</classname> wobei $options
  179. die folgenden Schlüssel für das Array akzeptiert:
  180. <emphasis>*</emphasis> identisch mit $hash und kann jeden anderen Schlüssel
  181. haben <emphasis>algorithm</emphasis> identisch mit $algorithm,
  182. </para></listitem>
  183. </itemizedlist>
  184. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.hash.example">
  185. <title>Änderungen für die Hash Prüfung von 1.6 zu 1.7</title>
  186. <programlisting language="php"><![CDATA[
  187. // Beispiel für 1.6
  188. $upload = new Zend_File_Transfer_Adapter_Http();
  189. $upload->addValidator('Hash',
  190. array('12345', 'md5'));
  191. // Gleiches Beispiel für 1.7
  192. $upload = new Zend_File_Transfer_Adapter_Http();
  193. $upload->addValidator('Hash',
  194. false,
  195. array('hash1' => '12345',
  196. 'algorithm' => 'md5'));
  197. ]]></programlisting>
  198. </example>
  199. </sect4>
  200. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.imagesize">
  201. <title>Prüfung: ImageSize</title>
  202. <itemizedlist>
  203. <listitem><para>
  204. Alte API der Methode: <classname>Zend_Validate_File_ImageSize($minwidth,
  205. $minheight, $maxwidth, $maxheight)</classname>
  206. </para></listitem>
  207. <listitem><para>
  208. Neue API der Methode:
  209. <classname>Zend_Validate_File_FilesSize($options)</classname> wobei $options
  210. die folgenden Schlüssel für das Array akzeptiert:
  211. <emphasis>minwidth</emphasis> identisch mit $minwidth,
  212. <emphasis>maxwidth</emphasis> identisch mit $maxwidth,
  213. <emphasis>minheight</emphasis> identisch mit $minheight,
  214. <emphasis>maxheight</emphasis> identisch mit $maxheight,
  215. </para></listitem>
  216. </itemizedlist>
  217. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.imagesize.example">
  218. <title>Änderungen für die ImageSize Prüfung von 1.6 zu 1.7</title>
  219. <programlisting language="php"><![CDATA[
  220. // Beispiel für 1.6
  221. $upload = new Zend_File_Transfer_Adapter_Http();
  222. $upload->addValidator('ImageSize',
  223. array(10, 10, 100, 100));
  224. // Gleiches Beispiel für 1.7
  225. $upload = new Zend_File_Transfer_Adapter_Http();
  226. $upload->addValidator('ImageSize',
  227. false,
  228. array('minwidth' => 10,
  229. 'minheight' => 10,
  230. 'maxwidth' => 100,
  231. 'maxheight' => 100));
  232. ]]></programlisting>
  233. </example>
  234. </sect4>
  235. <sect4 id="zend.file.transfer.migration.fromonesixtooneseven.validators.size">
  236. <title>Prüfung: Size</title>
  237. <itemizedlist>
  238. <listitem><para>
  239. Alte API der Methode:
  240. <classname>Zend_Validate_File_Size($min, $max, $bytestring)</classname>
  241. </para></listitem>
  242. <listitem><para>
  243. Neue API der Methode:
  244. <classname>Zend_Validate_File_Size($options)</classname> wobei $options
  245. die folgenden Schlüssel für das Array akzeptiert:
  246. <emphasis>min</emphasis> identisch mit $min,
  247. <emphasis>max</emphasis> identisch mit $max,
  248. <emphasis>bytestring</emphasis> identisch mit $bytestring
  249. </para></listitem>
  250. </itemizedlist>
  251. <example id="zend.file.transfer.migration.fromonesixonetooneseven.validators.size.example">
  252. <title>Änderungen für die Size Prüfung von 1.6 zu 1.7</title>
  253. <programlisting language="php"><![CDATA[
  254. // Beispiel für 1.6
  255. $upload = new Zend_File_Transfer_Adapter_Http();
  256. $upload->addValidator('Size',
  257. array(100, 10000, true));
  258. // Gleiches Beispiel für 1.7
  259. $upload = new Zend_File_Transfer_Adapter_Http();
  260. $upload->addValidator('Size',
  261. false,
  262. array('min' => 100,
  263. 'max' => 10000,
  264. 'bytestring' => true));
  265. ]]></programlisting>
  266. </example>
  267. </sect4>
  268. </sect3>
  269. </sect2>
  270. <sect2 id="zend.file.transfer.migration.fromonesixonetoonesixtwo">
  271. <title>Migration von 1.6.1 zu 1.6.2 oder neuer</title>
  272. <sect3 id="zend.file.transfer.migration.fromonesixonetoonesixtwo.validators">
  273. <title>Änderungen bei der Verwendung von Prüfungen</title>
  274. <para>
  275. Wie von Benutzern festgestellt wurde, haben die Prüfungen von
  276. <classname>Zend_File_Transfer</classname> nicht auf die gleiche Art und Weise
  277. funktioniert wie standardmäßigen von <classname>Zend_Form</classname>.
  278. <classname>Zend_Form</classname> erlaubt die Verwendung eines
  279. <code>breakChainOnFailure</code> Parameters der die Prüfung für alle weitere Prüfer
  280. unterbricht wenn ein Prüffehler aufgetreten ist.
  281. </para>
  282. <para>
  283. Deshalb wurde dieser Parameter bei allen bestehenden Prüfungen von
  284. <classname>Zend_File_Transfer</classname> hinzugefügt.
  285. </para>
  286. <itemizedlist>
  287. <listitem><para>
  288. Alte API der Methode: <code>addValidator($validator, $options, $files)</code>.
  289. </para></listitem>
  290. <listitem><para>
  291. Neue API der Methode:
  292. <code>addValidator($validator, $breakChainOnFailure, $options, $files)</code>.
  293. </para></listitem>
  294. </itemizedlist>
  295. <para>
  296. Um also eigene Skripte auf die neue API zu migrieren, muß einfach ein
  297. <constant>FALSE</constant> nach der Definition der gewünschten Prüfung hinzugefügt werden.
  298. </para>
  299. <example id="zend.file.transfer.migration.fromonesixonetoonesixtwo.example">
  300. <title>Wie man eigene Dateiprüfungen von 1.6.1 auf 1.6.2 ändert</title>
  301. <programlisting language="php"><![CDATA[
  302. // Beispiel für 1.6.1
  303. $upload = new Zend_File_Transfer_Adapter_Http();
  304. $upload->addValidator('FilesSize', array('1B', '100kB'));
  305. // Selbes Beispiel für 1.6.2 und neuer
  306. // Beachte das hinzugefügte boolsche false
  307. $upload = new Zend_File_Transfer_Adapter_Http();
  308. $upload->addValidator('FilesSize', false, array('1B', '100kB'));
  309. ]]></programlisting>
  310. </example>
  311. </sect3>
  312. </sect2>
  313. </sect1>