Zend_File_Transfer-Validators.xml 58 KB

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