Zend_File_Transfer-Validators.xml 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24623 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.file.transfer.validators">
  5. <title>Validateurs pour Zend_File_Transfer</title>
  6. <para>
  7. <classname>Zend_File_Transfer</classname> est fourni avec de multiples validateurs
  8. liés qui doivent être utiliser pour accroître la sécurité et prévenir les attaques
  9. possibles. Notez que les validateurs ne sont bons que si vous les utilisez. Tous les
  10. validateurs qui sont fournis avec <classname>Zend_File_Transfer</classname> peuvent être
  11. trouvés avec le composant <classname>Zend_Validator</classname> et sont nommés
  12. <classname>Zend_Validate_File_*</classname>. Les validateurs suivants sont actuellement
  13. disponibles&#160;:
  14. </para>
  15. <itemizedlist>
  16. <listitem>
  17. <para>
  18. <code>Count</code>&#160;: ce validateur vérifie le nombre de fichiers. Il est
  19. possible de définir un minimum et un maximum et une erreur sera lancée s'ils sont
  20. dépassés.
  21. </para>
  22. </listitem>
  23. <listitem>
  24. <para>
  25. <code>Crc32</code>&#160;: ce validateur vérifie la valeur de hachage crc32 du
  26. contenu d'un fichier. Il est basé sur le validateur <code>Hash</code> et en
  27. simplifiant son utilisation par le support unique du Crc32.
  28. </para>
  29. </listitem>
  30. <listitem>
  31. <para>
  32. <code>ExcludeExtension</code>&#160;: ce validateur vérifie l'extension des
  33. fichiers. Il lancera une erreur quand un fichier aura une extension non souhaitée.
  34. Ainsi vous pouvez empêcher la validation de certaines extensions.
  35. </para>
  36. </listitem>
  37. <listitem>
  38. <para>
  39. <code>ExcludeMimeType</code>&#160;: ce validateur vérifie le type <acronym>MIME</acronym> des
  40. fichiers. Il est aussi capable de valider un groupe de type <acronym>MIME</acronym> et générera une
  41. erreur quand le type <acronym>MIME</acronym> d'un fichier donné correspond.
  42. </para>
  43. </listitem>
  44. <listitem>
  45. <para>
  46. <code>Exists</code>&#160;: ce validateur vérifie l'existence des fichiers. Il
  47. lancera une erreur quand un fichier n'existera pas.
  48. </para>
  49. </listitem>
  50. <listitem>
  51. <para>
  52. <code>Extension</code>&#160;: ce validateur vérifie l'extension des fichiers. Il
  53. lancera une erreur quand un fichier n'aura pas l'extension définie.
  54. </para>
  55. </listitem>
  56. <listitem>
  57. <para>
  58. <code>FilesSize</code>&#160;: ce validateur vérifie la taille complète de tous les
  59. fichiers à valider. Il conserve en mémoire la taille de tous les fichiers chargés et
  60. lance une erreur quand la somme de tous les fichiers dépasse la taille définie. Il
  61. est aussi possible de définir une taille minimum et maximum.
  62. </para>
  63. </listitem>
  64. <listitem>
  65. <para>
  66. <code>ImageSize</code>&#160;: ce validateur vérifie la taille des images. Il valide
  67. la largeur et la hauteur et permet de paramétrer à la fois une valeur minimum et
  68. maximum.
  69. </para>
  70. </listitem>
  71. <listitem>
  72. <para>
  73. <code>IsCompressed</code>&#160;: ce validateur vérifie si le fichier est compressé.
  74. Il est basé sur le validateur <code>MimeType</code> et valide les archives
  75. compressées comme zip ou arc. Vous pouvez aussi limiter à des types d'archives
  76. particuliers.
  77. </para>
  78. </listitem>
  79. <listitem>
  80. <para>
  81. <code>IsImage</code>&#160;: ce validateur vérifie si un fichier est une image. Il
  82. est basé sur le validateur <code>MimeType</code> et valide les images comme jpg ou
  83. gif. Vous pouvez aussi limiter à des types d'images particuliers.
  84. </para>
  85. </listitem>
  86. <listitem>
  87. <para>
  88. <code>Hash</code>&#160;: ce validateur vérifie la valeur de hachage md5 du contenu
  89. d'un fichier. Il supporte de multiples algorithmes.
  90. </para>
  91. </listitem>
  92. <listitem>
  93. <para>
  94. <code>Md5</code>&#160;: ce validateur vérifie la valeur de hachage md5 du contenu
  95. d'un fichier. Il est basé sur le validateur <code>Hash</code> et en simplifiant son
  96. utilisation par le support unique du Md5.
  97. </para>
  98. </listitem>
  99. <listitem>
  100. <para>
  101. <code>MimeType</code>&#160;: ce validateur vérifie le type <acronym>MIME</acronym> des fichiers. Il
  102. est aussi capable de valider des groupes de type <acronym>MIME</acronym> et de générer une erreur quand
  103. le type <acronym>MIME</acronym> d'un fichier donné ne correspond pas.
  104. </para>
  105. </listitem>
  106. <listitem>
  107. <para>
  108. <code>NotExists</code>&#160;: ce validateur vérifie l'existence des fichiers. Il
  109. lancera une erreur quand un fichier existera déjà.
  110. </para>
  111. </listitem>
  112. <listitem>
  113. <para>
  114. <code>Sha1</code>&#160;: ce validateur vérifie la valeur de hachage sha1 du contenu
  115. d'un fichier. Il est basé sur le validateur <code>Hash</code> et en simplifiant son
  116. utilisation par le support unique du Sha1.
  117. </para>
  118. </listitem>
  119. <listitem>
  120. <para>
  121. <code>Size</code>&#160;: ce validateur permet de valider la taille d'un fichier en
  122. particulier. Il est possible de définir un minimum et un maximum et une erreur sera
  123. lancée s'ils sont dépassés.
  124. </para>
  125. </listitem>
  126. <listitem>
  127. <para>
  128. <code>Upload</code>&#160;: ce validateur est interne, il vérifie si l'upload a
  129. produit une erreur. Vous ne devez pas le paramétrer, il est automatiquement activé
  130. par<code> Zend_File_Transfer</code> lui-même. Vous pouvez donc oublier ce
  131. validateur. Il faut juste savoir qu'il existe.
  132. </para>
  133. </listitem>
  134. <listitem>
  135. <para>
  136. <code>WordCount</code>&#160;: ce validateur est capable de vérifier le nombre de
  137. mots à l'intérieur du fichier. Il permet de définir des valeurs minimum et maximum
  138. et émettra une erreur si l'un ou l'autre des seuils est dépassé.
  139. </para>
  140. </listitem>
  141. </itemizedlist>
  142. <sect2 id="zend.file.transfer.validators.usage">
  143. <title>Utiliser les validateurs avec Zend_File_Transfer</title>
  144. <para>
  145. L'utilisation des validateurs est assez simple. Il existe de multiples méthodes
  146. pour ajouter et manipuler les validateurs.
  147. </para>
  148. <itemizedlist>
  149. <listitem>
  150. <para>
  151. <methodname>isValid($files = null)</methodname>&#160;: vérifie le(s) fichier(s) fourni(s)
  152. avec tout le jeu de validateurs paramétrés. <varname>$files</varname> peut être soit
  153. un vrai nom de fichier, soit des noms d'éléments de formulaire ou des noms de
  154. fichiers temporaires.
  155. </para>
  156. </listitem>
  157. <listitem>
  158. <para>
  159. <code>addValidator($validator, $breakChainOnFailure, $options = null,
  160. $files = null)</code>&#160;: ajoute le validateur à la pile des validateurs
  161. (optionnellement seul le(s) fichier(s) spécifié(s)). <varname>$validator</varname>
  162. peut être soit une instance d'un validateur réel, ou un nom court spécifiant le
  163. validateur (par exemple, "Count").
  164. </para>
  165. </listitem>
  166. <listitem>
  167. <para>
  168. <methodname>addValidators(array $validators, $files = null)</methodname>&#160;: ajoute les
  169. validateurs à la pile des validateurs. Chaque entrée peut être soit une paire
  170. type/options, ou un tableau avec la clé "validator" spécifiant le validateur
  171. (tous les autres options seront considérées comme des options du validateur au
  172. moment de l'instanciation).
  173. </para>
  174. </listitem>
  175. <listitem>
  176. <para>
  177. <methodname>setValidators(array $validators, $files = null)</methodname>&#160;: surcharge
  178. les validateurs existants avec les validateurs spécifiés. Les validateurs
  179. doivent respecter la même syntaxe que <methodname>addValidators()</methodname>.
  180. </para>
  181. </listitem>
  182. <listitem>
  183. <para>
  184. <methodname>hasValidator($name)</methodname>&#160;: indique si un validateur est enregistré.
  185. </para>
  186. </listitem>
  187. <listitem>
  188. <para>
  189. <methodname>getValidator($name)</methodname>&#160;: retourne un validateur préalablement
  190. enregistré.
  191. </para>
  192. </listitem>
  193. <listitem>
  194. <para>
  195. <methodname>getValidators($files = null)</methodname>&#160;: retourne les validateurs
  196. enregistrés&#160;; si <varname>$files</varname> est fourni, retourne les validateurs
  197. pour ce fichier en particulier ou pour tous les fichiers.
  198. </para>
  199. </listitem>
  200. <listitem>
  201. <para>
  202. <methodname>removeValidator($name)</methodname>&#160;: enlève le validateur préalablement
  203. enregistré.
  204. </para>
  205. </listitem>
  206. <listitem>
  207. <para><methodname>clearValidators()</methodname>&#160;: efface tous les validateurs.</para>
  208. </listitem>
  209. </itemizedlist>
  210. <example id="zend.file.transfer.validators.usage.example">
  211. <title>Ajouter des validateurs au(x) fichier(s) transféré(s)</title>
  212. <programlisting language="php"><![CDATA[
  213. $upload = new Zend_File_Transfer();
  214. // Paramètre un poids de fichier de 20000 octets
  215. $upload->addValidator('Size', false, 20000);
  216. // Paramètre un poids de fichier de 20 octets minimum
  217. // et de 20000 octets maximum
  218. $upload->addValidator('Size', false, array('min' => 20, 'max' => 20000));
  219. // Paramètre un poids de fichier de 20 octets minimum et
  220. // de 20000 octets maximum et un nombre de fichiers en une seule étape
  221. $upload->setValidators(array(
  222. 'Size' => array('min' => 20, 'max' => 20000),
  223. 'Count' => array('min' => 1, 'max' => 3),
  224. ));
  225. ]]></programlisting>
  226. </example>
  227. <example id="zend.file.transfer.validators.usage.exampletwo">
  228. <title>Limiter les validateurs à des fichiers uniques</title>
  229. <para>
  230. <methodname>addValidator()</methodname>, <methodname>addValidators()</methodname>, et
  231. <methodname>setValidators()</methodname> accepte chacun un argument final <varname>$files</varname>.
  232. Cet argument peut être utilisé pour spécifier un fichier en particulier ou un
  233. tableau de fichiers sur lequel appliqué le validateur donné.
  234. </para>
  235. <programlisting language="php"><![CDATA[
  236. $upload = new Zend_File_Transfer();
  237. // Paramètre un poids de fichier de 20000 octets et
  238. // limite celui-ci à 'file2'
  239. $upload->addValidator('Size', false, 20000, 'file2');
  240. ]]></programlisting>
  241. </example>
  242. <para>
  243. Généralement vous devriez simplement utiliser la méthode
  244. <methodname>addValidators()</methodname>, qui peut être appelée plusieurs fois.
  245. </para>
  246. <example id="zend.file.transfer.validators.usage.examplemultiple">
  247. <title>Ajouter des validateurs multiples</title>
  248. <para>
  249. Souvent il est plus simple d'appeler plusieurs fois
  250. <methodname>addValidator()</methodname>&#160;: un appel pour chaque validateur. Ceci améliore
  251. aussi la lisibilité et rend votre code plus maintenable. Comme toutes les méthodes
  252. fournissent un interface fluide, vous pouvez enchaîner les appels comme montré
  253. ci-dessous&#160;:
  254. </para>
  255. <programlisting language="php"><![CDATA[
  256. $upload = new Zend_File_Transfer();
  257. // Paramètre un poids de fichier de 20000 octets
  258. $upload->addValidator('Size', false, 20000)
  259. ->addValidator('Count', false, 2)
  260. ->addValidator('Filessize', false, 25000);
  261. ]]></programlisting>
  262. </example>
  263. <note>
  264. <para>
  265. Notez que même si l'ajout du même validateur plusieurs fois est autorisé,
  266. faire ceci peut entraîner des problèmes si vous utilisez différentes options pour le
  267. même validateur.
  268. </para>
  269. </note>
  270. <para>
  271. Et pour finir vous pouvez tout simplement vérifier le(s) fichier(s) en appelant
  272. <methodname>isValid()</methodname>.
  273. </para>
  274. <example id="zend.file.transfer.validators.usage.exampleisvalid">
  275. <title>Valider les fichiers</title>
  276. <para>
  277. <methodname>isValid()</methodname> accepte les fichiers uploadés ou télécharger, le nom de
  278. fichier temporaire et bien sûr le nom de l'élément de formulaire. Si aucun paramètre
  279. ou <constant>NULL</constant> est fourni, tous les fichiers seront vérifiés.
  280. </para>
  281. <programlisting language="php"><![CDATA[
  282. $upload = new Zend_File_Transfer();
  283. // Paramètre un poids de fichier de 20000 octets
  284. $upload->addValidator('Size', false, 20000)
  285. ->addValidator('Count', false, 2)
  286. ->addValidator('Filessize', false, 25000);
  287. if (!$upload->isValid()) {
  288. print "Echec de validation";
  289. }
  290. ]]></programlisting>
  291. </example>
  292. <note>
  293. <para>
  294. Notez que <methodname>isValid()</methodname> sera automatiquement appelé quand vous
  295. recevez les fichiers et qu'il n'a pas été appelé auparavant.
  296. </para>
  297. </note>
  298. <para>
  299. Quand une validation a échouée, c'est probablement intéressant d'avoir des
  300. informations sur les problèmes rencontrés. A cette fin, vous pouvez utiliser la méthode
  301. <methodname>getMessages()</methodname> qui retourne tous les messages de validation sous la forme
  302. d'un tableau, <methodname>getErrors()</methodname> qui retourne tous les codes d'erreurs et
  303. <methodname>hasErrors()</methodname> qui retourne <constant>TRUE</constant> dès qu'une erreur de validation
  304. est rencontrée.
  305. </para>
  306. </sect2>
  307. <sect2 id="zend.file.transfer.validators.count">
  308. <title>Validateur Count</title>
  309. <para>
  310. Le validateur <code>Count</code> vérifie le nombre de fichiers fournis. Il
  311. supporte les clés d'options suivantes&#160;:
  312. </para>
  313. <itemizedlist>
  314. <listitem>
  315. <para>
  316. <code>min</code>&#160;: paramètre le nombre minimum de fichiers à
  317. transférer.
  318. </para>
  319. <note>
  320. <para>
  321. Attention&#160;: quand vous utilisez cette option vous devez donner le
  322. nombre minimum au moment où vous appelez ce validateur la première fois ;
  323. sinon vous aurez une erreur en retour.
  324. </para>
  325. </note>
  326. <para>
  327. Avec cette option vous pouvez définir le nombre de fichiers que vous
  328. souhaitez recevoir.
  329. </para>
  330. </listitem>
  331. <listitem>
  332. <para>
  333. <code>max</code>&#160;: paramètre le nombre maximum de fichiers à
  334. transférer.
  335. </para>
  336. <para>
  337. Avec cette option vous pouvez limiter le nombre de fichiers que vous
  338. acceptez mais vous permet aussi de détecter une possible attaque quand plus de
  339. fichiers, que votre formulaire n'en définit, sont fournis.
  340. </para>
  341. </listitem>
  342. </itemizedlist>
  343. <para>
  344. Vous pouvez initialiser ce validateur avec une chaîne ou un entier, la valeur sera
  345. utilisée en tant que <code>max</code>. Mais vous pouvez aussi utiliser les méthodes
  346. <methodname>setMin()</methodname> et <methodname>setMax()</methodname> pour paramétrer ces options plus tard et
  347. <methodname>getMin()</methodname> et <methodname>getMax()</methodname> pour les récupérer.
  348. </para>
  349. <example id="zend.file.transfer.validators.count.example">
  350. <title>Utiliser le validateur Count</title>
  351. <programlisting language="php"><![CDATA[
  352. $upload = new Zend_File_Transfer();
  353. // Limite le nombre de fichiers à 2 maximum
  354. $upload->addValidator('Count', false, 2);
  355. // Limite le nombre de fichiers à 5 maximum,
  356. // tout en obligeant au moins 1 fichier
  357. $upload->addValidator('Count', false, array('min' =>1, 'max' => 5));
  358. ]]></programlisting>
  359. </example>
  360. <note>
  361. <para>
  362. Notez que ce validateur stocke le nombre de fichiers vérifiés en interne. Le
  363. fichier qui excédera le maximum sera retourné en tant qu'erreur.
  364. </para>
  365. </note>
  366. </sect2>
  367. <sect2 id="zend.file.transfer.validators.crc32">
  368. <title>Validateur Crc32</title>
  369. <para>
  370. Le validateur <code>Crc32</code> vérifie le contenu du fichier transféré en le
  371. hachant. Ce validateur utilise l'extension de hachage de <acronym>PHP</acronym> avec l'algorithme crc32. Il
  372. supporte les options suivantes&#160;:
  373. </para>
  374. <itemizedlist>
  375. <listitem>
  376. <para>
  377. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser
  378. un tableau numérique. Les valeurs seront utilisées pour vérifier la valeur de
  379. hachage.
  380. </para>
  381. <para>
  382. Vous pouvez paramétrer de multiples hachages en utilisant différentes
  383. clés. Chacun sera vérifié et seulement si tous échouent, la validation elle-même
  384. échouera.
  385. </para>
  386. </listitem>
  387. </itemizedlist>
  388. <example id="zend.file.transfer.validators.crc32.example">
  389. <title>Utiliser le validateur Crc32</title>
  390. <programlisting language="php"><![CDATA[
  391. $upload = new Zend_File_Transfer();
  392. // Vérifie si le contenu d'un fichier uploadé correspond au hachage fourni
  393. $upload->addValidator('Crc32', false, '3b3652f');
  394. // Limite ce validateur à deux différents hachages
  395. $upload->addValidator('Crc32', false, array('3b3652f', 'e612b69'));
  396. ]]></programlisting>
  397. </example>
  398. </sect2>
  399. <sect2 id="zend.file.transfer.validators.excludeextension">
  400. <title>Validateur ExcludeExtension</title>
  401. <para>
  402. Le validateur <code>ExcludeExtension</code> vérifie l'extension des fichiers
  403. fournis. Il supporte les options suivantes&#160;:
  404. </para>
  405. <itemizedlist>
  406. <listitem>
  407. <para>
  408. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser un
  409. tableau numérique. Les valeurs seront utilisées en tant qu'extensions à vérifier
  410. que le fichier n'utilise pas.
  411. </para>
  412. </listitem>
  413. <listitem>
  414. <para>
  415. <code>case</code>&#160;: paramètre une validation qui tient compte de la casse.
  416. Par défaut, ce n'est pas sensible à la casse. Notez que cette clé est utilisée
  417. pour toutes les extensions.
  418. </para>
  419. </listitem>
  420. </itemizedlist>
  421. <para>
  422. Ce validateur accepte des extensions multiples soit sous la forme d'une chaîne
  423. utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau.
  424. Vous pouvez aussi utiliser les méthodes <methodname>setExtension()</methodname>,
  425. <methodname>addExtension()</methodname>, et <methodname>getExtension()</methodname> pour paramétrer et récupérer
  426. les extensions.
  427. </para>
  428. <para>
  429. Dans certains cas, il est utile vérifier aussi la casse. A cette fin le
  430. constructeur autorise un second paramètre <varname>$case</varname> qui, s'il est réglé à
  431. <constant>TRUE</constant>, validera l'extension en vérifiant aussi la casse.
  432. </para>
  433. <example id="zend.file.transfer.validators.excludeextension.example">
  434. <title>Utiliser le validateur ExcludeExtension</title>
  435. <programlisting language="php"><![CDATA[
  436. $upload = new Zend_File_Transfer();
  437. // Refuser les fichiers avec l'extension php ou exe
  438. $upload->addValidator('ExcludeExtension', false, 'php,exe');
  439. // Refuser les fichiers avec l'extension php ou exe en utilisant
  440. // la notation de type tableau
  441. $upload->addValidator('ExcludeExtension', false, array('php', 'exe'));
  442. // Vérifier aussi la casse
  443. $upload->addValidator('ExcludeExtension', false, array('php', 'exe', 'case' => true));
  444. ]]></programlisting>
  445. </example>
  446. <note>
  447. <para>
  448. Notez que ce validateur ne vérifie que l'extension de fichier. Il ne vérifie
  449. pas le type <acronym>MIME</acronym> réel du fichier.
  450. </para>
  451. </note>
  452. </sect2>
  453. <sect2 id="zend.file.transfer.validators.excludemimetype">
  454. <title>Validateur ExcludeMimeType</title>
  455. <para>
  456. Le validateur <code>ExcludeMimeType</code> vérifie le type <acronym>MIME</acronym> des fichiers
  457. transférés. Il supporte les options suivantes&#160;:
  458. </para>
  459. <itemizedlist>
  460. <listitem>
  461. <para>
  462. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser un
  463. tableau numérique. Paramètre le type <acronym>MIME</acronym> à vérifier.
  464. </para>
  465. <para>
  466. Avec cette option vous pouvez définir le(s) type(s) <acronym>MIME</acronym> que vous
  467. souhaitez exclure.
  468. </para>
  469. </listitem>
  470. <listitem>
  471. <para>
  472. <code>headerCheck</code>&#160;: si spécifié à <constant>TRUE</constant>, cette
  473. option va vérifier l'information <acronym>HTTP</acronym> concernant le type de
  474. fichier quand les extensions <emphasis>fileInfo</emphasis> ou
  475. <emphasis>mimeMagic</emphasis> ne seront pas trouvées. La valeur par défaut de
  476. cette option est <constant>FALSE</constant>.
  477. </para>
  478. </listitem>
  479. </itemizedlist>
  480. <para>
  481. Ce validateur accepte des types <acronym>MIME</acronym> multiples soit sous la forme d'une chaîne
  482. utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau.
  483. Vous pouvez aussi utiliser les méthodes <methodname>setMimeType()</methodname>,
  484. <methodname>addMimeType()</methodname>, et <methodname>getMimeType()</methodname> pour paramétrer et récupérer
  485. les types <acronym>MIME</acronym>.
  486. </para>
  487. <example id="zend.file.transfer.validators.excludemimetype.example">
  488. <title>Utiliser le validateur ExcludeMimeType</title>
  489. <programlisting language="php"><![CDATA[
  490. $upload = new Zend_File_Transfer();
  491. // Refuser le type MIME d'image gif pour tous les fichiers
  492. $upload->addValidator('ExcludeMimeType', false, 'image/gif');
  493. // Refuser le type MIME d'image gif et jpg pour tous les fichiers
  494. $upload->addValidator('ExcludeMimeType', false, array('image/gif', 'image/jpeg');
  495. // Refuser les types MIME du groupe image pour tous les fichiers
  496. $upload->addValidator('ExcludeMimeType', false, 'image');
  497. ]]></programlisting>
  498. </example>
  499. <para>
  500. L'exemple ci-dessus montre qu'il est aussi possible de limiter le type <acronym>MIME</acronym>
  501. accepté à un groupe de type <acronym>MIME</acronym>. Pour refuser toutes les images utilisez simplement
  502. "image" en tant que type <acronym>MIME</acronym>. Ceci peut être appliqué à tous les groupes de type <acronym>MIME</acronym>
  503. comme "image", "audio", "video", "text" et plus encore.
  504. </para>
  505. <note>
  506. <para>
  507. Notez que refuser un groupe de type <acronym>MIME</acronym> refusera tous les membres de ce
  508. groupe même si ce n'est pas votre intention. Par exemple quand vous refusez "image",
  509. vous refusez donc "image/jpeg" ou "image/vasa". Quand vous n'êtes pas sûr de vouloir
  510. refuser tous les types, vous devriez définir individuellement les types <acronym>MIME</acronym> plutôt
  511. que le groupe complet.
  512. </para>
  513. </note>
  514. </sect2>
  515. <sect2 id="zend.file.transfer.validators.exists">
  516. <title>Validateur Exists</title>
  517. <para>
  518. Le validateur <code>Exists</code> l'existence des fichiers fournis. Il supporte
  519. les options suivantes&#160;:
  520. </para>
  521. <itemizedlist>
  522. <listitem>
  523. <para>
  524. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser
  525. un tableau numérique. Vérifie si le fichier existe dans le dossier
  526. fourni.
  527. </para>
  528. </listitem>
  529. </itemizedlist>
  530. <para>
  531. Ce validateur accepte des extensions multiples soit sous la forme d'une chaîne
  532. utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau.
  533. Vous pouvez aussi utiliser les méthodes <methodname>setDirectory()</methodname>,
  534. <methodname>addDirectory()</methodname>, et <methodname>getDirectory()</methodname> pour paramétrer et récupérer
  535. les extensions.
  536. </para>
  537. <example id="zend.file.transfer.validators.exists.example">
  538. <title>Utiliser le validateur Exists</title>
  539. <programlisting language="php"><![CDATA[
  540. $upload = new Zend_File_Transfer();
  541. // Ajoute le dossier temporaire à vérifier
  542. $upload->addValidator('Exists', false, '\temp');
  543. // Ajoute deux dossiers en utilsant la notation de type tableau
  544. $upload->addValidator('Exists',
  545. false,
  546. array('\home\images', '\home\uploads'));
  547. ]]></programlisting>
  548. </example>
  549. <note>
  550. <para>
  551. Notez que ce validateur vérifie si le fichier existe dans tous les dossiers
  552. fournis. La validation échoue si le fichier est manquant dans l'un des
  553. dossiers.
  554. </para>
  555. </note>
  556. </sect2>
  557. <sect2 id="zend.file.transfer.validators.extension">
  558. <title>Validateur Extension</title>
  559. <para>
  560. Le validateur <code>Extension</code> vérifie l'=es extensions des fichiers qui ont
  561. été fournis. Il supporte les options suivantes&#160;:
  562. </para>
  563. <itemizedlist>
  564. <listitem>
  565. <para>
  566. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser
  567. un tableau numérique. Paramètre l'extension à vérifier.
  568. </para>
  569. </listitem>
  570. <listitem>
  571. <para>
  572. <code>case</code>&#160;: paramètre une validation sensible à la casse. Par
  573. défaut, la validation n'est pas sensible à la casse. Notez que cette clé est
  574. utilisée pour toutes les extensions.
  575. </para>
  576. </listitem>
  577. </itemizedlist>
  578. <para>
  579. Ce validateur accepte des extensions multiples soit sous la forme d'une chaîne
  580. utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau.
  581. Vous pouvez aussi utiliser les méthodes <methodname>setExtension()</methodname>,
  582. <methodname>addExtension()</methodname>, et <methodname>getExtension()</methodname> pour paramétrer et récupérer
  583. les extensions.
  584. </para>
  585. <para>
  586. Dans certains cas, il est utile vérifier aussi la casse. A cette fin le
  587. constructeur autorise un second paramètre <varname>$case</varname> qui, s'il est réglé à
  588. <constant>TRUE</constant>, validera l'extension en vérifiant aussi la casse.
  589. </para>
  590. <example id="zend.file.transfer.validators.extension.example">
  591. <title>Utiliser le validateur Extension</title>
  592. <programlisting language="php"><![CDATA[
  593. $upload = new Zend_File_Transfer();
  594. // Limite les extensions à jpg et png
  595. $upload->addValidator('Extension', false, 'jpg,png');
  596. // Limite les extensions à jpg et png en utilisant
  597. // la notation de type tableau
  598. $upload->addValidator('Extension', false, array('jpg', 'png'));
  599. // Vérifie aussi la casse
  600. $upload->addValidator('Extension', false, array('mo', 'png', 'case' => true));
  601. if (!$upload->isValid('C:\temp\myfile.MO')) {
  602. print 'Non valide à cause de MO au lieu de mo';
  603. }
  604. ]]></programlisting>
  605. </example>
  606. <note>
  607. <para>
  608. Notez que ce validateur ne vérifie que l'extension de fichier. Il ne vérifie
  609. pas le type <acronym>MIME</acronym> réel du fichier.
  610. </para>
  611. </note>
  612. </sect2>
  613. <sect2 id="zend.file.transfer.validators.filessize">
  614. <title>Validateur FilesSize</title>
  615. <para>
  616. Le validateur <code>FilesSize</code> vérifie le poids total de tous les fichiers
  617. transférés. Il supporte les options suivantes&#160;:
  618. </para>
  619. <itemizedlist>
  620. <listitem>
  621. <para><code>min</code>&#160;: paramètre le poids minimum de tous les fichiers.</para>
  622. <para>
  623. Avec cette option vous pouvez définir le poids minimum de tous les
  624. fichiers que vous souhaitez transférer.
  625. </para>
  626. </listitem>
  627. <listitem>
  628. <para><code>max</code>&#160;: paramètre le poids maximum de tous les fichiers.</para>
  629. <para>
  630. Avec cette option vous pouvez limiter le poids total des fichiers qui
  631. doivent être transférés, mais pas la taille individuelle de chaque
  632. fichier.
  633. </para>
  634. </listitem>
  635. <listitem>
  636. <para>
  637. <code>bytestring</code>&#160;: définit si un échec est retourné avec un taille
  638. plus facilement lisible pour l'utilisateur, ou avec une taille de fichier
  639. brute.
  640. </para>
  641. <para>
  642. Avec cette option vous pouvez en fait définir si l'utilisateur récupérera
  643. "10864" ou "10MB". La valeur par défaut est <constant>TRUE</constant> qui retournera
  644. "10MB".
  645. </para>
  646. </listitem>
  647. </itemizedlist>
  648. <para>
  649. Vous pouvez initialiser seulement avec une chaîne qui sera utilisée en tant que
  650. <code>max</code>. Mais vous pouvez aussi utiliser les méthodes <methodname>setMin()</methodname> et
  651. <methodname>setMax()</methodname> pour paramétrer ces options plus tard et <methodname>getMin()</methodname> et
  652. <methodname>getMax()</methodname> pour les récupérer.
  653. </para>
  654. <para>
  655. La taille elle-même est acceptée en notation SI comme sur la plupart des systèmes
  656. d'exploitation. Au lieu de 20000 octets (NdT. : "bytes" en anglais), vous pouvez
  657. utiliser <emphasis>20kB</emphasis>. Toutes les unités sont converties en utilisant 1024
  658. comme valeur de base. Les unités suivantes sont acceptées : <code>kB</code>,
  659. <code>MB</code>, <code>GB</code>, <code>TB</code>, <code>PB</code> et <code>EB</code>.
  660. Comme mentionné précédemment vous devez noter que 1kB équivaut à 1024 octets.
  661. </para>
  662. <example id="zend.file.transfer.validators.filessize.example">
  663. <title>Utiliser le validateur FilesSize</title>
  664. <programlisting language="php"><![CDATA[
  665. $upload = new Zend_File_Transfer();
  666. // Limite la taille de tous les fichiers à 40000 octets
  667. $upload->addValidator('FilesSize', false, 40000);
  668. // Limite la taille de tous les fichiers dans une plage de 10kB à 4MB
  669. $upload->addValidator('FilesSize', false, array('min' => '10kB',
  670. 'max' => '4MB'));
  671. // Comme ci-dessus, mais retourne la taille de fichier brute plutôt qu'une chaîne
  672. $upload->addValidator('FilesSize', false, array('min' => '10kB',
  673. 'max' => '4MB',
  674. 'bytestring' => false));
  675. ]]></programlisting>
  676. </example>
  677. <note>
  678. <para>
  679. Notez que ce validateur stocke le poids des fichiers vérifiés en interne. Le
  680. fichier qui excédera le poids maximum sera retourné en tant qu'erreur.
  681. </para>
  682. </note>
  683. </sect2>
  684. <sect2 id="zend.file.transfer.validators.imagesize">
  685. <title>Validateur ImageSize</title>
  686. <para>
  687. Le validateur <code>ImageSize</code> vérifie la taille des images. Il supporte les
  688. options suivantes&#160;:
  689. </para>
  690. <itemizedlist>
  691. <listitem>
  692. <para><code>minheight</code>&#160;: paramètre la hauteur minimum d'une image.</para>
  693. </listitem>
  694. <listitem>
  695. <para><code>maxheight</code>&#160;: paramètre la hauteur maximum d'une image.</para>
  696. </listitem>
  697. <listitem>
  698. <para><code>minwidth</code>&#160;: paramètre la largeur minimum d'une image.</para>
  699. </listitem>
  700. <listitem>
  701. <para><code>maxwidth</code>&#160;: paramètre la largeur maximum d'une image.</para>
  702. </listitem>
  703. </itemizedlist>
  704. <para>
  705. Vous pouvez aussi utiliser les méthodes <methodname>setImageMin()</methodname> et
  706. <methodname>setImageMax()</methodname> pour régler les valeurs minimum et maximum plus tard et
  707. <methodname>getMin()</methodname> et <methodname>getMax()</methodname> pour les récupérer.
  708. </para>
  709. <para>
  710. Par commodité, il existe aussi les méthodes <code>setImageWidth</code> et
  711. <code>setImageHeight</code> qui paramètrent la largeur et la hauteur minimum et maximum.
  712. Bien sûr les méthodes associées <code>getImageWidth</code> et
  713. <code>getImageHeight</code> sont aussi disponibles.
  714. </para>
  715. <para>
  716. Pour désactiver la validation d'une dimension, ne paramétrez pas l'option
  717. correspondante.
  718. </para>
  719. <example id="zend.file.transfer.validators.imagesize.example">
  720. <title>Utiliser le validateur ImageSize</title>
  721. <programlisting language="php"><![CDATA[
  722. $upload = new Zend_File_Transfer();
  723. // Limite la taille de l'image à une hauteur de 100 à 200 et
  724. // une largeur de 40 à 80 pixels
  725. $upload->addValidator('ImageSize',
  726. false,
  727. array('minwidth' => 40,
  728. 'maxwidth' => 80,
  729. 'minheight' => 100,
  730. 'maxheight' => 200);
  731. // Autre possibilité de réglage
  732. $upload->setImageWidth(array('minwidth' => 20, 'maxwidth' => 200));
  733. ]]></programlisting>
  734. </example>
  735. </sect2>
  736. <sect2 id="zend.file.transfer.validators.iscompressed">
  737. <title>Validateur IsCompressed</title>
  738. <para>
  739. Le validateur <code>IsCompressed</code> vérifie si un fichier transféré est une
  740. archive compressée comme zip ou arc. Ce validateur est basée sur le validateur
  741. <code>MimeType</code> et supportent les mêmes méthodes et options. Vous pouvez limiter
  742. ce validateur à des types de compression particuliers avec les méthodes décrites
  743. ci-dessous.
  744. </para>
  745. <example id="zend.file.transfer.validators.iscompressed.example">
  746. <title>Utiliser le validateur IsCompressed</title>
  747. <programlisting language="php"><![CDATA[
  748. $upload = new Zend_File_Transfer();
  749. // Vérifie si un fichier uploadé est une archive compressée
  750. $upload->addValidator('IsCompressed', false);
  751. // Limite ce validateur aux fichiers zip seulement
  752. $upload->addValidator('IsCompressed', false, array('application/zip'));
  753. // Limite ce validateur aux fichiers zip mais avec la notation simplifiée
  754. $upload->addValidator('IsCompressed', false, 'zip');
  755. ]]></programlisting>
  756. </example>
  757. <note>
  758. <para>
  759. Notez qu'il n'y a pas de vérification si vous paramétrez un type de fichier
  760. qui n'est pas un type de compression. Ainsi il est donc possible de définir que les
  761. fichiers gif sont acceptés par ce validateur même si ce n'est pas logique.
  762. </para>
  763. </note>
  764. </sect2>
  765. <sect2 id="zend.file.transfer.validators.isimage">
  766. <title>Validateur IsImage</title>
  767. <para>
  768. Le validateur <code>IsImage</code> vérifie si un fichier transféré est une image
  769. comme gif ou jpeg. Ce validateur est basée sur le validateur <code>MimeType</code> et
  770. supportent les mêmes méthodes et options. Vous pouvez limiter ce validateur à des types
  771. d'image particuliers avec les méthodes décrites ci-dessous.
  772. </para>
  773. <example id="zend.file.transfer.validators.isimage.example">
  774. <title>Utiliser le validateur IsImage</title>
  775. <programlisting language="php"><![CDATA[
  776. $upload = new Zend_File_Transfer();
  777. // Vérifie si un fichier uploadé est une image
  778. $upload->addValidator('IsImage', false);
  779. // Limite ce validateur aux fichiers gif seulement
  780. $upload->addValidator('IsImage', false, array('application/gif'));
  781. // Limite ce validateur aux fichiers jpeg mais avec la notation simplifiée
  782. $upload->addValidator('IsImage', false, 'jpeg');
  783. ]]></programlisting>
  784. </example>
  785. <note>
  786. <para>
  787. Notez qu'il n'y a pas de vérification si vous paramétrez un type de fichier
  788. qui n'est pas un type d'image. Ainsi il est donc possible de définir que les
  789. fichiers zip sont acceptés par ce validateur même si ce n'est pas logique.
  790. </para>
  791. </note>
  792. </sect2>
  793. <sect2 id="zend.file.transfer.validators.hash">
  794. <title>Validateur Hash</title>
  795. <para>
  796. Le validateur <code>Hash</code> vérifie le contenu du fichier transféré en le
  797. hachant. Ce validateur utilise l'extension de hachage de <acronym>PHP</acronym>. Il supporte les options
  798. suivantes&#160;:
  799. </para>
  800. <itemizedlist>
  801. <listitem>
  802. <para>
  803. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser
  804. un tableau numérique. Paramètre la valeur de hachage qui doit être
  805. vérifié.
  806. </para>
  807. <para>
  808. Vous pouvez paramétrer de multiples hachages en les fournissant sous la
  809. forme d'un tableau. Chacun sera vérifié et seulement si tous échouent, la
  810. validation elle-même échouera.
  811. </para>
  812. </listitem>
  813. </itemizedlist>
  814. <itemizedlist>
  815. <listitem>
  816. <para>
  817. <code>algorithm</code>&#160;: paramètre l'algorithme à utiliser pour hacher le
  818. contenu.
  819. </para>
  820. <para>
  821. Vous pouvez paramétrer de multiples algorithmes en utilisant la méthode
  822. <methodname>addHash()</methodname> plusieurs fois.
  823. </para>
  824. </listitem>
  825. </itemizedlist>
  826. <example id="zend.file.transfer.validators.hash.example">
  827. <title>Utiliser le validateur Hash</title>
  828. <programlisting language="php"><![CDATA[
  829. $upload = new Zend_File_Transfer();
  830. // Vérifie si le contenu d'un fichier uploadé correspond au hachage fourni
  831. $upload->addValidator('Hash', false, '3b3652f');
  832. // Limite ce validateur à deux différents hachages
  833. $upload->addValidator('Hash', false, array('3b3652f', 'e612b69'));
  834. // Paramètre un algorithme différent pour effectuer le hachage
  835. $upload->addValidator('Hash', false, array('315b3cd8273d44912a7', 'algorithm' => 'md5'));
  836. ]]></programlisting>
  837. </example>
  838. <note>
  839. <para>
  840. Ce validateur supporte environ 34 algorithmes de hachage différents. Les plus
  841. connus sont "crc32", "md5" and "sha1". Si vous souhaitez connaître les autres
  842. algorithmes, voyez <ulink url="http://php.net/manual/fr/function.hash-algos.php">la
  843. méthode hash_algos de <acronym>PHP</acronym></ulink>.
  844. </para>
  845. </note>
  846. </sect2>
  847. <sect2 id="zend.file.transfer.validators.md5">
  848. <title>Validateur Md5</title>
  849. <para>
  850. Le validateur <code>Md5</code> vérifie le contenu du fichier transféré en le
  851. hachant. Ce validateur utilise l'extension de hachage de <acronym>PHP</acronym> avec l'algorithme md5. Il
  852. supporte les options suivantes&#160;:
  853. </para>
  854. <itemizedlist>
  855. <listitem>
  856. <para>
  857. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser
  858. un tableau numérique. Paramètre la valeur de hachage qui doit être
  859. vérifié.
  860. </para>
  861. <para>
  862. Vous pouvez paramétrer de multiples hachages en les fournissant sous la
  863. forme d'un tableau. Chacun sera vérifié et seulement si tous échouent, la
  864. validation elle-même échouera.
  865. </para>
  866. </listitem>
  867. </itemizedlist>
  868. <example id="zend.file.transfer.validators.md5.example">
  869. <title>Utiliser le validateur Md5</title>
  870. <programlisting language="php"><![CDATA[
  871. $upload = new Zend_File_Transfer();
  872. // Vérifie si le contenu d'un fichier uploadé correspond au hachage fourni
  873. $upload->addValidator('Md5', false, '3b3652f336522365223');
  874. // Limite ce validateur à deux différents hachages
  875. $upload->addValidator('Md5', false, array('3b3652f336522365223', 'eb3365f3365ddc65365'));
  876. ]]></programlisting>
  877. </example>
  878. </sect2>
  879. <sect2 id="zend.file.transfer.validators.mimetype">
  880. <title>Validateur MimeType</title>
  881. <para>
  882. Le validateur <code>MimeType</code> vérifie le type <acronym>MIME</acronym> des fichiers transférés.
  883. Il supporte les options suivantes&#160;:
  884. </para>
  885. <itemizedlist>
  886. <listitem>
  887. <para>
  888. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser un
  889. tableau numérique. Paramètre le type <acronym>MIME</acronym> à contrôler.
  890. </para>
  891. <para>
  892. Avec cette option vous pouvez définir le type <acronym>MIME</acronym> des fichiers qui seront
  893. acceptés.
  894. </para>
  895. </listitem>
  896. <listitem>
  897. <para>
  898. <code>headerCheck</code>&#160;: si spécifié à <constant>TRUE</constant>, cette
  899. option va vérifier l'information <acronym>HTTP</acronym> concernant le type de
  900. fichier quand les extensions <emphasis>fileInfo</emphasis> ou
  901. <emphasis>mimeMagic</emphasis> ne seront pas trouvées. La valeur par défaut de
  902. cette option est <constant>FALSE</constant>.
  903. </para>
  904. </listitem>
  905. <listitem>
  906. <para><code>magicfile</code>&#160;: le magicfile qui sera utilisé.</para>
  907. <para>
  908. Avec cette option vous pouvez définir le magicfile à utiliser. Quand il
  909. n'est pas utilisé ou vide, la constante <constant>MAGIC</constant> sera utilisée. Cette
  910. option est disponible à partir de la version 1.7.1 de Zend Framework.
  911. </para>
  912. </listitem>
  913. </itemizedlist>
  914. <para>
  915. Ce validateur accepte des types <acronym>MIME</acronym> multiples soit sous la forme d'une chaîne
  916. utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau.
  917. Vous pouvez aussi utiliser les méthodes <methodname>setMimeType()</methodname>,
  918. <methodname>addMimeType()</methodname>, et <methodname>getMimeType()</methodname> pour paramétrer et récupérer
  919. les types <acronym>MIME</acronym>.
  920. </para>
  921. <para>
  922. Vous pouvez aussi paramétrer le magicfile qui sera utilisé par fileinfo avec
  923. l'option <code>magicfile</code>. De plus il existe les méthodes
  924. <methodname>setMagicFile()</methodname> et <methodname>getMagicFile()</methodname> qui permettent de paramétrer
  925. ou récupérer plus tard le paramètre <code>magicfile</code>. Ces méthodes sont
  926. disponibles à partir de la version Zend Framework 1.7.1.
  927. </para>
  928. <example id="zend.file.transfer.validators.mimetype.example">
  929. <title>Utiliser le validateur MimeType</title>
  930. <programlisting language="php"><![CDATA[
  931. $upload = new Zend_File_Transfer();
  932. // Limite le type MIME de tous les fichiers aux images gif
  933. $upload->addValidator('MimeType', false, 'image/gif');
  934. // Limite le type MIME de tous les fichiers aux images jpeg et gif
  935. $upload->adValidator('MimeType', false, array('image/gif', 'image/jpeg');
  936. // Limite le type MIME de tous les fichiers au groupe des images
  937. $upload->addValidator('MimeType', false, 'image');
  938. // Utilise un magicfile différent
  939. $upload->addValidator('MimeType', false, array('image', 'magicfile' => '/path/to/magicfile.mgx'));
  940. ]]></programlisting>
  941. </example>
  942. <para>
  943. L'exemple ci-dessus montre qu'il est aussi possible de limiter le type <acronym>MIME</acronym>
  944. accepté à un groupe de type <acronym>MIME</acronym>. Pour autoriser toutes les images utilisez simplement
  945. "image" en tant que type <acronym>MIME</acronym>. Ceci peut être appliqué à tous les groupes de type <acronym>MIME</acronym>
  946. comme "image", "audio", "video", "text" et plus encore.
  947. </para>
  948. <note>
  949. <para>
  950. Notez qu'autoriser un groupe de type <acronym>MIME</acronym> acceptera tous les membres de ce
  951. groupe même si votre application ne les supporte pas. Par exemple quand vous
  952. autorisez "image", vous autorisez donc "image/xpixmap" ou "image/vasa", ce qui peut
  953. être problématique. Quand vous n'êtes pas sûr que votre application supporte tous
  954. les types, vous devriez définir individuellement les types <acronym>MIME</acronym> plutôt que le groupe
  955. complet.
  956. </para>
  957. </note>
  958. <note>
  959. <para>
  960. Ce composant utilise l'extension <code>fileinfo</code> si elle est disponible.
  961. Si ce n'est pas le cas, il utilisera alors la fonction
  962. <code>mime_content_type</code>. Et si l'appel de fonction échoue, il utilisera le
  963. type <acronym>MIME</acronym> fourni par <acronym>HTTP</acronym>.
  964. </para>
  965. <para>
  966. Vous devez cependant être averti de possibles problèmes de sécurité si, ni
  967. <code>fileinfo</code>, ni <code>mime_content_type</code> ne sont disponibles : le
  968. type <acronym>MIME</acronym> fourni pas <acronym>HTTP</acronym> n'étant pas sécurisé et pouvant être facilement
  969. manipulé.
  970. </para>
  971. </note>
  972. </sect2>
  973. <sect2 id="zend.file.transfer.validators.notexists">
  974. <title>Validateur NotExists</title>
  975. <para>
  976. Le validateur <code>NotExists</code> l'existence des fichiers fournis. Il supporte
  977. les options suivantes&#160;:
  978. </para>
  979. <itemizedlist>
  980. <listitem>
  981. <para>
  982. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser
  983. un tableau numérique. Vérifie si le fichier n'existe pas dans le dossier
  984. fourni.
  985. </para>
  986. </listitem>
  987. </itemizedlist>
  988. <para>
  989. Ce validateur accepte des extensions multiples soit sous la forme d'une chaîne
  990. utilisant le caractère virgule (",") comme séparateur ou sous la forme d'un tableau.
  991. Vous pouvez aussi utiliser les méthodes <methodname>setDirectory()</methodname>,
  992. <methodname>addDirectory()</methodname>, et <methodname>getDirectory()</methodname> pour paramétrer et récupérer
  993. les extensions.
  994. </para>
  995. <example id="zend.file.transfer.validators.notexists.example">
  996. <title>Utiliser le validateur NotExists</title>
  997. <programlisting language="php"><![CDATA[
  998. $upload = new Zend_File_Transfer();
  999. // Ajoute le dossier temporaire à vérifier
  1000. $upload->addValidator('NotExists', false, '\temp');
  1001. // Ajoute deux dossiers en utilisant la notation de type tableau
  1002. $upload->addValidator('NotExists',
  1003. false,
  1004. array('\home\images',
  1005. '\home\uploads'));
  1006. ]]></programlisting>
  1007. </example>
  1008. <note>
  1009. <para>
  1010. Notez que ce validateur vérifie si le fichier n'existe dans aucun des dossiers
  1011. fournis. La validation échoue si le fichier existe dans l'un des dossiers.
  1012. </para>
  1013. </note>
  1014. </sect2>
  1015. <sect2 id="zend.file.transfer.validators.sha1">
  1016. <title>Validateur Sha1</title>
  1017. <para>
  1018. Le validateur <code>Sha1</code> vérifie le contenu du fichier transféré en le
  1019. hachant. Ce validateur utilise l'extension de hachage de <acronym>PHP</acronym> avec l'algorithme sha1. Il
  1020. supporte les options suivantes&#160;:
  1021. </para>
  1022. <itemizedlist>
  1023. <listitem>
  1024. <para>
  1025. <code>*</code>&#160;: vous pouvez paramétrer n'importe quelle clé ou utiliser
  1026. un tableau numérique. Paramètre la valeur de hachage qui doit être
  1027. vérifié.
  1028. </para>
  1029. <para>
  1030. Vous pouvez paramétrer de multiples hachages en les fournissant sous la
  1031. forme d'un tableau. Chacun sera vérifié et seulement si tous échouent, la
  1032. validation elle-même échouera.
  1033. </para>
  1034. </listitem>
  1035. </itemizedlist>
  1036. <example id="zend.file.transfer.validators.sha1.example">
  1037. <title>Utiliser le validateur Sha1</title>
  1038. <programlisting language="php"><![CDATA[
  1039. $upload = new Zend_File_Transfer();
  1040. // Vérifie si le contenu d'un fichier uploadé correspond au hachage fourni
  1041. $upload->addValidator('Sha1', false, '3b3652f336522365223');
  1042. // Limite ce validateur à deux différents hachages
  1043. $upload->addValidator('Sha1', false, array('3b3652f336522365223', 'eb3365f3365ddc65365'));
  1044. ]]></programlisting>
  1045. </example>
  1046. </sect2>
  1047. <sect2 id="zend.file.transfer.validators.size">
  1048. <title>Validateur Size</title>
  1049. <para>
  1050. Le validateur <code>Size</code> vérifie le poids d'un fichier unique. Il supporte
  1051. les options suivantes&#160;:
  1052. </para>
  1053. <itemizedlist>
  1054. <listitem>
  1055. <para><code>min</code>&#160;: paramètre le poids minimum du fichier.</para>
  1056. </listitem>
  1057. <listitem>
  1058. <para><code>max</code>&#160;: paramètre le poids maximum du fichier.</para>
  1059. </listitem>
  1060. <listitem>
  1061. <para>
  1062. <code>bytestring</code>&#160;: définit si un échec est retourné avec un taille
  1063. plus facilement lisible pour l'utilisateur, ou avec une taille de fichier
  1064. brute.
  1065. </para>
  1066. <para>
  1067. Avec cette option vous pouvez en fait définir si l'utilisateur récupérera
  1068. "10864" ou "10MB". La valeur par défaut est <constant>TRUE</constant> qui retournera
  1069. "10MB".
  1070. </para>
  1071. </listitem>
  1072. </itemizedlist>
  1073. <para>
  1074. Vous pouvez initialiser seulement avec une chaîne qui sera utilisée en tant que
  1075. <code>max</code>. Mais vous pouvez aussi utiliser les méthodes <methodname>setMin()</methodname> et
  1076. <methodname>setMax()</methodname> pour paramétrer ces options plus tard et <methodname>getMin()</methodname> et
  1077. <methodname>getMax()</methodname> pour les récupérer.
  1078. </para>
  1079. <para>
  1080. Quand seule une chaîne est fournie, elle est utilisée en tant que
  1081. <code>max</code>. Mais vous pouvez aussi utiliser les méthodes <methodname>setMin()</methodname> et
  1082. <methodname>setMax()</methodname> pour paramétrer ces options plus tard et <methodname>getMin()</methodname> et
  1083. <methodname>getMax()</methodname> pour les récupérer.
  1084. </para>
  1085. <para>
  1086. La taille elle-même est acceptée en notation SI comme sur la plupart des systèmes
  1087. d'exploitation. Au lieu de 20000 octets, vous pouvez utiliser <emphasis>20kB</emphasis>.
  1088. Toutes les unités sont converties en utilisant 1024 comme valeur de base. Les unités
  1089. suivantes sont acceptées : <code>kB</code>, <code>MB</code>, <code>GB</code>,
  1090. <code>TB</code>, <code>PB</code> et <code>EB</code>. Comme mentionné précédemment vous
  1091. devez noter que 1kB équivaut à 1024 octets.
  1092. </para>
  1093. <example id="zend.file.transfer.validators.size.example">
  1094. <title>Utiliser le validateur Size</title>
  1095. <programlisting language="php"><![CDATA[
  1096. $upload = new Zend_File_Transfer();
  1097. // Limite la taille d'un fichier à 40000 octets
  1098. $upload->addValidator('Size', false, 40000);
  1099. // Limite la taille du fichier 'uploadfile' dans une plage de 10kB à 4MB
  1100. // Additionally returns the plain number in case of an error instead of a userfriendly one
  1101. $upload->addValidator('Size', false, array('min' => '10kB',
  1102. 'max' => '4MB',
  1103. 'bytestring' => false));
  1104. ]]></programlisting>
  1105. </example>
  1106. </sect2>
  1107. <sect2 id="zend.file.transfer.validators.wordcount">
  1108. <title>Validateur WordCount</title>
  1109. <para>
  1110. Le validateur <code>WordCount</code> vérifie le nombre de mots à l'intérieur des
  1111. fichiers fournis. Il supporte les options suivantes&#160;:
  1112. </para>
  1113. <itemizedlist>
  1114. <listitem>
  1115. <para>
  1116. <code>min</code>&#160;: spécifie le nombre de mots minimum qui doivent être
  1117. trouvés.
  1118. </para>
  1119. </listitem>
  1120. <listitem>
  1121. <para>
  1122. <code>max</code>&#160;: spécifie le nombre de mots maximum qui doivent être
  1123. trouvés.
  1124. </para>
  1125. </listitem>
  1126. </itemizedlist>
  1127. <para>
  1128. Si vous initialisez ce validateur avec une chaîne ou un entier, la valeur sera
  1129. utilisée en tant que <code>max</code>. Mais vous pouvez aussi utiliser les méthodes
  1130. <methodname>setMin()</methodname> et <methodname>setMax()</methodname> pour paramétrer ces options plus tard et
  1131. <methodname>getMin()</methodname> et <methodname>getMax()</methodname> pour les récupérer.
  1132. </para>
  1133. <example id="zend.file.transfer.validators.wordcount.example">
  1134. <title>Utiliser le validateur WordCount</title>
  1135. <programlisting language="php"><![CDATA[
  1136. $upload = new Zend_File_Transfer();
  1137. // Limite le nombre maximum de mots dans les fichiers à 2000
  1138. $upload->addValidator('WordCount', false, 2000);
  1139. // Limite le nombre de mots dans les fichiers entre un minimum de 1000
  1140. // et un maximum de 5000 mots
  1141. $upload->addValidator('WordCount', false, array('min' => 1000, 'max' => 5000));
  1142. ]]></programlisting>
  1143. </example>
  1144. </sect2>
  1145. </sect1>