gosa-core/doc/devel/latex/classuser.tex

   1 \section{user Class Reference}
   2 \label{classuser}\index{user@{user}}
   3 user plugin
   4
   5
   6 Inheritance diagram for user::\begin{figure}[H]
   7 \begin{center}
   8 \leavevmode
   9 \includegraphics[height=2cm]{classuser}
  10 \end{center}
  11 \end{figure}
  12 \subsection*{Public Member Functions}
  13 \begin{CompactItemize}
  14 \item
  15 {\bf user} (\${\bf dn}=NULL)\label{classuser_a0}
  16
  17 \item
  18 {\bf execute} ()
  19 \begin{CompactList}\small\item\em execute plugin \item\end{CompactList}\item
  20 {\bf remove\_\-from\_\-parent} ()\label{classuser_a2}
  21
  22 \item
  23 {\bf save\_\-object} ()\label{classuser_a3}
  24
  25 \item
  26 {\bf save} ()\label{classuser_a4}
  27
  28 \item
  29 {\bf check} ()\label{classuser_a5}
  30
  31 \end{CompactItemize}
  32 \subsection*{Public Attributes}
  33 \begin{CompactItemize}
  34 \item
  35 {\bf base} = \char`\"{}\char`\"{}\label{classuser_o0}
  36
  37 \item
  38 {\bf cn} = \char`\"{}\char`\"{}\label{classuser_o1}
  39
  40 \item
  41 {\bf personal\-Title} = \char`\"{}\char`\"{}\label{classuser_o2}
  42
  43 \item
  44 {\bf academic\-Title} = \char`\"{}\char`\"{}\label{classuser_o3}
  45
  46 \item
  47 {\bf home\-Postal\-Address} = \char`\"{}\char`\"{}\label{classuser_o4}
  48
  49 \item
  50 {\bf home\-Phone} = \char`\"{}\char`\"{}\label{classuser_o5}
  51
  52 \item
  53 {\bf labeled\-URI} = \char`\"{}\char`\"{}\label{classuser_o6}
  54
  55 \item
  56 {\bf o} = \char`\"{}\char`\"{}\label{classuser_o7}
  57
  58 \item
  59 {\bf ou} = \char`\"{}\char`\"{}\label{classuser_o8}
  60
  61 \item
  62 {\bf department\-Number} = \char`\"{}\char`\"{}\label{classuser_o9}
  63
  64 \item
  65 {\bf employee\-Number} = \char`\"{}\char`\"{}\label{classuser_o10}
  66
  67 \item
  68 {\bf employee\-Type} = \char`\"{}\char`\"{}\label{classuser_o11}
  69
  70 \item
  71 {\bf room\-Number} = \char`\"{}\char`\"{}\label{classuser_o12}
  72
  73 \item
  74 {\bf telephone\-Number} = \char`\"{}\char`\"{}\label{classuser_o13}
  75
  76 \item
  77 {\bf facsimile\-Telephone\-Number} = \char`\"{}\char`\"{}\label{classuser_o14}
  78
  79 \item
  80 {\bf mobile} = \char`\"{}\char`\"{}\label{classuser_o15}
  81
  82 \item
  83 {\bf pager} = \char`\"{}\char`\"{}\label{classuser_o16}
  84
  85 \item
  86 {\bf l} = \char`\"{}\char`\"{}\label{classuser_o17}
  87
  88 \item
  89 {\bf st} = \char`\"{}\char`\"{}\label{classuser_o18}
  90
  91 \item
  92 {\bf postal\-Address} = \char`\"{}\char`\"{}\label{classuser_o19}
  93
  94 \item
  95 {\bf jpeg\-Photo} = \char`\"{}$\ast$removed$\ast$\char`\"{}\label{classuser_o20}
  96
  97 \item
  98 {\bf photo\-Data} = \char`\"{}\char`\"{}\label{classuser_o21}
  99
 100 \item
 101 {\bf old\_\-jpeg\-Photo} = \char`\"{}\char`\"{}\label{classuser_o22}
 102
 103 \item
 104 {\bf old\_\-photo\-Data} = \char`\"{}\char`\"{}\label{classuser_o23}
 105
 106 \item
 107 {\bf cert\_\-dialog} = FALSE\label{classuser_o24}
 108
 109 \item
 110 {\bf picture\_\-dialog} = FALSE\label{classuser_o25}
 111
 112 \item
 113 {\bf user\-PKCS12} = \char`\"{}\char`\"{}\label{classuser_o26}
 114
 115 \item
 116 {\bf user\-SMIMECertificate} = \char`\"{}\char`\"{}\label{classuser_o27}
 117
 118 \item
 119 {\bf user\-Certificate} = \char`\"{}\char`\"{}\label{classuser_o28}
 120
 121 \item
 122 {\bf certificate\-Serial\-Number} = \char`\"{}\char`\"{}\label{classuser_o29}
 123
 124 \item
 125 {\bf old\_\-certificate\-Serial\-Number} = \char`\"{}\char`\"{}\label{classuser_o30}
 126
 127 \item
 128 {\bf old\_\-user\-PKCS12} = \char`\"{}\char`\"{}\label{classuser_o31}
 129
 130 \item
 131 {\bf old\_\-user\-SMIMECertificate} = \char`\"{}\char`\"{}\label{classuser_o32}
 132
 133 \item
 134 {\bf old\_\-user\-Certificate} = \char`\"{}\char`\"{}\label{classuser_o33}
 135
 136 \item
 137 {\bf gouvernment\-Organizational\-Unit} = \char`\"{}\char`\"{}\label{classuser_o34}
 138
 139 \item
 140 {\bf house\-Identifier} = \char`\"{}\char`\"{}\label{classuser_o35}
 141
 142 \item
 143 {\bf street} = \char`\"{}\char`\"{}\label{classuser_o36}
 144
 145 \item
 146 {\bf postal\-Code} = \char`\"{}\char`\"{}\label{classuser_o37}
 147
 148 \item
 149 {\bf vocation} = \char`\"{}\char`\"{}\label{classuser_o38}
 150
 151 \item
 152 {\bf ivbb\-Last\-Delivery\-Collective} = \char`\"{}\char`\"{}\label{classuser_o39}
 153
 154 \item
 155 {\bf gouvernment\-Organizational\-Person\-Locality} = \char`\"{}\char`\"{}\label{classuser_o40}
 156
 157 \item
 158 {\bf gouvernment\-Organizational\-Unit\-Description} = \char`\"{}\char`\"{}\label{classuser_o41}
 159
 160 \item
 161 {\bf gouvernment\-Organizational\-Unit\-Subject\-Area} = \char`\"{}\char`\"{}\label{classuser_o42}
 162
 163 \item
 164 {\bf functional\-Title} = \char`\"{}\char`\"{}\label{classuser_o43}
 165
 166 \item
 167 {\bf role} = \char`\"{}\char`\"{}\label{classuser_o44}
 168
 169 \item
 170 {\bf public\-Visible} = \char`\"{}\char`\"{}\label{classuser_o45}
 171
 172 \item
 173 {\bf pw\_\-storage} = \char`\"{}crypt\char`\"{}\label{classuser_o46}
 174
 175 \item
 176 {\bf last\_\-pw\_\-storage} = \char`\"{}crypt\char`\"{}\label{classuser_o47}
 177
 178 \item
 179 {\bf attributes}
 180 \item
 181 {\bf objectclasses} = array(\char`\"{}person\char`\"{}, \char`\"{}organizational\-Person\char`\"{}, \char`\"{}inet\-Org\-Person\char`\"{}, \char`\"{}gosa\-Account\char`\"{})\label{classuser_o49}
 182
 183 \end{CompactItemize}
 184
 185
 186 \subsection{Detailed Description}
 187 user plugin
 188
 189 \begin{Desc}
 190 \item[Author:]Cajus Pollmeier $<${\tt pollmeier@gonicus.de}$>$ \end{Desc}
 191 \begin{Desc}
 192 \item[Version:]2.00 \end{Desc}
 193 \begin{Desc}
 194 \item[Date:]24.07.2003\end{Desc}
 195 This class provides the functionality to read and write all attributes relevant for person, organizational\-Person, inet\-Org\-Person and gosa\-Account from/to the LDAP. It does syntax checking and displays the formulars required.
 196
 197
 198
 199 \subsection{Member Function Documentation}
 200 \index{user@{user}!execute@{execute}}
 201 \index{execute@{execute}!user@{user}}
 202 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}user::execute ()}\label{classuser_a1}
 203
 204
 205 execute plugin
 206
 207 Generates the html output for this node
 208
 209 Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin_a1})}.
 210
 211 \subsection{Member Data Documentation}
 212 \index{user@{user}!attributes@{attributes}}
 213 \index{attributes@{attributes}!user@{user}}
 214 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}user::attributes}\label{classuser_o48}
 215
 216
 217 {\bf Initial value:}
 218
 219 \footnotesize\begin{verbatim} array("sn", "givenName", "uid", "personalTitle", "academicTitle",
 220         "homePostalAddress", "homePhone", "labeledURI", "o", "ou",
 221         "departmentNumber", "employeeNumber", "employeeType", "l", "st",
 222         "roomNumber", "telephoneNumber", "mobile", "pager", "cn", "userPKCS12",
 223         "postalAddress", "facsimileTelephoneNumber", "userSMIMECertificate",
 224         "gouvernmentOrganizationalUnit", "houseIdentifier", "vocation",
 225         "ivbbLastDeliveryCollective", "gouvernmentOrganizationalPersonLocality",
 226         "gouvernmentOrganizationalUnitDescription", "postalCode", "street",
 227         "gouvernmentOrganizationalUnitSubjectArea", "functionalTitle",
 228         "role", "certificateSerialNumber", "publicVisible")
 229 \end{verbatim}\normalsize
 230
 231
 232 Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin})}.
 233
 234 The documentation for this class was generated from the following file:\begin{CompactItemize}
 235 \item
 236 class\_\-user.inc\end{CompactItemize}