Zend_File_Transfer-Validators.xml 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15207 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.file.transfer.validators">
  5. <title>Prüfungen für Zend_File_Transfer</title>
  6. <para>
  7. <classname>Zend_File_Transfer</classname> wird mit verschiedenen Datei-relevanten Prüfungen ausgeliefert
  8. welche verwendet werden können um die Sicherheit zu erhöhen und mögliche Attacken zu verhindern.
  9. Es ist zu beachten das diese Prüfungen nur so effektiv sind wie Sie effektiv angewendet verwendet.
  10. Alle Prüfungen die mit <classname>Zend_File_Transfer</classname> angeboten werden können in der
  11. <classname>Zend_Validator</classname> Komponente gefunden werden und heißen <classname>Zend_Validate_File_*</classname>.
  12. Die folgenden Prüfungen sind vorhanden:
  13. </para>
  14. <itemizedlist>
  15. <listitem>
  16. <para>
  17. <code>Count</code>: Diese Prüfung checkt die Anzahl der Dateien. Es kann ein Minimum und ein
  18. Maximum spezifiziert werden. Ein Fehler wird geworfen wenn einer der zwei Werte
  19. überschritten wird.
  20. </para>
  21. </listitem>
  22. <listitem>
  23. <para>
  24. <code>Crc32</code>: Diese Prüfung checkt den Crc32 Hashwert vom Inhalt einer Datei. Sie basiert
  25. auf der <code>Hash</code> Prüfung und bietet eine bequeme und einfache Prüfung die nur Crc32
  26. unterstützt.
  27. </para>
  28. </listitem>
  29. <listitem>
  30. <para>
  31. <code>ExcludeExtension</code>: Diese Prüfung checkt die Dateierweiterung. Sie wirft einen Fehler
  32. wenn die angegebene Datei eine definierte Erweiterung hat. Mit dieser Prüfung können definierte
  33. Erweiterungen von der Prüfung ausgenommen werden.
  34. </para>
  35. </listitem>
  36. <listitem>
  37. <para>
  38. <code>ExcludeMimeType</code>: Diese Prüfung prüft den MIME Typ von Dateien. Sie kann auch
  39. Arten von MIME Typen prüfen und wirft einen Fehler wenn der MIME Typ einer spezifizierten
  40. Datei passt.
  41. </para>
  42. </listitem>
  43. <listitem>
  44. <para>
  45. <code>Exists</code>: Diese Prüfung checkt ob Dateien existieren. Sie wirft einen Fehler wenn
  46. eine spezifizierte Datei nicht existiert.
  47. </para>
  48. </listitem>
  49. <listitem>
  50. <para>
  51. <code>Extension</code>: Diese Prüfung checkt die Dateierweiterung. Sie wirft einen Fehler
  52. wenn eine spezifizierte Datei eine undefinierte Erweiterung hat.
  53. </para>
  54. </listitem>
  55. <listitem>
  56. <para>
  57. <code>FilesSize</code>: Diese Prüfung checkt die Größe von geprüften Dateien.
  58. Sie merkt sich intern die Größe aller geprüften Dateien und wirft einen Fehler wenn die
  59. Summe aller spezifizierten Dateien die definierte Größe überschreitet. Sie bietet auch
  60. Mindest- und Maximalwerte an.
  61. </para>
  62. </listitem>
  63. <listitem>
  64. <para>
  65. <code>ImageSize</code>: Diese Prüfung checkt die Größe von Bildern. Sie prüft die Breite
  66. und Höhe und erzwingt sowohl eine Mindest- als auch eine Maximalegröße.
  67. </para>
  68. </listitem>
  69. <listitem>
  70. <para>
  71. <code>IsCompressed</code>: Diese Prüfung checkt ob die Datei komprimiert ist. Sie basiert
  72. auf der <code>MimeType</code> Prüfung und validiert Komprimierungsarchiven wie Zip
  73. oder Arc. Sie kann auch auf andere Archive begrenzt werden.
  74. </para>
  75. </listitem>
  76. <listitem>
  77. <para>
  78. <code>IsImage</code>: Diese Prüfung checkt ob die Datei ein Bild ist. Sie basiert auf der
  79. <code>MimeType</code> Prüfung und validiert Bildedateien wie Jpg oder Gif. Sie kann auch
  80. auf andere Bildtypen begrenzt werden.
  81. </para>
  82. </listitem>
  83. <listitem>
  84. <para>
  85. <code>Hash</code>: Diese Prüfung check den Hashwert des Inhalts einer Datei. Sie unterstützt
  86. mehrere Algorithmen.
  87. </para>
  88. </listitem>
  89. <listitem>
  90. <para>
  91. <code>Md5</code>: Diese Prüfung checkt den Md5 Hashwert vom Inhalt einer Datei. Sie basiert
  92. auf der <code>Hash</code> Prüfung und bietet eine bequeme und einfache Prüfung die nur
  93. Md5 unterstützt.
  94. </para>
  95. </listitem>
  96. <listitem>
  97. <para>
  98. <code>MimeType</code>: Diese Prüfung prüft den MIME Typ von Dateien. Sie kann auch
  99. Arten von MIME Typen prüfen und wirft einen Fehler wenn der MIME Typ einer spezifizierten
  100. Datei nicht passt.
  101. </para>
  102. </listitem>
  103. <listitem>
  104. <para>
  105. <code>NotExists</code>: Diese Prüfung checkt ob Dateien existieren. Sie wirft einen Fehler
  106. wenn eine angegebene Datei existiert.
  107. </para>
  108. </listitem>
  109. <listitem>
  110. <para>
  111. <code>Sha1</code>: Diese Prüfung checkt den Sha1 Hashwert vom Inhalt einer Datei. Sie basiert
  112. auf der <code>Hash</code> Prüfung und bietet eine bequeme und einfache Prüfung die nur Sha1
  113. unterstützt.
  114. </para>
  115. </listitem>
  116. <listitem>
  117. <para>
  118. <code>Size</code>: Diese Prüfung ist fähig Dateien auf Ihre Dateigröße zu prüfen. Sie
  119. bietet eine Mindest- und eine Maximalgröße an und wirft einen Fehler wenn eine der
  120. beiden Grenzen überschritten wird.
  121. </para>
  122. </listitem>
  123. <listitem>
  124. <para>
  125. <code>Upload</code>: Diese Prüfung ist eine interne. Sie prüft ob ein Upload zu einem
  126. Fehler geführt hat. Dieser darf nicht gesetzt werden, da er automatisch durch
  127. <classname>Zend_File_Transfer</classname> selbst gesetzt wird. Deshalb darf diese Prüfung nicht
  128. direkt verwendet werden. Man sollte nur wissen das Sie existiert.
  129. </para>
  130. </listitem>
  131. <listitem>
  132. <para>
  133. <code>WordCount</code>: Diese Prüfung ist fähig die Anzahl von Wörtern in Dateien zu
  134. prüfen. Sie bietet eine Mindest- und Maximalanzahl und wirft einen Fehler wenn eine der
  135. Grenzen überschritten wird.
  136. </para>
  137. </listitem>
  138. </itemizedlist>
  139. <sect2 id="zend.file.transfer.validators.usage">
  140. <title>Prüfungen mit Zend_File_Transfer verwenden</title>
  141. <para>
  142. Prüfungen einzubinden ist sehr einfach. Es gibt verschiedene Methoden für das
  143. Hinzufügen und Manipulieren von Prüfungen:
  144. </para>
  145. <itemizedlist>
  146. <listitem>
  147. <para>
  148. <code>isValid($files = null)</code>: Prüft die spezifizierten Dateien indem alle
  149. Prüfungen verwendet werden. <code>$files</code> kann entweder ein richtiger Dateiname,
  150. der Name des Elements, oder der Name der temporären Datei sein.
  151. </para>
  152. </listitem>
  153. <listitem>
  154. <para>
  155. <code>addValidator($validator, $breakChainOnFailure, $options = null, $files = null)</code>:
  156. Fügt die spezifizierte Prüfung zu den Prüfungsstapel hinzu (optional nur zu den Datei(en)
  157. die spezifiziert wurden). <code>$validator</code> kann entweder eine aktuelle
  158. Prüfinstanz sein oder ein Kurzname der den Prüfungstyp spezifiziert (z.B. 'Count').
  159. </para>
  160. </listitem>
  161. <listitem>
  162. <para>
  163. <code>addValidators(array $validators, $files = null)</code>: Fügt die spezifizierten
  164. Prüfungen zum Prüfungsstapel hinzu. Jeder Eintrag kann entweder ein Prüfungstyp/-options
  165. Paar sein oder ein Array mit dem Schlüssel 'validator' das die Prüfung spezifiziert.
  166. Alle anderen Optionen werden als Optionen für die Instanzierung der Prüfung angenommen.
  167. </para>
  168. </listitem>
  169. <listitem>
  170. <para>
  171. <code>setValidators(array $validators, $files = null)</code>: Überschreibt alle bestehenden
  172. Prüfungen mit den spezifizierten Prüfungen. Die Prüfungen sollten der Syntax folgen die
  173. für <code>addValidators()</code> definiert ist.
  174. </para>
  175. </listitem>
  176. <listitem>
  177. <para>
  178. <code>hasValidator($name)</code>: Zeigt ob eine Prüfung registriert wurde.
  179. </para>
  180. </listitem>
  181. <listitem>
  182. <para>
  183. <code>getValidator($name)</code>: Gibt eine vorher registrierte Prüfung zurück.
  184. </para>
  185. </listitem>
  186. <listitem>
  187. <para>
  188. <code>getValidators($files = null)</code>: Gibt registrierte Prüfungen zurück. Wenn
  189. <code>$files</code> spezifiziert wurde, werden die Prüfungen für die betreffende Datei
  190. oder das Set an Dateien zurückgegeben.
  191. </para>
  192. </listitem>
  193. <listitem>
  194. <para>
  195. <code>removeValidator($name)</code>: Entfernt eine vorher registrierte Prüfung.
  196. </para>
  197. </listitem>
  198. <listitem>
  199. <para>
  200. <code>clearValidators()</code>: Löscht alle registrierten Prüfungen.
  201. </para>
  202. </listitem>
  203. </itemizedlist>
  204. <example id="zend.file.transfer.validators.usage.example">
  205. <title>Prüfungen zu einem File Transfer Objekt hinzufügen</title>
  206. <programlisting role="php"><![CDATA[
  207. $upload = new Zend_File_Transfer();
  208. // Setzt eine Dateigröße von 20000 Bytes
  209. $upload->addValidator('Size', false, 20000);
  210. // Setzt eine Dateigröße von mindestens 20 Bytes und maximal 20000 Bytes
  211. $upload->addValidator('Size', false, array('min' => 20, 'max' => 20000));
  212. // Setzt eine Dateigröße von mindestens 20 Bytes und Maximal
  213. // 20000 Bytes und eine Dateianzahl in einem Schritt
  214. $upload->setValidators(array(
  215. 'Size' => array('min' => 20, 'max' => 20000),
  216. 'Count' => array('min' => 1, 'max' => 3),
  217. ));
  218. ]]></programlisting>
  219. </example>
  220. <example id="zend.file.transfer.validators.usage.exampletwo">
  221. <title>Prüfungen auf eine einzelne Datei limitieren</title>
  222. <para>
  223. <code>addValidator()</code>, <code>addValidators()</code>, und <code>setValidators()</code>
  224. akzeptieren ein endendes Argument <code>$files</code>. Dieses Argument kann verwendet werden
  225. um eine Datei oder ein Array von Dateien zu spezifizieren auf dem die angegebene Prüfung
  226. gesetzt werden soll.
  227. </para>
  228. <programlisting role="php"><![CDATA[
  229. $upload = new Zend_File_Transfer();
  230. // Setzt die Dateigröße auf 20000 Bytes und limitiert Sie nur auf 'file2'
  231. $upload->addValidator('Size', false, 20000, 'file2');
  232. ]]></programlisting>
  233. </example>
  234. <para>
  235. Normal sollte die <code>addValidators()</code> Methode verwendet werden, welche
  236. mehrmals aufgerufen werden kann.
  237. </para>
  238. <example id="zend.file.transfer.validators.usage.examplemultiple">
  239. <title>Mehrere Prüfungen hinzufügen</title>
  240. <para>
  241. Oft ist es einfacher <code>addValidator()</code> mehrere Male aufzurufen mit einem Aufruf für
  242. jede Prüfung. Das erhöht auch die Lesbarkeit und macht den Code wartbarer. Alle Methoden
  243. implementieren das Fluent-Interface, deshalb können Aufrufe einfach wie anbei gezeigt
  244. gekoppelt werden:
  245. </para>
  246. <programlisting role="php"><![CDATA[
  247. $upload = new Zend_File_Transfer();
  248. // Setzt die Dateigröße auf 20000 Bytes
  249. $upload->addValidator('Size', false, 20000)
  250. ->addValidator('Count', false, 2)
  251. ->addValidator('Filessize', false, 25000);
  252. ]]></programlisting>
  253. </example>
  254. <note>
  255. <para>
  256. Es ist zu beachten, dass das mehrfache Setzen der gleichen Prüfung erlaubt
  257. ist, dass das aber zu Problemen führen kann wenn verschiedene Optionen für die gleiche
  258. Prüfung verwendet werden.
  259. </para>
  260. </note>
  261. <para>
  262. Letztendlich können Dateien einfach geprüft werden indem <code>isValid()</code> verwendet wird.
  263. </para>
  264. <example id="zend.file.transfer.validators.usage.exampleisvalid">
  265. <title>Prüfen der Dateien</title>
  266. <para>
  267. <code>isValid()</code> akzeptiert den Dateinamen der hochgeladenen oder heruntergeladenen
  268. Datei, den temporären Dateinamen oder den Namen des Formularelements. Wenn kein Parameter
  269. oder null angegeben wird, werden alle gefundenen Dateien geprüft.
  270. </para>
  271. <programlisting role="php"><![CDATA[
  272. $upload = new Zend_File_Transfer();
  273. // Setzt die Dateigröße auf 20000 Bytes
  274. $upload->addValidator('Size', false, 20000)
  275. ->addValidator('Count', false, 2)
  276. ->addValidator('Filessize', false, 25000);
  277. if ($upload->isValid()) {
  278. print "Prüfung fehlgeschlagen";
  279. }
  280. ]]></programlisting>
  281. </example>
  282. <note>
  283. <para>
  284. Es ist zu beachten das <code>isValid()</code> automatisch aufgerufen wird, wenn die Dateien
  285. empfangen werden und es zuvor noch nicht aufgerufen wurde.
  286. </para>
  287. </note>
  288. <para>
  289. Wenn Prüfungen fehlgeschlagen sind, ist es eine gute Idee Informationen über die
  290. gefundenen Probleme zu erhalten. Um diese Information zu erhalten können die Methoden
  291. <code>getMessages()</code>, welche alle Prüfmeldungen als Array zurückgibt,
  292. <code>getErrors()</code> welche alle Fehlercodes zurückgibt, und <code>hasErrors()</code>
  293. welche true zurückgibt sobald ein Prüffehler gefunden wurde, verwendet werden.
  294. </para>
  295. </sect2>
  296. <sect2 id="zend.file.transfer.validators.count">
  297. <title>Count Prüfung</title>
  298. <para>
  299. Die <code>Count</code> Prüfung checkt die Anzahl der Dateien die angegeben wurde. Sie unterstützt
  300. die folgenden Schlüssel für Optionen:
  301. </para>
  302. <itemizedlist>
  303. <listitem>
  304. <para>
  305. <code>min</code>: Setzt die minimale Anzahl der Dateien die übertragen wird.
  306. </para>
  307. <note>
  308. <para>
  309. Wenn diese Option verwendet wird, muß die minimale Anzahl an Dateien
  310. übergeben werden wenn die Prüfung das erste Mal aufgerufen wird; sonst wird ein
  311. Fehler zurückgegeben.
  312. </para>
  313. </note>
  314. <para>
  315. Mit dieser Option kann die Mindestanzahl an Dateien definiert werden die man Empfangen sollte.
  316. </para>
  317. </listitem>
  318. <listitem>
  319. <para>
  320. <code>max</code>: Setzt die maximale Anzahl an Dateien die übertragen wird.
  321. </para>
  322. <para>
  323. Mit dieser Option kann die Anzahl der Dateien limitiert werden die man akzeptiert,
  324. aber genauso eine mögliche Attacke erkennen wenn mehr Dateien übertragen werden als
  325. im Formular definiert wurden.
  326. </para>
  327. </listitem>
  328. </itemizedlist>
  329. <para>
  330. Wenn diese Prüfung mit einem String oder Integer initiiert wird, wird Sie als
  331. <code>max</code> verwendet. Es können aber auch die Methoden <code>setMin()</code> und
  332. <code>setMax()</code> verwendet werden um beide Optionen im Nachhinein zu setzen und
  333. <code>getMin()</code> und <code>getMax()</code> um die aktuell gesetzten Werte zu erhalten.
  334. </para>
  335. <example id="zend.file.transfer.validators.count.example">
  336. <title>Die Count Prüfung verwenden</title>
  337. <programlisting role="php"><![CDATA[
  338. $upload = new Zend_File_Transfer();
  339. // Die Anzahl der Dateien auf maximal 2 limitieren
  340. $upload->addValidator('Count', false, 2);
  341. // Die Anzahl der Dateien auf maximal 5 und mindestens 1 Datei limitieren
  342. $upload->addValidator('Count', false, array('min' =>1, 'max' => 5));
  343. ]]></programlisting>
  344. </example>
  345. <note>
  346. <para>
  347. Beachte das diese Prüfung die Anzahl der geprüften Dateien intern speichert. Die Datei
  348. welche das Maximum überschrietet wird als Fehler zurückgegeben.
  349. </para>
  350. </note>
  351. </sect2>
  352. <sect2 id="zend.file.transfer.validators.crc32">
  353. <title>Crc32 Prüfung</title>
  354. <para>
  355. Die <code>Crc32</code> Prüfung checkt den Inhalt einer übertragenen Datei durch hashen. Diese
  356. Prüfung verwendet die Hash Erweiterung von PHP mit dem Crc32 Algorithmus. Sie unterstützt die
  357. folgenden Optionen:
  358. </para>
  359. <itemizedlist>
  360. <listitem>
  361. <para>
  362. <code>*</code>: Setzt einen beliebigen Schlüssel oder ein nummerisches Array
  363. Dieser Wert wird als Hash verwendet gegen den geprüft wird.
  364. </para>
  365. <para>
  366. Man kann mehrere Hashes setzen indem unterschiedliche Schlüssel angegeben werden.
  367. Jeder von Ihnen wird geprüft und die Prüfung schlägt nur fehl wenn alle Werte
  368. fehlschlagen.
  369. </para>
  370. </listitem>
  371. </itemizedlist>
  372. <example id="zend.file.transfer.validators.crc32.example">
  373. <title>Verwenden der Crc32 Prüfung</title>
  374. <programlisting role="php"><![CDATA[
  375. $upload = new Zend_File_Transfer();
  376. // Prüft ob der Inhalt der hochgeladenen Datei den angegebenen Hash hat
  377. $upload->addValidator('Hash', false, '3b3652f');
  378. // Begrenzt diese Prüfung auf zwei unterschiedliche Hashes
  379. $upload->addValidator('Crc32', false, array('3b3652f', 'e612b69'));
  380. ]]></programlisting>
  381. </example>
  382. </sect2>
  383. <sect2 id="zend.file.transfer.validators.excludeextension">
  384. <title>ExcludeExtension Prüfung</title>
  385. <para>
  386. Die <code>ExcludeExtension</code> Prüfung checkt die Dateierweiterung der angegebenen Dateien.
  387. Sie unterstützt die folgenden Optionen:
  388. </para>
  389. <itemizedlist>
  390. <listitem>
  391. <para>
  392. <code>*</code>: Setzt einen beliebigen Schlüssel oder ein nummerisches Array.
  393. Dieser Wert wird verwendet um zu prüfen ob die angegebene Datei diese Dateierweiterung
  394. nicht verwendet.
  395. </para>
  396. </listitem>
  397. <listitem>
  398. <para>
  399. <code>case</code>: Setzt ein Boolean der anzeigt ob die Prüfung auf die
  400. Klein/Großschreibung achten soll. Standardmäßig ist die Klein/Großschreibung egal.
  401. Beachte das dieser Schlüssel für alle vorhandenen Erweiterungen angewendet werden kann.
  402. </para>
  403. </listitem>
  404. </itemizedlist>
  405. <para>
  406. Dieser Prüfer akzeptiert mehrere Erweiterungen entweder als komma-getrennten String, oder als
  407. ein Array. Man kann auch die <code>setExtension()</code>, <code>addExtension()</code> und
  408. <code>getExtension()</code> Methoden verwenden um Erweiterungen zu setzen und zu erhalten.
  409. </para>
  410. <para>
  411. In einigen Fällen ist es nützlich auch auf Klein/Großschreibung zu testen. Deshalb erlaubt
  412. der Constructor einen zweiten Parameter <code>$case</code> der, wenn er auf true gesetzt
  413. wird, die Erweiterungen abhängig von der Klein/Großschreibung prüft.
  414. </para>
  415. <example id="zend.file.transfer.validators.excludeextension.example">
  416. <title>Die ExcludeExtension Prüfung verwenden</title>
  417. <programlisting role="php"><![CDATA[
  418. $upload = new Zend_File_Transfer();
  419. // Dateien mit der Erweiterung php oder exe nicht erlauben
  420. $upload->addValidator('ExcludeExtension', false, 'php,exe');
  421. // Dateien mit der Erweiterung php oder exe nicht erlauben
  422. // aber die Array Schreibweise verwenden
  423. $upload->addValidator('ExcludeExtension', false, array('php', 'exe'));
  424. // Prüft abhängig von der Groß-/Kleinschreibung
  425. $upload->addValidator('ExcludeExtension',
  426. false,
  427. array('php', 'exe', 'case' => true));
  428. ]]></programlisting>
  429. </example>
  430. <note>
  431. <para>
  432. Es ist zu beachten das diese Prüfung nur die Dateierweiterung prüft. Sie prüft nicht
  433. den MIME Typ der Datei.
  434. </para>
  435. </note>
  436. </sect2>
  437. <sect2 id="zend.file.transfer.validators.excludemimetype">
  438. <title>ExcludeMimeType Prüfung</title>
  439. <para>
  440. Die <code>MimeType</code> Prüfung checkt den MIME Typ von übertragenen Dateien. Sie unterstützt
  441. die folgenden Optionen:
  442. </para>
  443. <itemizedlist>
  444. <listitem>
  445. <para>
  446. <code>*</code>: Setzt einen beliebigen Schlüssel oder ein nummerisches Array.
  447. Setzt den MIME Typ gegen den geprüft werden soll.
  448. </para>
  449. <para>
  450. Mit dieser Option kann der MIME Typ von Dateien definiert werden die nicht akzeptiert werden.
  451. </para>
  452. </listitem>
  453. </itemizedlist>
  454. <para>
  455. Diese Prüfung akzeptiert viele MIME Typ entweder als Komma-getrennter String, oder als
  456. Array. Man kan auch die Methoden <code>setMimeType()</code>, <code>addMimeType()</code>,
  457. und <code>getMimeType()</code> verwenden um MIME Typen zu setzen und zu erhalten.
  458. </para>
  459. <example id="zend.file.transfer.validators.excludemimetype.example">
  460. <title>Verwendung der ExcludeMimeType Prüfung</title>
  461. <programlisting role="php"><![CDATA[
  462. $upload = new Zend_File_Transfer();
  463. // Verweigert den MIME Typ gif für alle gegebenen Dateien
  464. $upload->addValidator('ExcludeMimeType', 'image/gif');
  465. // Verweigert den MIME Typ gif und jpeg für alle gegebenen Dateien
  466. $upload->setValidator('ExcludeMimeType', array('image/gif',
  467. 'image/jpeg');
  468. // Verweigert die MIME Typ Gruppe image für alle Dateien
  469. $upload->setValidator('ExcludeMimeType', 'image');
  470. ]]></programlisting>
  471. </example>
  472. <para>
  473. Das obige Beispiel zeigt das es auch möglich ist Gruppen von MIME Typen zu verweigern.
  474. Um, zum Beispiel, alle Bilder zu verweigern, muß nur 'image' als MIME Typ verwendet werden.
  475. Das kann für alle Gruppen von MIME Typen wie 'image', 'audio', 'video', 'test', und so weiter
  476. verwendet werden.
  477. </para>
  478. <note>
  479. <para>
  480. Es ist zu beachten das bei Verwendung von MIME Typ-Gruppen alle Mitglieder dieser Gruppe
  481. verweigert werden, selbst wenn das nicht gewünscht ist. Wenn man 'image' verweigert,
  482. werden alle Typen von Bildern verweigert wie 'image/jpeg' oder 'image/vasa'. Wenn man
  483. nicht sicher ist ob man alle Typen verweigern will sollte man nur
  484. definierte MIME Typen zu verweigern statt der kompletten Gruppe.
  485. </para>
  486. </note>
  487. </sect2>
  488. <sect2 id="zend.file.transfer.validators.exists">
  489. <title>Exists Prüfung</title>
  490. <para>
  491. Die <code>Exists</code> Prüfung checkt ob Dateien die spezifiziert werden existieren. Sie unterstützt
  492. die folgenden Optionen:
  493. </para>
  494. <itemizedlist>
  495. <listitem>
  496. <para>
  497. <code>*</code>: Setzt einen beliebigen Schlüssel oder ein nummerisches Array um zu prüfen
  498. ob die spezifizierte Datei im gegebenen Verzeichnis existiert.
  499. </para>
  500. </listitem>
  501. </itemizedlist>
  502. <para>
  503. Diese Prüfung akzeptiert mehrere Verzeichnisse, entweder als Komma-getrennter String, oder als
  504. Array. Es können aber auch die Methoden <code>setDirectory()</code>, <code>addDirectory()</code>,
  505. und <code>getDirectory()</code> verwendet werden um die Verzeichnisse zu setzen und zu erhalten.
  506. </para>
  507. <example id="zend.file.transfer.validators.exists.example">
  508. <title>Die Exists Prüfung verwenden</title>
  509. <programlisting role="php"><![CDATA[
  510. $upload = new Zend_File_Transfer();
  511. // Das temporäre Verzeichnis für die Prüfung hinzufügen
  512. $upload->addValidator('Exists', false, '\temp');
  513. // Zwei Verzeichnisse hinzufügen indem die Array Schreibweise verwendet wird
  514. $upload->addValidator('Exists',
  515. false,
  516. array('\home\images', '\home\uploads'));
  517. ]]></programlisting>
  518. </example>
  519. <note>
  520. <para>
  521. Beachte das diese Prüfung checkt ob die spezifizierte Datei in allen angegebenen Verzeichnissen
  522. existiert. Die Prüfung schlägt fehl, wenn die Datei in irgendeinem der angegebenen
  523. Verzeichnisse nicht existiert.
  524. </para>
  525. </note>
  526. </sect2>
  527. <sect2 id="zend.file.transfer.validators.extension">
  528. <title>Extension Prüfung</title>
  529. <para>
  530. Die <code>Extension</code> Prüfung checkt die Dateierweiterung der angegebenen Dateien.
  531. Sie unterstützt die folgenden Optionen:
  532. </para>
  533. <itemizedlist>
  534. <listitem>
  535. <para>
  536. <code>*</code>: Setzt einen beliebigen Schlüssel oder ein nummerisches Array um zu prüfen
  537. ob die angegebene Datei diese Dateierweiterung verwendet.
  538. </para>
  539. </listitem>
  540. <listitem>
  541. <para>
  542. <code>case</code>: Definiert of die Prüfung auf die Klein/Großschreibung achten soll.
  543. Standardmäßig ist die Klein/Großschreibung egal. Es ist zu beachten das dieser Schlüssel
  544. für alle verwendeten Erweiterungen angegeben wird.
  545. </para>
  546. </listitem>
  547. </itemizedlist>
  548. <para>
  549. Dieser Prüfer akzeptiert mehrere Erweiterungen entweder als komma-getrennten String, oder als
  550. ein Array. Man kann auch die <code>setExtension()</code>, <code>addExtension()</code> und
  551. <code>getExtension()</code> Methoden verwenden um Erweiterungs Werte zu setzen und zu erhalten.
  552. </para>
  553. <para>
  554. In einigen Fällen ist es nützlich auch auf Klein/Großschreibung zu testen. Hierfür nimmt
  555. der Constructor einen zweiten Parameter <code>$case</code> der, wenn er auf true gesetzt
  556. wird, die Erweiterungen abhängig von der Klein/Großschreibung prüft.
  557. </para>
  558. <example id="zend.file.transfer.validators.extension.example">
  559. <title>Verwendung der Extension Prüfung</title>
  560. <programlisting role="php"><![CDATA[
  561. $upload = new Zend_File_Transfer();
  562. // Limitiert die Erweiterungen auf jpg und png Dateien
  563. $upload->addValidator('Extension', false, 'jpg,png');
  564. // Limitiert die Erweiterungen auf jpg und png Dateien,
  565. // verwendet aber die Array Schreibweise
  566. $upload->addValidator('Extension', false, array('jpg', 'png'));
  567. // Abhängig von der Klein/Großschreibung prüfen
  568. $upload->addValidator('Extension', false, array('mo', 'png', 'case' => true));
  569. if (!$upload->isValid('C:\temp\myfile.MO')) {
  570. print 'Nicht gültig da MO und mo Kleinschreibungsmäßig nicht passen';
  571. }
  572. ]]></programlisting>
  573. </example>
  574. <note>
  575. <para>
  576. Es ist zu beachten das diese Prüfung nur die Dateierweiterung prüft. Sie prüft nicht
  577. den MIME Typ der Datei.
  578. </para>
  579. </note>
  580. </sect2>
  581. <sect2 id="zend.file.transfer.validators.filessize">
  582. <title>FilesSize Prüfung</title>
  583. <para>
  584. Die <code>FilesSize</code> Prüfung checkt die komplette Größe aller übertragenen Dateien.
  585. Sie unterstützt die folgenden Optionen:
  586. </para>
  587. <itemizedlist>
  588. <listitem>
  589. <para>
  590. <code>min</code>: Setzt die minimale gemeinsame Dateigröße. Diese Option definiert
  591. die mindeste gemeinsame Größe die übertragen werden soll.
  592. </para>
  593. </listitem>
  594. <listitem>
  595. <para>
  596. <code>max</code>: Setzt die maximale gemeinsame Dateigröße.
  597. </para>
  598. <para>
  599. Diese Option begrenzt die gemeinsame Dateigröße aller Dateien die übertragen werden,
  600. aber nicht die Dateigröße von einzelnen Dateien.
  601. </para>
  602. </listitem>
  603. <listitem>
  604. <para>
  605. <code>bytestring</code>: Definiert ob im Fehlerfall eine Benutzerfreundliche Nummer, oder
  606. die reine Dateigröße zurückgegeben wird.
  607. </para>
  608. <para>
  609. Diese Option definiert ob der Benutzer '10864' oder '10MB' sieht. Der
  610. Standardwert ist true weshalb '10MB' zurückgegeben wird wenn nicht anders angegeben.
  611. </para>
  612. </listitem>
  613. </itemizedlist>
  614. <para>
  615. Diese Prüfung kann auch mit einem String initiiert werden, der dann verwendet wird um die
  616. <code>max</code> Option zu setzen. Man kann auch die Methoden <code>setMin()</code> und
  617. <code>setMax()</code> verwenden um beide Optionen nach den Contrucor zu setzen, zusammen mit
  618. <code>getMin()</code> und <code>getMax()</code> um die Werte zu erhalten die vorher gesetzt wurden.
  619. </para>
  620. <para>
  621. Die Größe selbst wird auch in der SI Schreibweise akzeptiert wie Sie die meisten
  622. Betriebsystemen verwenden. Statt <emphasis role="strong">20000 bytes</emphasis> kann auch
  623. <emphasis role="strong">20kB</emphasis> angeben werden. Alle Einheiten werden mit dem Basiswert
  624. 1024 konvertiert. Die folgenden Einheiten werden akzeptiert: <code>kB</code>, <code>MB</code>,
  625. <code>GB</code>, <code>TB</code>, <code>PB</code> und <code>EB</code>. Beachte das 1kB gleich
  626. 1024 Bytes ist, 1MB gleich 1024kB, und so weiter.
  627. </para>
  628. <example id="zend.file.transfer.validators.filessize.example">
  629. <title>Verwenden der FilesSize Prüfung</title>
  630. <programlisting role="php"><![CDATA[
  631. $upload = new Zend_File_Transfer();
  632. // Limitiert die Größe aller Dateien die hochgeladen werden auf 40000 Bytes
  633. $upload->addValidator('FilesSize', false, 40000);
  634. // Limitiert die Größe aller Dateien die hochgeladen
  635. // werden auf maximal 4MB und minimal 10kB
  636. $upload->addValidator('FilesSize',
  637. false,
  638. array('min' => '10kB', 'max' => '4MB'));
  639. // Wie zuvor, gibt aber die reine Dateigröße
  640. // statt einem benutzerfreundlichen String zurück
  641. $upload->addValidator('FilesSize',
  642. false,
  643. array('min' => '10kB',
  644. 'max' => '4MB',
  645. 'bytestring' => false));
  646. ]]></programlisting>
  647. </example>
  648. <note>
  649. <para>
  650. Beachte das diese Prüfung intern die Dateigrößen der geprüften Dateien intern
  651. speichert. Die Datei welche die Größe überschreitet wird als Fehler zurückgegeben.
  652. </para>
  653. </note>
  654. </sect2>
  655. <sect2 id="zend.file.transfer.validators.imagesize">
  656. <title>ImageSize Prüfung</title>
  657. <para>
  658. Die <code>ImageSize</code> Prüfung checkt die Größe von Bildern. Sie unterstützt die folgenden
  659. Optionen:
  660. </para>
  661. <itemizedlist>
  662. <listitem>
  663. <para>
  664. <code>minheight</code>: Setzt die mindeste Höhe des Bildes.
  665. </para>
  666. </listitem>
  667. <listitem>
  668. <para>
  669. <code>maxheight</code>: Settzt die maximale Höhe des Bildes.
  670. </para>
  671. </listitem>
  672. <listitem>
  673. <para>
  674. <code>minwidth</code>: Setzt die mindeste Breite des Bildes.
  675. </para>
  676. </listitem>
  677. <listitem>
  678. <para>
  679. <code>maxwidth</code>: Setzt die maximale Breite des Bildes.
  680. </para>
  681. </listitem>
  682. </itemizedlist>
  683. <para>
  684. Die Methoden <code>setImageMin()</code> und <code>setImageMax()</code> setzen auch
  685. beide Minimal- und Maximalwerte im Nachhinein, wärend die <code>getMin()</code> und
  686. <code>getMax()</code> Methoden die aktuell gesetzten Werte zurückgeben.
  687. </para>
  688. <para>
  689. Der Bequemlichkeit halber gibt es auch eine <code>setImageWidth</code> und <code>setImageHeight</code>
  690. Methode welche die Mindest- und Maximalhöhe und -Breite der Bilddatei setzen. Sie haben auch
  691. passende <code>getImageWidth</code> und <code>getImageHeight</code> Methoden um die aktuell
  692. gesetzten Werte zu erhalten.
  693. </para>
  694. <para>
  695. Um die Prüfung einer betreffenden Dimension zu gestatten, muß die relevante Option einfach
  696. nicht gesetzt werden.
  697. </para>
  698. <example id="zend.file.transfer.validators.imagesize.example">
  699. <title>Verwendung der ImageSize Prüfung</title>
  700. <programlisting role="php"><![CDATA[
  701. $upload = new Zend_File_Transfer();
  702. // Begrenzt die Größe eines Bildes auf eine Höhe von 100-200
  703. // und eine Breite von 40-80 Pixel
  704. $upload->addValidator('ImageSize', false,
  705. array('minwidth' => 40,
  706. 'maxwidth' => 80,
  707. 'minheight' => 100,
  708. 'maxheight' => 200
  709. );
  710. // Resetiert die Breite der Prüfung
  711. $upload->setImageWidth(array('minwidth' => 20, 'maxwidth' => 200));
  712. ]]></programlisting>
  713. </example>
  714. </sect2>
  715. <sect2 id="zend.file.transfer.validators.iscompressed">
  716. <title>IsCompressed Prüfung</title>
  717. <para>
  718. Die <code>IsCompressed</code> Prüfung checkt ob eine übertragene Datei komprimiert ist wie zum
  719. Beispiel Zip oder Arc. Diese Prüfung basiert auf der <code>MimeType</code> Prüfung und unterstützt
  720. die gleichen Methoden und Optionen. Diese Prüfung kann mit den dort beschriebenen Methoden auf
  721. gewünschte Komprimierungstypen limitiert werden.
  722. </para>
  723. <example id="zend.file.transfer.validators.iscompressed.example">
  724. <title>Verwenden der IsCompressed Prüfung</title>
  725. <programlisting role="php"><![CDATA[
  726. $upload = new Zend_File_Transfer();
  727. // Checkt ob die hochgeladene Datei komprimiert ist
  728. $upload->addValidator('IsCompressed', false);
  729. // Limitiert diese Prüfung auf Zip Dateien
  730. $upload->addValidator('IsCompressed', false, array('application/zip'));
  731. // Limitiert diese Prüfung auf Zip Dateien,
  732. // und verwendet eine einfachere Schreibweise
  733. $upload->addValidator('IsCompressed', false, 'zip');
  734. ]]></programlisting>
  735. </example>
  736. <note>
  737. <para>
  738. Es ist zu beachten das nicht geprüft wird ob ein gesetzter MIME Typ ein Komprimierungstyp ist
  739. oder nicht. Man könnte zum Beispiel definieren das Gif Dateien von dieser Prüfung akzeptiert
  740. werden. Die Verwendung der 'MimeType' Prüfung für Dateien welche nicht archiviert sind,
  741. führt zu besser lesbarem Code.
  742. </para>
  743. </note>
  744. </sect2>
  745. <sect2 id="zend.file.transfer.validators.isimage">
  746. <title>IsImage Prüfung</title>
  747. <para>
  748. Die <code>IsImage</code> Prüfung checkt ob eine übertragene Datei eine Bilddatei ist, wie zum
  749. Beispiel Gif oder Jpeg. Diese Prüfung basiert auf der <code>MimeType</code> Prüfung und unterstützt
  750. die gleichen Methoden und Optionen. Diese Prüfung kann mit den dort beschriebenen Methoden auf
  751. gewünschte Bildarten limitiert werden.
  752. </para>
  753. <example id="zend.file.transfer.validators.isimage.example">
  754. <title>Verwenden der IsImage Prüfung</title>
  755. <programlisting role="php"><![CDATA[
  756. $upload = new Zend_File_Transfer();
  757. // Checkt ob die hochgeladene Datei ein Bild ist
  758. $upload->addValidator('IsImage', false);
  759. // Limitiert diese Prüfung auf Gif Dateien
  760. $upload->addValidator('IsImage', false, array('application/gif'));
  761. // Limitiert diese Prüfung auf Jpeg Dateien,
  762. // verwendet eine einfachere Schreibweise
  763. $upload->addValidator('IsImage', false, 'jpeg');
  764. ]]></programlisting>
  765. </example>
  766. <note>
  767. <para>
  768. Es ist zu beachten das nicht geprüft wird ob ein gesetzter MIME Typ kein Bild ist.
  769. Es ist zum Beispiel möglich, Zip Dateien von dieser Prüfung akzeptieren zu lassen.
  770. Die Verwendung der 'MimeType' Prüfung für Dateien welche keine Bilder sind, führt zu
  771. besser lesbarem Code.
  772. </para>
  773. </note>
  774. </sect2>
  775. <sect2 id="zend.file.transfer.validators.hash">
  776. <title>Hash Prüfung</title>
  777. <para>
  778. Die <code>Hash</code> Prüfung checkt den Inhalt einer übertragenen Datei indem Sie gehasht wird.
  779. Diese Prüfung verwendet die Hash Erweiterung von PHP. Sie unterstützt die folgenden Optionen:
  780. </para>
  781. <itemizedlist>
  782. <listitem>
  783. <para>
  784. <code>*</code>: Nimmt einen beliebigen Schlüssel oder ein nummerisches Array.
  785. Setzt den Hash gegen den geprüft werden soll.
  786. </para>
  787. <para>
  788. Man kann mehrere Hashes setzen indem Sie als Array angegeben werden. Jede Datei wird
  789. geprüft, und die Prüfung wird nur fehlschlagen wenn alle Dateien die Prüfung nicht
  790. bestehen.
  791. </para>
  792. </listitem>
  793. <listitem>
  794. <para>
  795. <code>algorithm</code>: Setzt den Algorithmus der für das Hashen des Inhalts verwendet
  796. wird.
  797. </para>
  798. <para>
  799. Man kann mehrere Algorithmen setzen indem die <code>addHash()</code> Methode mehrere
  800. Male aufgerufen wird.
  801. </para>
  802. </listitem>
  803. </itemizedlist>
  804. <example id="zend.file.transfer.validators.hash.example">
  805. <title>Verwenden der Hash Prüfung</title>
  806. <programlisting role="php"><![CDATA[
  807. $upload = new Zend_File_Transfer();
  808. // Prüft ob der Inhalt der hochgeladenen Datei den angegebenen Hash enthält
  809. $upload->addValidator('Hash', false, '3b3652f');
  810. // Begrenzt diese Prüfung auf zwei unterschiedliche Hashes
  811. $upload->addValidator('Hash', false, array('3b3652f', 'e612b69'));
  812. // Setzt einen anderen Algorithmus gegen den geprüft wird
  813. $upload->addValidator('Hash',
  814. false,
  815. array('315b3cd8273d44912a7',
  816. 'algorithm' => 'md5'));
  817. ]]></programlisting>
  818. </example>
  819. <note>
  820. <para>
  821. Diese Prüfung unterstützt über 34 verschiedene Hash Algorithmen. Die bekanntesten sind
  822. 'crc32', 'md5' und 'sha1'. Eine gesammelte Liste aller unterstützten Hash Algorithmen kann in
  823. PHP's <ulink url="http://php.net/hash_algos">hash_algos Methode</ulink> auf der
  824. <ulink url="http://php.net">php.net Seite</ulink> gefunden werden.
  825. </para>
  826. </note>
  827. </sect2>
  828. <sect2 id="zend.file.transfer.validators.md5">
  829. <title>Md5 Prüfung</title>
  830. <para>
  831. Die <code>Md5</code> Prüfung checkt den Inhalt einer übertragenen Datei durch hashen. Diese
  832. Prüfung verwendet die Hash Erweiterung von PHP mit dem Md5 Algorithmus. Sie unterstützt die
  833. folgenden Optionen:
  834. </para>
  835. <itemizedlist>
  836. <listitem>
  837. <para>
  838. <code>*</code>: nimmt einen beliebigen Schlüssel oder ein nummerisches Array.
  839. </para>
  840. <para>
  841. Man kann mehrere Hashes setzen indem Sie als Array übergeben werden. Jede Datei wird
  842. geprüft und die Prüfung schlägt nur dann fehl wenn die Prüfung alle Dateien fehlschlägt.
  843. </para>
  844. </listitem>
  845. </itemizedlist>
  846. <example id="zend.file.transfer.validators.md5.example">
  847. <title>Verwenden der Md5 Prüfung</title>
  848. <programlisting role="php"><![CDATA[
  849. $upload = new Zend_File_Transfer();
  850. // Prüft ob der Inhalt der hochgeladenen Datei den angegebenen Hash hat
  851. $upload->addValidator('Md5', false, '3b3652f336522365223');
  852. // Begrenzt diese Prüfung auf zwei unterschiedliche Hashes
  853. $upload->addValidator('Md5',
  854. false,
  855. array('3b3652f336522365223',
  856. 'eb3365f3365ddc65365'));
  857. ]]></programlisting>
  858. </example>
  859. </sect2>
  860. <sect2 id="zend.file.transfer.validators.mimetype">
  861. <title>MimeType Prüfung</title>
  862. <para>
  863. Die <code>MimeType</code> Prüfung checkt den Mimetyp von übertragenen Dateien. Sie unterstützt
  864. die folgenden Optionen:
  865. </para>
  866. <itemizedlist>
  867. <listitem>
  868. <para>
  869. <code>*</code>: Setzt einen beliebigen Schlüssel oder ein nummerisches Array.
  870. Setzt die Art des MIME Typs der geprüft werden soll.
  871. </para>
  872. <para>
  873. Definiert den MIME Typ von Dateien die akzeptiert werden soll.
  874. </para>
  875. </listitem>
  876. <listitem>
  877. <para>
  878. <code>magicfile</code>: Das Magicfile das verwendet werden soll.
  879. </para>
  880. <para>
  881. Mit dieser Option kann definiert werden welches Magicfile zu verwenden ist. Wenn es nicht
  882. gesetzt wird, oder leer ist, wird stattdessen die MAGIC Konstante verwendet. Diese
  883. Option ist seit dem Zend Framework 1.7.1 vorhanden.
  884. </para>
  885. </listitem>
  886. </itemizedlist>
  887. <para>
  888. Diese Prüfung akzeptiert viele MIME Typen entweder als Komma-getrennter String, oder als
  889. Array. Man kan auch die Methoden <code>setMimeType()</code>, <code>addMimeType()</code>,
  890. und <code>getMimeType()</code> verwenden um MIME Typen zu setzen und zu erhalten.
  891. </para>
  892. <para>
  893. Man kann mit der 'magicfile' Option auch die Magicdatei setzen die von Fileinfo verwendet
  894. werden soll. Zusätzlich gibt es die komfortablen <code>setMagicFile()</code> und
  895. <code>getMagicFile()</code> Methoden die das spätere Setzen und Empfangen des Magicfile
  896. Parameters erlauben. Diese Methoden sind seit dem Zend Framework 1.7.1 vorhanden.
  897. </para>
  898. <example id="zend.file.transfer.validators.mimetype.example">
  899. <title>Verwendung der MimeType Prüfung</title>
  900. <programlisting role="php"><![CDATA[
  901. $upload = new Zend_File_Transfer();
  902. // Begrenzt den MIME Typ aller gegebenen Dateien auf Gif Bilder
  903. $upload->addValidator('MimeType', 'image/gif');
  904. // Begrenzt den MIME Typ alle gegebenen Dateien auf Gif und Jpeg Dateien
  905. $upload->addValidator('MimeType', array('image/gif', 'image/jpeg');
  906. // Begrenzt den MIME Typ aller Dateien auf die Gruppe image
  907. $upload->addValidator('MimeType', 'image');
  908. // Ein anderes magicfile verwenden
  909. $upload->addValidator('MimeType',
  910. false,
  911. array('image',
  912. 'magicfile' => '/path/to/magicfile.mgx'));
  913. ]]></programlisting>
  914. </example>
  915. <para>
  916. Das obige Beispiel zeigt das es auch möglich ist den akzeptierten MIME Typ auf eine Gruppe von
  917. MIME Typen zu begrenzen. Um alle Bilder zu erlauben kann einfach 'image' als MIME Typ verwendet
  918. werden. Das kann für alle Gruppen von MIME Typen wie 'image', 'audio', 'video', 'test', und so
  919. weiter gemacht werden.
  920. </para>
  921. <note>
  922. <para>
  923. Es ist zu beachten das die Verwendung von MIME Typ-Gruppen alle Mitglieder dieser Gruppe
  924. akzeptiert, selbst wenn die Anwendung diese nicht unterstützt. Wenn man 'image' erlaubt,
  925. erhält man auch 'image/xpixmap' oder 'image/vasa' was problematisch sein könnte. Wenn man
  926. nicht sicher ist ob die eigene Anwendung alle Typen unterstützt ist es besser nur
  927. definierte MIME Typen zu erlauben statt der kompletten Gruppe.
  928. </para>
  929. </note>
  930. <note>
  931. <para>
  932. Diese Komponente verwendet die <code>fileinfo</code> Erweiterung wenn Sie vorhanden ist.
  933. Wenn nicht wird Sie die <code>mime_content_type</code> Funktion verwenden. Und wenn dieser
  934. Funktionsaufruf fehlschlägt wird der MIME Typ verwendet der von HTTP angegeben wurde.
  935. </para>
  936. <para>
  937. Man sollte sich vor möglichen Sicherheitsproblemen vorsehen wenn weder <code>fileinfo</code>
  938. noch <code>mime_content_type</code> vorhanden sind. Der von HTTP angegebene MIME Typ ist nicht
  939. sicher und kann einfach manipuliert werden.
  940. </para>
  941. </note>
  942. </sect2>
  943. <sect2 id="zend.file.transfer.validators.notexists">
  944. <title>NotExists Prüfung</title>
  945. <para>
  946. Die <code>NotExists</code> Prüfung checkt ob Dateien die angegeben werden existieren. Sie unterstützt
  947. die folgenden Optionen:
  948. </para>
  949. <itemizedlist>
  950. <listitem>
  951. <para>
  952. <code>*</code>: Setzt einen beliebigen Schlüssel oder ein nummerisches Array.
  953. Checkt ob die Datei im gegebenen Verzeichnis existiert.
  954. </para>
  955. </listitem>
  956. </itemizedlist>
  957. <para>
  958. Diese Prüfung akzeptiert mehrere Verzeichnisse, entweder als Komma-getrennter String, oder als
  959. Array. Es können aber auch die Methoden <code>setDirectory()</code>, <code>addDirectory()</code>,
  960. und <code>getDirectory()</code> verwendet werden um die Verzeichnisse zu setzen und zu erhalten.
  961. </para>
  962. <example id="zend.file.transfer.validators.notexists.example">
  963. <title>Verwendung der NotExists Prüfung</title>
  964. <programlisting role="php"><![CDATA[
  965. $upload = new Zend_File_Transfer();
  966. // Das temporäre Verzeichnis für die Prüfung hinzufügen
  967. $upload->addValidator('NotExists', '\temp');
  968. // Zwei Verzeichnisse durch Verwendung der Array Schreibweise hinzufügen
  969. $upload->addValidator('NotExists',
  970. array('\home\images',
  971. '\home\uploads')
  972. );
  973. ]]></programlisting>
  974. </example>
  975. <note>
  976. <para>
  977. Beachte das diese Prüfung checkt ob die Datei in allen angegebenen Verzeichnissen nicht
  978. existiert. Die Prüfung schlägt fehl, wenn die Datei in irgendeinem der angegebenen Verzeichnisse
  979. existiert.
  980. </para>
  981. </note>
  982. </sect2>
  983. <sect2 id="zend.file.transfer.validators.sha1">
  984. <title>Sha1 Prüfung</title>
  985. <para>
  986. Die <code>Sha1</code> Prüfung checkt den Inhalt einer übertragenen Datei durch hashen. Diese
  987. Prüfung verwendet die Hash Erweiterung von PHP mit dem Sha1 Algorithmus. Sie unterstützt die
  988. folgenden Optionen:
  989. </para>
  990. <itemizedlist>
  991. <listitem>
  992. <para>
  993. <code>*</code>: Nimmt einen beliebigen Schlüssel oder ein nummerisches Array.
  994. </para>
  995. <para>
  996. Man kann mehrere Hashes setzen indem Sie als Array übergeben werden. Jeder Datei wird
  997. geprüft und die Prüfung schlägt nur dann fehl wenn alle Dateien fehlschlagen.
  998. </para>
  999. </listitem>
  1000. </itemizedlist>
  1001. <example id="zend.file.transfer.validators.sha1.example">
  1002. <title>Verwenden der Sha1 Prüfung</title>
  1003. <programlisting role="php"><![CDATA[
  1004. $upload = new Zend_File_Transfer();
  1005. // Prüft ob der Inhalt der hochgeladenen Datei den angegebenen Hash hat
  1006. $upload->addValidator('Sha1', false, '3b3652f336522365223');
  1007. // Begrenzt diese Prüfung auf zwei unterschiedliche Hashes
  1008. $upload->addValidator('Sha1',
  1009. false, array('3b3652f336522365223',
  1010. 'eb3365f3365ddc65365'));
  1011. ]]></programlisting>
  1012. </example>
  1013. </sect2>
  1014. <sect2 id="zend.file.transfer.validators.size">
  1015. <title>Size Prüfung</title>
  1016. <para>
  1017. Die <code>Size</code> Prüfung checkt die Größe von einzelnen Dateien. Sie unterstützt die
  1018. folgenden Optionen:
  1019. </para>
  1020. <itemizedlist>
  1021. <listitem>
  1022. <para>
  1023. <code>min</code>: Setzt die minimale Dateigröße.
  1024. </para>
  1025. </listitem>
  1026. <listitem>
  1027. <para>
  1028. <code>max</code>: Setzt die maximale Dateigröße.
  1029. </para>
  1030. </listitem>
  1031. <listitem>
  1032. <para>
  1033. <code>bytestring</code>: Definiert ob ein Fehler mit einer Benutzerfreundlichen Nummer
  1034. zurückgegeben wird, oder mit der reinen Dateigröße.
  1035. </para>
  1036. <para>
  1037. Mit dieser Option kann definiert werden ob der Benutzer '10864' oder '10MB' erhält.
  1038. Der Standardwert ist true was '10MB' zurückgibt.
  1039. </para>
  1040. </listitem>
  1041. </itemizedlist>
  1042. <para>
  1043. Man kann diese Prüfung auch nur mit einem String initialisieren, der dann verwendet wird um die
  1044. <code>max</code> Option zu setzen. Man kann auch die Methoden <code>setMin()</code> und
  1045. <code>setMax()</code> verwenden um beide Optionen nach der Instanziierung setzen, zusammen mit
  1046. <code>getMin()</code> und <code>getMax()</code> um die Werte zu setzen die vorher gesetzt wurden.
  1047. </para>
  1048. <para>
  1049. Die Größe selbst wird auch in der SI Schreibweise akzeptiert wie Sie von den meisten
  1050. Betriebsystemen verwendet wird. Statt <emphasis role="strong">20000 bytes</emphasis> kann man auch
  1051. <emphasis role="strong">20kB</emphasis> angeben. Alle Einheiten werden konvertiert wobei 1024 als
  1052. Basiswert verwendet wird. Die folgenden Einheiten werden akzeptiert: <code>kB</code>, <code>MB</code>,
  1053. <code>GB</code>, <code>TB</code>, <code>PB</code> und <code>EB</code>. Beachte das 1kB identisch
  1054. mit 1024 Bytes ist, 1MB identisch mit 1024kB ist, und so weiter.
  1055. </para>
  1056. <example id="zend.file.transfer.validators.size.example">
  1057. <title>Verwendung der Size Prüfung</title>
  1058. <programlisting role="php"><![CDATA[
  1059. $upload = new Zend_File_Transfer();
  1060. // Limitiert die Größe einer Datei auf 40000 Bytes
  1061. $upload->addValidator('Size', false, 40000);
  1062. // Limitiert die Größe der angegebenen Datei auf maximal 4MB und minimal 10kB
  1063. // Gibt auch im Fall eines Fehlers die reine Zahl statt einer
  1064. // Benutzerfreundlichen zurück
  1065. $upload->addValidator('Size',
  1066. false,
  1067. array('min' => '10kB',
  1068. 'max' => '4MB',
  1069. 'bytestring' => false));
  1070. ]]></programlisting>
  1071. </example>
  1072. </sect2>
  1073. <sect2 id="zend.file.transfer.validators.wordcount">
  1074. <title>WordCount Prüfung</title>
  1075. <para>
  1076. Die <code>WordCount</code> Prüfung checkt die Anzahl von Wörtern in angegebenen Dateien. Sie
  1077. Unterstützt die folgenden Optionen:
  1078. </para>
  1079. <itemizedlist>
  1080. <listitem>
  1081. <para>
  1082. <code>min</code>: Setzt die mindeste Anzahl an Wörtern die gefunden werden soll.
  1083. </para>
  1084. </listitem>
  1085. <listitem>
  1086. <para>
  1087. <code>max</code>: Setzt die maximale Anzahl an Wörtern die gefunden werden soll.
  1088. </para>
  1089. </listitem>
  1090. </itemizedlist>
  1091. <para>
  1092. Wenn man diese Prüfung mit einem String oder Integer initiiert, wird der Wert als
  1093. <code>max</code> verwendet. Oder man verwendet die <code>setMin()</code> und <code>setMax()</code>
  1094. Methoden um beide Optionen im Nachhinein zu setzen und <code>getMin()</code> sowie
  1095. <code>getMax()</code> um die aktuell gesetzten Werte zu erhalten.
  1096. </para>
  1097. <example id="zend.file.transfer.validators.wordcount.example">
  1098. <title>Verwendung der WordCount Prüfung</title>
  1099. <programlisting role="php"><![CDATA[
  1100. $upload = new Zend_File_Transfer();
  1101. // Begrenzt die Anzahl der Wörter in Dateien auf maximal 2000
  1102. $upload->addValidator('WordCount', false, 2000);
  1103. // Begrenzt die Anzahl der Wörter in Dateien auf maximal 5000
  1104. // und mindestens 1000 Wörter
  1105. $upload->addValidator('WordCount', false, array('min' => 1000, 'max' => 5000));
  1106. ]]></programlisting>
  1107. </example>
  1108. </sect2>
  1109. </sect1>
  1110. <!--
  1111. vim:se ts=4 sw=4 tw=80 et:
  1112. -->