gosa-core/doc/devel/html/classuser.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>GOsa: user class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.2 -->
   7 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a></div>
   8 <h1>user Class Reference</h1>user plugin
   9 <a href="#_details">More...</a>
  10 <p>
  11 <p>Inheritance diagram for user:
  12 <p><center><img src="classuser.png" usemap="#user_map" border="0" alt=""></center>
  13 <map name="user_map">
  14 <area href="classplugin.html" alt="plugin" shape="rect" coords="0,0,46,24">
  15 </map>
  16 <a href="classuser-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  17 <tr><td></td></tr>
  18 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  19 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a0" doxytag="user::user"></a>
  20 &nbsp;</td><td class="memItemRight" valign=bottom><b>user</b> ($<a class="el" href="classplugin.html#o4">dn</a>=NULL)</td></tr>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classuser.html#a1">execute</a> ()</td></tr>
  23
  24 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">execute plugin </em> <a href="#a1"></a><em><br><br></td></tr>
  25 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="user::remove_from_parent"></a>
  26 &nbsp;</td><td class="memItemRight" valign=bottom><b>remove_from_parent</b> ()</td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="user::save_object"></a>
  29 &nbsp;</td><td class="memItemRight" valign=bottom><b>save_object</b> ()</td></tr>
  30
  31 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a4" doxytag="user::save"></a>
  32 &nbsp;</td><td class="memItemRight" valign=bottom><b>save</b> ()</td></tr>
  33
  34 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="user::check"></a>
  35 &nbsp;</td><td class="memItemRight" valign=bottom><b>check</b> ()</td></tr>
  36
  37 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  38 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o0" doxytag="user::base"></a>
  39 &nbsp;</td><td class="memItemRight" valign=bottom><b>base</b> = ""</td></tr>
  40
  41 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o1" doxytag="user::cn"></a>
  42 &nbsp;</td><td class="memItemRight" valign=bottom><b>cn</b> = ""</td></tr>
  43
  44 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o2" doxytag="user::personalTitle"></a>
  45 &nbsp;</td><td class="memItemRight" valign=bottom><b>personalTitle</b> = ""</td></tr>
  46
  47 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o3" doxytag="user::academicTitle"></a>
  48 &nbsp;</td><td class="memItemRight" valign=bottom><b>academicTitle</b> = ""</td></tr>
  49
  50 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o4" doxytag="user::homePostalAddress"></a>
  51 &nbsp;</td><td class="memItemRight" valign=bottom><b>homePostalAddress</b> = ""</td></tr>
  52
  53 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o5" doxytag="user::homePhone"></a>
  54 &nbsp;</td><td class="memItemRight" valign=bottom><b>homePhone</b> = ""</td></tr>
  55
  56 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o6" doxytag="user::labeledURI"></a>
  57 &nbsp;</td><td class="memItemRight" valign=bottom><b>labeledURI</b> = ""</td></tr>
  58
  59 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o7" doxytag="user::o"></a>
  60 &nbsp;</td><td class="memItemRight" valign=bottom><b>o</b> = ""</td></tr>
  61
  62 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o8" doxytag="user::ou"></a>
  63 &nbsp;</td><td class="memItemRight" valign=bottom><b>ou</b> = ""</td></tr>
  64
  65 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o9" doxytag="user::departmentNumber"></a>
  66 &nbsp;</td><td class="memItemRight" valign=bottom><b>departmentNumber</b> = ""</td></tr>
  67
  68 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o10" doxytag="user::employeeNumber"></a>
  69 &nbsp;</td><td class="memItemRight" valign=bottom><b>employeeNumber</b> = ""</td></tr>
  70
  71 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o11" doxytag="user::employeeType"></a>
  72 &nbsp;</td><td class="memItemRight" valign=bottom><b>employeeType</b> = ""</td></tr>
  73
  74 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o12" doxytag="user::roomNumber"></a>
  75 &nbsp;</td><td class="memItemRight" valign=bottom><b>roomNumber</b> = ""</td></tr>
  76
  77 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o13" doxytag="user::telephoneNumber"></a>
  78 &nbsp;</td><td class="memItemRight" valign=bottom><b>telephoneNumber</b> = ""</td></tr>
  79
  80 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o14" doxytag="user::facsimileTelephoneNumber"></a>
  81 &nbsp;</td><td class="memItemRight" valign=bottom><b>facsimileTelephoneNumber</b> = ""</td></tr>
  82
  83 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o15" doxytag="user::mobile"></a>
  84 &nbsp;</td><td class="memItemRight" valign=bottom><b>mobile</b> = ""</td></tr>
  85
  86 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o16" doxytag="user::pager"></a>
  87 &nbsp;</td><td class="memItemRight" valign=bottom><b>pager</b> = ""</td></tr>
  88
  89 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o17" doxytag="user::l"></a>
  90 &nbsp;</td><td class="memItemRight" valign=bottom><b>l</b> = ""</td></tr>
  91
  92 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o18" doxytag="user::st"></a>
  93 &nbsp;</td><td class="memItemRight" valign=bottom><b>st</b> = ""</td></tr>
  94
  95 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o19" doxytag="user::postalAddress"></a>
  96 &nbsp;</td><td class="memItemRight" valign=bottom><b>postalAddress</b> = ""</td></tr>
  97
  98 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o20" doxytag="user::jpegPhoto"></a>
  99 &nbsp;</td><td class="memItemRight" valign=bottom><b>jpegPhoto</b> = "*removed*"</td></tr>
 100
 101 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o21" doxytag="user::photoData"></a>
 102 &nbsp;</td><td class="memItemRight" valign=bottom><b>photoData</b> = ""</td></tr>
 103
 104 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o22" doxytag="user::old_jpegPhoto"></a>
 105 &nbsp;</td><td class="memItemRight" valign=bottom><b>old_jpegPhoto</b> = ""</td></tr>
 106
 107 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o23" doxytag="user::old_photoData"></a>
 108 &nbsp;</td><td class="memItemRight" valign=bottom><b>old_photoData</b> = ""</td></tr>
 109
 110 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o24" doxytag="user::cert_dialog"></a>
 111 &nbsp;</td><td class="memItemRight" valign=bottom><b>cert_dialog</b> = FALSE</td></tr>
 112
 113 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o25" doxytag="user::picture_dialog"></a>
 114 &nbsp;</td><td class="memItemRight" valign=bottom><b>picture_dialog</b> = FALSE</td></tr>
 115
 116 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o26" doxytag="user::userPKCS12"></a>
 117 &nbsp;</td><td class="memItemRight" valign=bottom><b>userPKCS12</b> = ""</td></tr>
 118
 119 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o27" doxytag="user::userSMIMECertificate"></a>
 120 &nbsp;</td><td class="memItemRight" valign=bottom><b>userSMIMECertificate</b> = ""</td></tr>
 121
 122 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o28" doxytag="user::userCertificate"></a>
 123 &nbsp;</td><td class="memItemRight" valign=bottom><b>userCertificate</b> = ""</td></tr>
 124
 125 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o29" doxytag="user::certificateSerialNumber"></a>
 126 &nbsp;</td><td class="memItemRight" valign=bottom><b>certificateSerialNumber</b> = ""</td></tr>
 127
 128 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o30" doxytag="user::old_certificateSerialNumber"></a>
 129 &nbsp;</td><td class="memItemRight" valign=bottom><b>old_certificateSerialNumber</b> = ""</td></tr>
 130
 131 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o31" doxytag="user::old_userPKCS12"></a>
 132 &nbsp;</td><td class="memItemRight" valign=bottom><b>old_userPKCS12</b> = ""</td></tr>
 133
 134 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o32" doxytag="user::old_userSMIMECertificate"></a>
 135 &nbsp;</td><td class="memItemRight" valign=bottom><b>old_userSMIMECertificate</b> = ""</td></tr>
 136
 137 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o33" doxytag="user::old_userCertificate"></a>
 138 &nbsp;</td><td class="memItemRight" valign=bottom><b>old_userCertificate</b> = ""</td></tr>
 139
 140 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o34" doxytag="user::gouvernmentOrganizationalUnit"></a>
 141 &nbsp;</td><td class="memItemRight" valign=bottom><b>gouvernmentOrganizationalUnit</b> = ""</td></tr>
 142
 143 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o35" doxytag="user::houseIdentifier"></a>
 144 &nbsp;</td><td class="memItemRight" valign=bottom><b>houseIdentifier</b> = ""</td></tr>
 145
 146 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o36" doxytag="user::street"></a>
 147 &nbsp;</td><td class="memItemRight" valign=bottom><b>street</b> = ""</td></tr>
 148
 149 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o37" doxytag="user::postalCode"></a>
 150 &nbsp;</td><td class="memItemRight" valign=bottom><b>postalCode</b> = ""</td></tr>
 151
 152 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o38" doxytag="user::vocation"></a>
 153 &nbsp;</td><td class="memItemRight" valign=bottom><b>vocation</b> = ""</td></tr>
 154
 155 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o39" doxytag="user::ivbbLastDeliveryCollective"></a>
 156 &nbsp;</td><td class="memItemRight" valign=bottom><b>ivbbLastDeliveryCollective</b> = ""</td></tr>
 157
 158 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o40" doxytag="user::gouvernmentOrganizationalPersonLocality"></a>
 159 &nbsp;</td><td class="memItemRight" valign=bottom><b>gouvernmentOrganizationalPersonLocality</b> = ""</td></tr>
 160
 161 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o41" doxytag="user::gouvernmentOrganizationalUnitDescription"></a>
 162 &nbsp;</td><td class="memItemRight" valign=bottom><b>gouvernmentOrganizationalUnitDescription</b> = ""</td></tr>
 163
 164 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o42" doxytag="user::gouvernmentOrganizationalUnitSubjectArea"></a>
 165 &nbsp;</td><td class="memItemRight" valign=bottom><b>gouvernmentOrganizationalUnitSubjectArea</b> = ""</td></tr>
 166
 167 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o43" doxytag="user::functionalTitle"></a>
 168 &nbsp;</td><td class="memItemRight" valign=bottom><b>functionalTitle</b> = ""</td></tr>
 169
 170 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o44" doxytag="user::role"></a>
 171 &nbsp;</td><td class="memItemRight" valign=bottom><b>role</b> = ""</td></tr>
 172
 173 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o45" doxytag="user::publicVisible"></a>
 174 &nbsp;</td><td class="memItemRight" valign=bottom><b>publicVisible</b> = ""</td></tr>
 175
 176 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o46" doxytag="user::pw_storage"></a>
 177 &nbsp;</td><td class="memItemRight" valign=bottom><b>pw_storage</b> = "crypt"</td></tr>
 178
 179 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o47" doxytag="user::last_pw_storage"></a>
 180 &nbsp;</td><td class="memItemRight" valign=bottom><b>last_pw_storage</b> = "crypt"</td></tr>
 181
 182 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><b>attributes</b></td></tr>
 183
 184 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o49" doxytag="user::objectclasses"></a>
 185 &nbsp;</td><td class="memItemRight" valign=bottom><b>objectclasses</b> = array("person", "organizationalPerson", "inetOrgPerson", "gosaAccount")</td></tr>
 186
 187 </table>
 188 <hr><a name="_details"></a><h2>Detailed Description</h2>
 189 user plugin
 190 <p>
 191 <dl compact><dt><b>Author:</b></dt><dd>Cajus Pollmeier &lt;<a href="mailto:pollmeier@gonicus.de">pollmeier@gonicus.de</a>&gt; </dd></dl>
 192 <dl compact><dt><b>Version:</b></dt><dd>2.00 </dd></dl>
 193 <dl compact><dt><b>Date:</b></dt><dd>24.07.2003</dd></dl>
 194 This class provides the functionality to read and write all attributes relevant for person, organizationalPerson, inetOrgPerson and gosaAccount from/to the LDAP. It does syntax checking and displays the formulars required.
 195 <p>
 196 <hr><h2>Member Function Documentation</h2>
 197 <a name="a1" doxytag="user::execute"></a><p>
 198 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 199   <tr>
 200     <td class="mdRow">
 201       <table cellpadding="0" cellspacing="0" border="0">
 202         <tr>
 203           <td class="md" nowrap valign="top"> user::execute </td>
 204           <td class="md" valign="top">(&nbsp;</td>
 205           <td class="mdname1" valign="top" nowrap>          </td>
 206           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 207           <td class="md" nowrap></td>
 208         </tr>
 209
 210       </table>
 211     </td>
 212   </tr>
 213 </table>
 214 <table cellspacing=5 cellpadding=0 border=0>
 215   <tr>
 216     <td>
 217       &nbsp;
 218     </td>
 219     <td>
 220
 221 <p>
 222 execute plugin
 223 <p>
 224 Generates the html output for this node
 225 <p>
 226 Reimplemented from <a class="el" href="classplugin.html#a1">plugin</a>.    </td>
 227   </tr>
 228 </table>
 229 <hr><h2>Member Data Documentation</h2>
 230 <a name="o48" doxytag="user::attributes"></a><p>
 231 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 232   <tr>
 233     <td class="mdRow">
 234       <table cellpadding="0" cellspacing="0" border="0">
 235         <tr>
 236           <td class="md" nowrap valign="top"> user::attributes
 237       </table>
 238     </td>
 239   </tr>
 240 </table>
 241 <table cellspacing=5 cellpadding=0 border=0>
 242   <tr>
 243     <td>
 244       &nbsp;
 245     </td>
 246     <td>
 247
 248 <p>
 249 <b>Initial value:</b><div class="fragment"><pre> array(<span class="stringliteral">"sn"</span>, <span class="stringliteral">"givenName"</span>, <span class="stringliteral">"uid"</span>, <span class="stringliteral">"personalTitle"</span>, <span class="stringliteral">"academicTitle"</span>,
 250         <span class="stringliteral">"homePostalAddress"</span>, <span class="stringliteral">"homePhone"</span>, <span class="stringliteral">"labeledURI"</span>, <span class="stringliteral">"o"</span>, <span class="stringliteral">"ou"</span>,
 251         <span class="stringliteral">"departmentNumber"</span>, <span class="stringliteral">"employeeNumber"</span>, <span class="stringliteral">"employeeType"</span>, <span class="stringliteral">"l"</span>, <span class="stringliteral">"st"</span>,
 252         <span class="stringliteral">"roomNumber"</span>, <span class="stringliteral">"telephoneNumber"</span>, <span class="stringliteral">"mobile"</span>, <span class="stringliteral">"pager"</span>, <span class="stringliteral">"cn"</span>, <span class="stringliteral">"userPKCS12"</span>,
 253         <span class="stringliteral">"postalAddress"</span>, <span class="stringliteral">"facsimileTelephoneNumber"</span>, <span class="stringliteral">"userSMIMECertificate"</span>,
 254         <span class="stringliteral">"gouvernmentOrganizationalUnit"</span>, <span class="stringliteral">"houseIdentifier"</span>, <span class="stringliteral">"vocation"</span>,
 255         <span class="stringliteral">"ivbbLastDeliveryCollective"</span>, <span class="stringliteral">"gouvernmentOrganizationalPersonLocality"</span>,
 256         <span class="stringliteral">"gouvernmentOrganizationalUnitDescription"</span>, <span class="stringliteral">"postalCode"</span>, <span class="stringliteral">"street"</span>,
 257         <span class="stringliteral">"gouvernmentOrganizationalUnitSubjectArea"</span>, <span class="stringliteral">"functionalTitle"</span>,
 258         <span class="stringliteral">"role"</span>, <span class="stringliteral">"certificateSerialNumber"</span>, <span class="stringliteral">"publicVisible"</span>)
 259 </pre></div>
 260 <p>
 261 Reimplemented from <a class="el" href="classplugin.html">plugin</a>.    </td>
 262   </tr>
 263 </table>
 264 <hr>The documentation for this class was generated from the following file:<ul>
 265 <li>class_user.inc</ul>
 266 <hr size="1"><address style="align: right;"><small>Generated on Sat Jul 26 18:32:23 2003 for GOsa by
 267 <a href="http://www.doxygen.org/index.html">
 268 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 269 </a>1.3.2 </small></address>
 270 </body>
 271 </html>