documentation/manual/ru/module_specs/Zend_Mime_Part.xml

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