Code

Removed PHP5 specific definitions
[gosa.git] / doc / latex / classposixAccount.tex
1 \section{posix\-Account Class Reference}
2 \label{classposixAccount}\index{posixAccount@{posixAccount}}
3 posix\-Account plugin  
6 Inheritance diagram for posix\-Account::\begin{figure}[H]
7 \begin{center}
8 \leavevmode
9 \includegraphics[height=2cm]{classposixAccount}
10 \end{center}
11 \end{figure}
12 \subsection*{Public Member Functions}
13 \begin{CompactItemize}
14 \item 
15 {\bf posix\-Account} (\${\bf dn}=NULL)\label{classposixAccount_a0}
17 \item 
18 {\bf execute} ()
19 \begin{CompactList}\small\item\em execute plugin \item\end{CompactList}\item 
20 {\bf remove\_\-from\_\-parent} ()\label{classposixAccount_a2}
22 \item 
23 {\bf save\_\-object} ()\label{classposixAccount_a3}
25 \item 
26 {\bf save} ()\label{classposixAccount_a4}
28 \item 
29 {\bf check} ()\label{classposixAccount_a5}
31 \item 
32 {\bf add\-Group} (\$groups)\label{classposixAccount_a6}
34 \item 
35 {\bf del\-Group} (\$groups)\label{classposixAccount_a7}
37 \item 
38 {\bf adapt\_\-from\_\-template} (\${\bf dn})\label{classposixAccount_a8}
40 \end{CompactItemize}
41 \subsection*{Public Attributes}
42 \begin{CompactItemize}
43 \item 
44 {\bf home\-Directory} = \char`\"{}\char`\"{}\label{classposixAccount_o0}
46 \item 
47 {\bf login\-Shell} = \char`\"{}/bin/bash\char`\"{}\label{classposixAccount_o1}
49 \item 
50 {\bf uid\-Number} = \char`\"{}\char`\"{}\label{classposixAccount_o2}
52 \item 
53 {\bf gid\-Number} = \char`\"{}\char`\"{}\label{classposixAccount_o3}
55 \item 
56 {\bf gecos} = \char`\"{}\char`\"{}\label{classposixAccount_o4}
58 \item 
59 {\bf shadow\-Min} = \char`\"{}0\char`\"{}\label{classposixAccount_o5}
61 \item 
62 {\bf shadow\-Max} = \char`\"{}0\char`\"{}\label{classposixAccount_o6}
64 \item 
65 {\bf shadow\-Warning} = \char`\"{}0\char`\"{}\label{classposixAccount_o7}
67 \item 
68 {\bf shadow\-Last\-Change} = \char`\"{}0\char`\"{}\label{classposixAccount_o8}
70 \item 
71 {\bf shadow\-Inactive} = \char`\"{}0\char`\"{}\label{classposixAccount_o9}
73 \item 
74 {\bf shadow\-Expire} = \char`\"{}0\char`\"{}\label{classposixAccount_o10}
76 \item 
77 {\bf gosa\-Default\-Printer} = \char`\"{}\char`\"{}\label{classposixAccount_o11}
79 \item 
80 {\bf gosa\-Default\-Language} = \char`\"{}\char`\"{}\label{classposixAccount_o12}
82 \item 
83 {\bf gosa\-Host\-ACL} = array()\label{classposixAccount_o13}
85 \item 
86 {\bf status} = \char`\"{}\char`\"{}\label{classposixAccount_o14}
88 \item 
89 {\bf login\-Shell\-List} = array()\label{classposixAccount_o15}
91 \item 
92 {\bf group\-Membership} = array()\label{classposixAccount_o16}
94 \item 
95 {\bf saved\-Group\-Membership} = array()\label{classposixAccount_o17}
97 \item 
98 {\bf saved\-Uid\-Number} = \char`\"{}\char`\"{}\label{classposixAccount_o18}
100 \item 
101 {\bf saved\-Gid\-Number} = \char`\"{}\char`\"{}\label{classposixAccount_o19}
103 \item 
104 {\bf use\_\-shadow\-Min} = \char`\"{}0\char`\"{}\label{classposixAccount_o20}
106 \item 
107 {\bf use\_\-shadow\-Max} = \char`\"{}0\char`\"{}\label{classposixAccount_o21}
109 \item 
110 {\bf use\_\-shadow\-Warning} = \char`\"{}0\char`\"{}\label{classposixAccount_o22}
112 \item 
113 {\bf use\_\-shadow\-Inactive} = \char`\"{}0\char`\"{}\label{classposixAccount_o23}
115 \item 
116 {\bf use\_\-shadow\-Expire} = \char`\"{}0\char`\"{}\label{classposixAccount_o24}
118 \item 
119 {\bf must\_\-change\_\-password} = \char`\"{}0\char`\"{}\label{classposixAccount_o25}
121 \item 
122 {\bf force\_\-ids} = 0\label{classposixAccount_o26}
124 \item 
125 {\bf printer\-List} = array()\label{classposixAccount_o27}
127 \item 
128 {\bf group\_\-dialog} = FALSE\label{classposixAccount_o28}
130 \item 
131 {\bf hosts\_\-dialog} = FALSE\label{classposixAccount_o29}
133 \item 
134 {\bf attributes}
135 \item 
136 {\bf objectclasses} = array(\char`\"{}posix\-Account\char`\"{}, \char`\"{}shadow\-Account\char`\"{})\label{classposixAccount_o31}
138 \end{CompactItemize}
141 \subsection{Detailed Description}
142 posix\-Account plugin 
144 \begin{Desc}
145 \item[Author:]Cajus Pollmeier $<${\tt pollmeier@gonicus.de}$>$ \end{Desc}
146 \begin{Desc}
147 \item[Version:]2.00 \end{Desc}
148 \begin{Desc}
149 \item[Date:]24.07.2003\end{Desc}
150 This class provides the functionality to read and write all attributes relevant for posix\-Accounts and shadow\-Accounts from/to the LDAP. It does syntax checking and displays the formulars required. 
154 \subsection{Member Function Documentation}
155 \index{posixAccount@{posix\-Account}!execute@{execute}}
156 \index{execute@{execute}!posixAccount@{posix\-Account}}
157 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}posix\-Account::execute ()}\label{classposixAccount_a1}
160 execute plugin 
162 Generates the html output for this node 
164 Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin_a1})}.
166 \subsection{Member Data Documentation}
167 \index{posixAccount@{posix\-Account}!attributes@{attributes}}
168 \index{attributes@{attributes}!posixAccount@{posix\-Account}}
169 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}posix\-Account::attributes}\label{classposixAccount_o30}
172 {\bf Initial value:}
174 \footnotesize\begin{verbatim} array("homeDirectory", "loginShell", "uidNumber", "gidNumber", "gecos",
175                         "shadowMin", "shadowMax", "shadowWarning", "shadowInactive", "shadowLastChange",
176                         "shadowExpire", "gosaDefaultPrinter", "gosaDefaultLanguage", "uid")
177 \end{verbatim}\normalsize 
180 Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin})}.
182 The documentation for this class was generated from the following file:\begin{CompactItemize}
183 \item 
184 class\_\-posix\-Account.inc\end{CompactItemize}