Zend_Mime_Part.xml 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect1 id="zend.mime.part">
  4. <title>Zend_Mime_Part</title>
  5. <sect2 id="zend.mime.part.introduction">
  6. <title>Введение</title>
  7. <para>
  8. Класс <classname>Zend_Mime_Part</classname> представляет отдельную
  9. часть сообщения <acronym>MIME</acronym>. В объекте такого класса
  10. хранится действительное содержимое части сообщения, а также информация
  11. об его кодировке, типе содержимого и имени файла оригинала. Также этот
  12. класс предоставляет методы для генерации строки из сохраненных данных.
  13. Объекты <classname>Zend_Mime_Part</classname> могут быть добавлены в
  14. <link linkend="zend.mime.message"><classname>Zend_Mime_Message</classname></link>
  15. для получения сообщения multipart.
  16. </para>
  17. </sect2>
  18. <sect2 id="zend.mime.part.instantiation">
  19. <title>Инстанцирование</title>
  20. <para>
  21. Экземпляр класса <classname>Zend_Mime_Part</classname> создается с
  22. передачей строки, которая представляет собой содержимое новой части
  23. сообщения. По умолчанию используются тип OCTET-STREAM и кодировка 8Bit.
  24. После инстанцирования <classname>Zend_Mime_Part</classname> метаданные
  25. могут быть установлены путем прямого доступа к атрибутам:
  26. </para>
  27. <programlisting language="php"><![CDATA[
  28. public $type = Zend_Mime::TYPE_OCTETSTREAM;
  29. public $encoding = Zend_Mime::ENCODING_8BIT;
  30. public $id;
  31. public $disposition;
  32. public $filename;
  33. public $description;
  34. public $charset;
  35. public $boundary;
  36. public $location;
  37. public $language;
  38. ]]></programlisting>
  39. </sect2>
  40. <sect2 id="zend.mime.part.methods">
  41. <title>Методы для рендеринга строк из объекта части сообщения</title>
  42. <para>
  43. <methodname>getContent()</methodname> возвращает содержимое части
  44. сообщения, закодированное с применением кодировки, указанной в
  45. атрибуте $encoding. Корректными значениями являются
  46. ZMime::ENCODING_*. Преобразования по таблице символов не
  47. производятся.
  48. </para>
  49. <para>
  50. <methodname>getHeaders()</methodname> возвращает MIME-заголовки для
  51. части сообщения, они генерируются с учетом значений, установленных
  52. в открытых свойствах. Необходимо правильно установить свойства
  53. объекта до того, как будет вызван метод.
  54. <itemizedlist>
  55. <listitem>
  56. <para>
  57. <varname>$charset</varname>
  58. должен соответствовать используемому в содержимом набору
  59. символов, если это содержимое имеет текстовый тип (простой
  60. текст или HTML).
  61. </para>
  62. </listitem>
  63. <listitem>
  64. <para>
  65. <varname>$id</varname>
  66. устанавливается в качестве идентификатора
  67. включенных изображений в сообщении HTML.
  68. </para>
  69. </listitem>
  70. <listitem>
  71. <para>
  72. <varname>$filename</varname>
  73. содержит имя, которое должно присваиваться файлу после
  74. загрузки.
  75. </para>
  76. </listitem>
  77. <listitem>
  78. <para>
  79. <varname>$disposition</varname>
  80. определяет, должен ли файл обрабатываться как вложение
  81. или использоваться внутри сообщения.
  82. </para>
  83. </listitem>
  84. <listitem>
  85. <para>
  86. <varname>$description</varname>
  87. используется только для информационных целей.
  88. </para>
  89. </listitem>
  90. <listitem>
  91. <para>
  92. <varname>$boundary</varname>
  93. используется как граница MIME.
  94. </para>
  95. </listitem>
  96. <listitem>
  97. <para>
  98. <varname>$location</varname>
  99. содержит <acronym>URI</acronym> ресурса.
  100. </para>
  101. </listitem>
  102. <listitem>
  103. <para>
  104. <varname>$language</varname>
  105. определяет язык содержимого.
  106. </para>
  107. </listitem>
  108. </itemizedlist>
  109. </para>
  110. </sect2>
  111. </sect1>
  112. <!--
  113. vim:se ts=4 sw=4 et:
  114. -->