Code

* Created "old" branch and moved stuff
[gosa.git] / branches / old / gosa-core / doc / devel / html / classuser.html
diff --git a/branches/old/gosa-core/doc/devel/html/classuser.html b/branches/old/gosa-core/doc/devel/html/classuser.html
new file mode 100644 (file)
index 0000000..38102e8
--- /dev/null
@@ -0,0 +1,271 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>GOsa: user class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.2 -->
+<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>
+<h1>user Class Reference</h1>user plugin  
+<a href="#_details">More...</a>
+<p>
+<p>Inheritance diagram for user:
+<p><center><img src="classuser.png" usemap="#user_map" border="0" alt=""></center>
+<map name="user_map">
+<area href="classplugin.html" alt="plugin" shape="rect" coords="0,0,46,24">
+</map>
+<a href="classuser-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a0" doxytag="user::user"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>user</b> ($<a class="el" href="classplugin.html#o4">dn</a>=NULL)</td></tr>
+
+<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>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">execute plugin </em> <a href="#a1"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="user::remove_from_parent"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>remove_from_parent</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="user::save_object"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>save_object</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a4" doxytag="user::save"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>save</b> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="user::check"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>check</b> ()</td></tr>
+
+<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o0" doxytag="user::base"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>base</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o1" doxytag="user::cn"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>cn</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o2" doxytag="user::personalTitle"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>personalTitle</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o3" doxytag="user::academicTitle"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>academicTitle</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o4" doxytag="user::homePostalAddress"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>homePostalAddress</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o5" doxytag="user::homePhone"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>homePhone</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o6" doxytag="user::labeledURI"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>labeledURI</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o7" doxytag="user::o"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>o</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o8" doxytag="user::ou"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>ou</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o9" doxytag="user::departmentNumber"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>departmentNumber</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o10" doxytag="user::employeeNumber"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>employeeNumber</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o11" doxytag="user::employeeType"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>employeeType</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o12" doxytag="user::roomNumber"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>roomNumber</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o13" doxytag="user::telephoneNumber"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>telephoneNumber</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o14" doxytag="user::facsimileTelephoneNumber"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>facsimileTelephoneNumber</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o15" doxytag="user::mobile"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>mobile</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o16" doxytag="user::pager"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>pager</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o17" doxytag="user::l"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>l</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o18" doxytag="user::st"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>st</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o19" doxytag="user::postalAddress"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>postalAddress</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o20" doxytag="user::jpegPhoto"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>jpegPhoto</b> = "*removed*"</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o21" doxytag="user::photoData"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>photoData</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o22" doxytag="user::old_jpegPhoto"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>old_jpegPhoto</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o23" doxytag="user::old_photoData"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>old_photoData</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o24" doxytag="user::cert_dialog"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>cert_dialog</b> = FALSE</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o25" doxytag="user::picture_dialog"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>picture_dialog</b> = FALSE</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o26" doxytag="user::userPKCS12"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>userPKCS12</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o27" doxytag="user::userSMIMECertificate"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>userSMIMECertificate</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o28" doxytag="user::userCertificate"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>userCertificate</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o29" doxytag="user::certificateSerialNumber"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>certificateSerialNumber</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o30" doxytag="user::old_certificateSerialNumber"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>old_certificateSerialNumber</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o31" doxytag="user::old_userPKCS12"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>old_userPKCS12</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o32" doxytag="user::old_userSMIMECertificate"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>old_userSMIMECertificate</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o33" doxytag="user::old_userCertificate"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>old_userCertificate</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o34" doxytag="user::gouvernmentOrganizationalUnit"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gouvernmentOrganizationalUnit</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o35" doxytag="user::houseIdentifier"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>houseIdentifier</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o36" doxytag="user::street"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>street</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o37" doxytag="user::postalCode"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>postalCode</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o38" doxytag="user::vocation"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>vocation</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o39" doxytag="user::ivbbLastDeliveryCollective"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>ivbbLastDeliveryCollective</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o40" doxytag="user::gouvernmentOrganizationalPersonLocality"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gouvernmentOrganizationalPersonLocality</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o41" doxytag="user::gouvernmentOrganizationalUnitDescription"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gouvernmentOrganizationalUnitDescription</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o42" doxytag="user::gouvernmentOrganizationalUnitSubjectArea"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>gouvernmentOrganizationalUnitSubjectArea</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o43" doxytag="user::functionalTitle"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>functionalTitle</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o44" doxytag="user::role"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>role</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o45" doxytag="user::publicVisible"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>publicVisible</b> = ""</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o46" doxytag="user::pw_storage"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>pw_storage</b> = "crypt"</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o47" doxytag="user::last_pw_storage"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>last_pw_storage</b> = "crypt"</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><b>attributes</b></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top><a name="o49" doxytag="user::objectclasses"></a>
+&nbsp;</td><td class="memItemRight" valign=bottom><b>objectclasses</b> = array("person", "organizationalPerson", "inetOrgPerson", "gosaAccount")</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+user plugin 
+<p>
+<dl compact><dt><b>Author:</b></dt><dd>Cajus Pollmeier &lt;<a href="mailto:pollmeier@gonicus.de">pollmeier@gonicus.de</a>&gt; </dd></dl>
+<dl compact><dt><b>Version:</b></dt><dd>2.00 </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>24.07.2003</dd></dl>
+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. 
+<p>
+<hr><h2>Member Function Documentation</h2>
+<a name="a1" doxytag="user::execute"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> user::execute </td>
+          <td class="md" valign="top">(&nbsp;</td>
+          <td class="mdname1" valign="top" nowrap>          </td>
+          <td class="md" valign="top">&nbsp;)&nbsp;</td>
+          <td class="md" nowrap></td>
+        </tr>
+
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+execute plugin 
+<p>
+Generates the html output for this node 
+<p>
+Reimplemented from <a class="el" href="classplugin.html#a1">plugin</a>.    </td>
+  </tr>
+</table>
+<hr><h2>Member Data Documentation</h2>
+<a name="o48" doxytag="user::attributes"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> user::attributes
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+<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>,
+        <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>,
+        <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>,
+        <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>,
+        <span class="stringliteral">"postalAddress"</span>, <span class="stringliteral">"facsimileTelephoneNumber"</span>, <span class="stringliteral">"userSMIMECertificate"</span>,
+        <span class="stringliteral">"gouvernmentOrganizationalUnit"</span>, <span class="stringliteral">"houseIdentifier"</span>, <span class="stringliteral">"vocation"</span>,
+        <span class="stringliteral">"ivbbLastDeliveryCollective"</span>, <span class="stringliteral">"gouvernmentOrganizationalPersonLocality"</span>,
+        <span class="stringliteral">"gouvernmentOrganizationalUnitDescription"</span>, <span class="stringliteral">"postalCode"</span>, <span class="stringliteral">"street"</span>,
+        <span class="stringliteral">"gouvernmentOrganizationalUnitSubjectArea"</span>, <span class="stringliteral">"functionalTitle"</span>,
+        <span class="stringliteral">"role"</span>, <span class="stringliteral">"certificateSerialNumber"</span>, <span class="stringliteral">"publicVisible"</span>)
+</pre></div>
+<p>
+Reimplemented from <a class="el" href="classplugin.html">plugin</a>.    </td>
+  </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li>class_user.inc</ul>
+<hr size="1"><address style="align: right;"><small>Generated on Sat Jul 26 18:32:23 2003 for GOsa by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
+</a>1.3.2 </small></address>
+</body>
+</html>