Zend_Mime_Part.xml 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. <!-- EN-Revision: 12047 -->
  2. <sect1 id="zend.mime.part">
  3. <title>Zend_Mime_Part</title>
  4. <sect2 id="zend.mime.part.introduction">
  5. <title>Introduction</title>
  6. <para>Cette classe représente une seule partie d'un message MIME. Elle contient le contenu actuel de la partie
  7. du message ainsi que des informations sur son encodage, le type de contenu ("content-type") et le nom de fichier
  8. original. Elle fournie une méthode pour générer une chaîne de caractères à partir des données stockées. Les
  9. objets <classname>Zend_Mime_Part</classname> peuvent-être ajoutés à <link
  10. linkend="zend.mime.message"><classname>Zend_Mime_Message</classname></link> pour assembler un message multipart
  11. complet.</para>
  12. </sect2>
  13. <sect2 id="zend.mime.part.instantiation">
  14. <title>Instanciation</title>
  15. <para><classname>Zend_Mime_Part</classname> est instanciée avec une chaîne de caractères qui représente le contenu de
  16. cette nouvelle partie. Le type doit être <code>OCTET-STREAM</code>, et l'encodage 8 bits. Après instanciation de
  17. <classname>Zend_Mime_Part</classname>, les métas-informations peuvent être définies en accédant directement aux attributs
  18. :</para>
  19. <programlisting role="php"><![CDATA[
  20. public $type = Zend_Mime::TYPE_OCTETSTREAM;
  21. public $encoding = Zend_Mime::ENCODING_8BIT;
  22. public $id;
  23. public $disposition;
  24. public $filename;
  25. public $description;
  26. public $charset;
  27. public $boundary;
  28. public $location;
  29. public $language;
  30. ]]></programlisting>
  31. </sect2>
  32. <sect2 id="zend.mime.part.methods">
  33. <title>Méthodes pour retourner la partie du message en une chaîne de caractères</title>
  34. <para><code>getContent()</code> retourne le contenu encodé de MimePart en une chaîne de caractères en utilisant
  35. l'encodage spécifié dans l'attribut <code>$encoding</code>. Les valeurs valides sont
  36. <classname>Zend_Mime::ENCODING_*</classname>, les conversions de jeux de caractères ne sont pas effectuées.</para>
  37. <para><code>getHeaders()</code> retourne les Mime-Headers d'un MimePart générés à partir des attributs
  38. accessibles publiquement. Les attributs de l'objet doivent être paramétrés correctement avant que cette méthode
  39. ne soit appelée. <itemizedlist>
  40. <listitem>
  41. <para><code>$charset</code> doit définir l'encodage actuel du contenu, si c'est un type texte (Texte
  42. ou HTML).</para>
  43. </listitem>
  44. <listitem>
  45. <para><code>$id</code> doit être défini pour identifier un content-id pour les images d'un mail
  46. HTML.</para>
  47. </listitem>
  48. <listitem>
  49. <para><code>$filename</code> contient le nom que le fichier aura lors de son téléchargement.</para>
  50. </listitem>
  51. <listitem>
  52. <para><code>$disposition</code> définit si le fichier doit être traité comme une pièce jointe ou
  53. s'il est inclus dans le mail (HTML).</para>
  54. </listitem>
  55. <listitem>
  56. <para><code>$description</code> sert uniquement pour information.</para>
  57. </listitem>
  58. <listitem>
  59. <para><code>$boundary</code> définit une chaîne en tant que limite.</para>
  60. </listitem>
  61. <listitem>
  62. <para><code>$location</code> peut être utilisé comme URI d'une ressource URI qui a une relation avec
  63. le contenu.</para>
  64. </listitem>
  65. <listitem>
  66. <para><code>$language</code> définit la langue du contenu.</para>
  67. </listitem>
  68. </itemizedlist></para>
  69. </sect2>
  70. </sect1>