documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Ldif-Encoder.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect3 id="zend.ldap.api.reference.zend-ldap-ldif-encoder">
   4     <title>Zend_Ldif_Encoder</title>
   5
   6     <table id="zend.ldap.api.reference.zend-ldap-ldif-encoder.table">
   7         <title>Zend_Ldif_Encoder API</title>
   8
   9         <tgroup cols="2">
  10             <thead>
  11                 <row>
  12                     <entry>Method</entry>
  13                     <entry>Description</entry>
  14                 </row>
  15             </thead>
  16
  17             <tbody>
  18                 <row>
  19                     <entry>
  20                         <emphasis><code>array decode(string $string)</code></emphasis>
  21                     </entry>
  22
  23                     <entry>
  24                         Decodes the string <varname>$string</varname> into an array of
  25                         <acronym>LDIF</acronym> items.
  26                     </entry>
  27                 </row>
  28
  29                 <row>
  30                     <entry>
  31                         <emphasis><code>string encode(scalar|array|Zend_Ldap_Node
  32                         $value, array $options)</code> </emphasis>
  33                     </entry>
  34
  35                     <entry>
  36                         Encode <varname>$value</varname> into a <acronym>LDIF</acronym>
  37                         representation. <varname>$options</varname> is an array that may contain the
  38                         following keys:
  39
  40                         <variablelist>
  41                             <varlistentry>
  42                                 <term><code>'sort'</code></term>
  43
  44                                 <listitem>
  45                                     <para>
  46                                         Sort the given attributes with <code>dn</code>
  47                                         following <code>objectClass</code> and following all other
  48                                         attributes sorted alphabetically. <constant>TRUE</constant>
  49                                         by default.
  50                                     </para>
  51                                 </listitem>
  52                             </varlistentry>
  53
  54                             <varlistentry>
  55                                 <term><code>'version'</code></term>
  56
  57                                 <listitem>
  58                                     <para>
  59                                         The <acronym>LDIF</acronym> format version. <code>1</code>
  60                                         by default.
  61                                     </para>
  62                                 </listitem>
  63                             </varlistentry>
  64
  65                             <varlistentry>
  66                                 <term><code>'wrap'</code></term>
  67
  68                                 <listitem>
  69                                     <para>
  70                                         The line-length. <code>78</code> by default to
  71                                         conform to the <acronym>LDIF</acronym> specification.
  72                                     </para>
  73                                 </listitem>
  74                             </varlistentry>
  75                         </variablelist>
  76                     </entry>
  77                 </row>
  78             </tbody>
  79         </tgroup>
  80     </table>
  81 </sect3>