gosa-core/doc/guide/devel/latex/classplugin.tex

   1 \section{plugin Class Reference}
   2 \label{classplugin}\index{plugin@{plugin}}
   3 The plugin base class.
   4
   5
   6 Inheritance diagram for plugin::\begin{figure}[H]
   7 \begin{center}
   8 \leavevmode
   9 \includegraphics[height=2cm]{classplugin}
  10 \end{center}
  11 \end{figure}
  12 \subsection*{Public Member Functions}
  13 \begin{CompactItemize}
  14 \item
  15 {\bf plugin} (\${\bf dn}=NULL)
  16 \begin{CompactList}\small\item\em plugin constructor \item\end{CompactList}\item
  17 {\bf execute} ()
  18 \begin{CompactList}\small\item\em execute plugin \item\end{CompactList}\item
  19 {\bf remove\_\-from\_\-parent} ()\label{classplugin_a2}
  20
  21 \item
  22 {\bf save\_\-object} ()\label{classplugin_a3}
  23
  24 \item
  25 {\bf save} ()\label{classplugin_a4}
  26
  27 \item
  28 {\bf check} ()\label{classplugin_a5}
  29
  30 \item
  31 {\bf adapt\_\-from\_\-template} (\${\bf dn})\label{classplugin_a6}
  32
  33 \item
  34 {\bf password\_\-change\_\-needed} ()\label{classplugin_a7}
  35
  36 \end{CompactItemize}
  37 \subsection*{Public Attributes}
  38 \begin{CompactItemize}
  39 \item
  40 {\bf parent} = NULL
  41 \begin{CompactList}\small\item\em Reference to parent object. \item\end{CompactList}\item
  42 {\bf is\_\-account} = FALSE
  43 \begin{CompactList}\small\item\em Mark plugin as account. \item\end{CompactList}\item
  44 {\bf is\_\-template} = FALSE
  45 \begin{CompactList}\small\item\em Mark plugin as template. \item\end{CompactList}\item
  46 {\bf attrs} = array()
  47 \begin{CompactList}\small\item\em Represent temporary LDAP data. \item\end{CompactList}\item
  48 {\bf dn} = \char`\"{}\char`\"{}
  49 \begin{CompactList}\small\item\em Used standard values. \item\end{CompactList}\item
  50 {\bf uid} = \char`\"{}\char`\"{}\label{classplugin_o5}
  51
  52 \item
  53 {\bf sn} = \char`\"{}\char`\"{}\label{classplugin_o6}
  54
  55 \item
  56 {\bf given\-Name} = \char`\"{}\char`\"{}\label{classplugin_o7}
  57
  58 \item
  59 {\bf acl} = \char`\"{}$\ast$none$\ast$\char`\"{}\label{classplugin_o8}
  60
  61 \item
  62 {\bf attributes} = array()\label{classplugin_o9}
  63
  64 \item
  65 {\bf objectclasses} = array()\label{classplugin_o10}
  66
  67 \end{CompactItemize}
  68
  69
  70 \subsection{Detailed Description}
  71 The plugin base class.
  72
  73 \begin{Desc}
  74 \item[Author:]Cajus Pollmeier $<${\tt pollmeier@gonicus.de}$>$ \end{Desc}
  75 \begin{Desc}
  76 \item[Version:]2.00 \end{Desc}
  77 \begin{Desc}
  78 \item[Date:]24.07.2003\end{Desc}
  79 This is the base class for all plugins. It can be used standalone or can be included by the tabs class. All management should be done within this class. Extend your plugins from this class.
  80
  81
  82
  83 \subsection{Constructor \& Destructor Documentation}
  84 \index{plugin@{plugin}!plugin@{plugin}}
  85 \index{plugin@{plugin}!plugin@{plugin}}
  86 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}plugin::plugin (\$ {\em dn} = NULL)}\label{classplugin_a0}
  87
  88
  89 plugin constructor
  90
  91 If 'dn' is set, the node loads the given 'dn' from LDAP
  92
  93 \begin{Desc}
  94 \item[Parameters:]
  95 \begin{description}
  96 \item[{\em dn}]Distinguished name to initialize plugin from \end{description}
  97 \end{Desc}
  98 \begin{Desc}
  99 \item[See also:]{\bf plugin()} \end{Desc}
 100
 101
 102 \subsection{Member Function Documentation}
 103 \index{plugin@{plugin}!execute@{execute}}
 104 \index{execute@{execute}!plugin@{plugin}}
 105 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}plugin::execute ()}\label{classplugin_a1}
 106
 107
 108 execute plugin
 109
 110 Generates the html output for this node
 111
 112 Reimplemented in {\bf mail\-Account} {\rm (p.\,\pageref{classmailAccount_a4})}, {\bf posix\-Account} {\rm (p.\,\pageref{classposixAccount_a1})}, and {\bf user} {\rm (p.\,\pageref{classuser_a1})}.
 113
 114 \subsection{Member Data Documentation}
 115 \index{plugin@{plugin}!attrs@{attrs}}
 116 \index{attrs@{attrs}!plugin@{plugin}}
 117 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::attrs} = array()}\label{classplugin_o3}
 118
 119
 120 Represent temporary LDAP data.
 121
 122 This is only used internally. \index{plugin@{plugin}!dn@{dn}}
 123 \index{dn@{dn}!plugin@{plugin}}
 124 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::dn} = \char`\"{}\char`\"{}}\label{classplugin_o4}
 125
 126
 127 Used standard values.
 128
 129 dn \index{plugin@{plugin}!is_account@{is\_\-account}}
 130 \index{is_account@{is\_\-account}!plugin@{plugin}}
 131 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::is\_\-account} = FALSE}\label{classplugin_o1}
 132
 133
 134 Mark plugin as account.
 135
 136 Defines whether this plugin is defined as an account or not. This has consequences for the plugin to be saved from tab mode. If it is set to 'FALSE' the tab will call the delete function, else the save function. Should be set to 'TRUE' if the construtor detects a valid LDAP object.
 137
 138 \begin{Desc}
 139 \item[See also:]{\bf plugin::plugin()} \end{Desc}
 140 \index{plugin@{plugin}!is_template@{is\_\-template}}
 141 \index{is_template@{is\_\-template}!plugin@{plugin}}
 142 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::is\_\-template} = FALSE}\label{classplugin_o2}
 143
 144
 145 Mark plugin as template.
 146
 147 Defines whether we are creating a template or a normal object. Has conseqences on the way {\bf execute()} shows the formular and how save() puts the data to LDAP.
 148
 149 \begin{Desc}
 150 \item[See also:]plugin::save() {\bf plugin::execute()} \end{Desc}
 151 \index{plugin@{plugin}!parent@{parent}}
 152 \index{parent@{parent}!plugin@{plugin}}
 153 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::parent} = NULL}\label{classplugin_o0}
 154
 155
 156 Reference to parent object.
 157
 158 This variable is used when the plugin is included in tabs and keeps reference to the tab class. Communication to other tabs is possible by 'name'. So the 'fax' plugin can ask the 'userinfo' plugin for the fax number.
 159
 160 \begin{Desc}
 161 \item[See also:]tab \end{Desc}
 162
 163
 164 The documentation for this class was generated from the following file:\begin{CompactItemize}
 165 \item
 166 plugin.inc\end{CompactItemize}