doc/guide/devel/html/classplugin.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: plugin 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>plugin Class Reference</h1>The plugin base class.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <p>Inheritance diagram for plugin:
  12 <p><center><img src="classplugin.png" usemap="#plugin_map" border="0" alt=""></center>
  13 <map name="plugin_map">
  14 <area href="classmailAccount.html" alt="mailAccount" shape="rect" coords="0,56,88,80">
  15 <area href="classposixAccount.html" alt="posixAccount" shape="rect" coords="98,56,186,80">
  16 <area href="classuser.html" alt="user" shape="rect" coords="196,56,284,80">
  17 </map>
  18 <a href="classplugin-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  19 <tr><td></td></tr>
  20 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  21 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classplugin.html#a0">plugin</a> ($<a class="el" href="classplugin.html#o4">dn</a>=NULL)</td></tr>
  22
  23 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">plugin constructor </em> <a href="#a0"></a><em><br><br></td></tr>
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classplugin.html#a1">execute</a> ()</td></tr>
  25
  26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">execute plugin </em> <a href="#a1"></a><em><br><br></td></tr>
  27 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="plugin::remove_from_parent"></a>
  28 &nbsp;</td><td class="memItemRight" valign=bottom><b>remove_from_parent</b> ()</td></tr>
  29
  30 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="plugin::save_object"></a>
  31 &nbsp;</td><td class="memItemRight" valign=bottom><b>save_object</b> ()</td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a4" doxytag="plugin::save"></a>
  34 &nbsp;</td><td class="memItemRight" valign=bottom><b>save</b> ()</td></tr>
  35
  36 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="plugin::check"></a>
  37 &nbsp;</td><td class="memItemRight" valign=bottom><b>check</b> ()</td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a6" doxytag="plugin::adapt_from_template"></a>
  40 &nbsp;</td><td class="memItemRight" valign=bottom><b>adapt_from_template</b> ($<a class="el" href="classplugin.html#o4">dn</a>)</td></tr>
  41
  42 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="a7" doxytag="plugin::password_change_needed"></a>
  43 &nbsp;</td><td class="memItemRight" valign=bottom><b>password_change_needed</b> ()</td></tr>
  44
  45 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  46 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classplugin.html#o0">parent</a> = NULL</td></tr>
  47
  48 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference to parent object. </em> <a href="#o0"></a><em><br><br></td></tr>
  49 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classplugin.html#o1">is_account</a> = FALSE</td></tr>
  50
  51 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mark plugin as account. </em> <a href="#o1"></a><em><br><br></td></tr>
  52 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classplugin.html#o2">is_template</a> = FALSE</td></tr>
  53
  54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mark plugin as template. </em> <a href="#o2"></a><em><br><br></td></tr>
  55 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classplugin.html#o3">attrs</a> = array()</td></tr>
  56
  57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represent temporary LDAP data. </em> <a href="#o3"></a><em><br><br></td></tr>
  58 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classplugin.html#o4">dn</a> = ""</td></tr>
  59
  60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used standard values. </em> <a href="#o4"></a><em><br><br></td></tr>
  61 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o5" doxytag="plugin::uid"></a>
  62 &nbsp;</td><td class="memItemRight" valign=bottom><b>uid</b> = ""</td></tr>
  63
  64 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o6" doxytag="plugin::sn"></a>
  65 &nbsp;</td><td class="memItemRight" valign=bottom><b>sn</b> = ""</td></tr>
  66
  67 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o7" doxytag="plugin::givenName"></a>
  68 &nbsp;</td><td class="memItemRight" valign=bottom><b>givenName</b> = ""</td></tr>
  69
  70 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o8" doxytag="plugin::acl"></a>
  71 &nbsp;</td><td class="memItemRight" valign=bottom><b>acl</b> = "*none*"</td></tr>
  72
  73 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o9" doxytag="plugin::attributes"></a>
  74 &nbsp;</td><td class="memItemRight" valign=bottom><b>attributes</b> = array()</td></tr>
  75
  76 <tr><td class="memItemLeft" nowrap align=right valign=top><a name="o10" doxytag="plugin::objectclasses"></a>
  77 &nbsp;</td><td class="memItemRight" valign=bottom><b>objectclasses</b> = array()</td></tr>
  78
  79 </table>
  80 <hr><a name="_details"></a><h2>Detailed Description</h2>
  81 The plugin base class.
  82 <p>
  83 <dl compact><dt><b>Author:</b></dt><dd>Cajus Pollmeier &lt;<a href="mailto:pollmeier@gonicus.de">pollmeier@gonicus.de</a>&gt; </dd></dl>
  84 <dl compact><dt><b>Version:</b></dt><dd>2.00 </dd></dl>
  85 <dl compact><dt><b>Date:</b></dt><dd>24.07.2003</dd></dl>
  86 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.
  87 <p>
  88 <hr><h2>Constructor &amp; Destructor Documentation</h2>
  89 <a name="a0" doxytag="plugin::plugin"></a><p>
  90 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  91   <tr>
  92     <td class="mdRow">
  93       <table cellpadding="0" cellspacing="0" border="0">
  94         <tr>
  95           <td class="md" nowrap valign="top"> plugin::plugin </td>
  96           <td class="md" valign="top">(&nbsp;</td>
  97           <td class="md" nowrap valign="top">$&nbsp;</td>
  98           <td class="mdname1" valign="top" nowrap> <em>dn</em> = NULL          </td>
  99           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 100           <td class="md" nowrap></td>
 101         </tr>
 102
 103       </table>
 104     </td>
 105   </tr>
 106 </table>
 107 <table cellspacing=5 cellpadding=0 border=0>
 108   <tr>
 109     <td>
 110       &nbsp;
 111     </td>
 112     <td>
 113
 114 <p>
 115 plugin constructor
 116 <p>
 117 If 'dn' is set, the node loads the given 'dn' from LDAP<p>
 118 <dl compact><dt><b>Parameters:</b></dt><dd>
 119   <table border="0" cellspacing="2" cellpadding="0">
 120     <tr><td valign=top><em>dn</em>&nbsp;</td><td>Distinguished name to initialize plugin from </td></tr>
 121   </table>
 122 </dl>
 123 <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classplugin.html#a0">plugin()</a> </dd></dl>
 124     </td>
 125   </tr>
 126 </table>
 127 <hr><h2>Member Function Documentation</h2>
 128 <a name="a1" doxytag="plugin::execute"></a><p>
 129 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 130   <tr>
 131     <td class="mdRow">
 132       <table cellpadding="0" cellspacing="0" border="0">
 133         <tr>
 134           <td class="md" nowrap valign="top"> plugin::execute </td>
 135           <td class="md" valign="top">(&nbsp;</td>
 136           <td class="mdname1" valign="top" nowrap>          </td>
 137           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 138           <td class="md" nowrap></td>
 139         </tr>
 140
 141       </table>
 142     </td>
 143   </tr>
 144 </table>
 145 <table cellspacing=5 cellpadding=0 border=0>
 146   <tr>
 147     <td>
 148       &nbsp;
 149     </td>
 150     <td>
 151
 152 <p>
 153 execute plugin
 154 <p>
 155 Generates the html output for this node
 156 <p>
 157 Reimplemented in <a class="el" href="classmailAccount.html#a4">mailAccount</a>, <a class="el" href="classposixAccount.html#a1">posixAccount</a>, and <a class="el" href="classuser.html#a1">user</a>.    </td>
 158   </tr>
 159 </table>
 160 <hr><h2>Member Data Documentation</h2>
 161 <a name="o3" doxytag="plugin::attrs"></a><p>
 162 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 163   <tr>
 164     <td class="mdRow">
 165       <table cellpadding="0" cellspacing="0" border="0">
 166         <tr>
 167           <td class="md" nowrap valign="top"> <a class="el" href="classplugin.html#o3">plugin::attrs</a> = array()
 168       </table>
 169     </td>
 170   </tr>
 171 </table>
 172 <table cellspacing=5 cellpadding=0 border=0>
 173   <tr>
 174     <td>
 175       &nbsp;
 176     </td>
 177     <td>
 178
 179 <p>
 180 Represent temporary LDAP data.
 181 <p>
 182 This is only used internally.     </td>
 183   </tr>
 184 </table>
 185 <a name="o4" doxytag="plugin::dn"></a><p>
 186 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 187   <tr>
 188     <td class="mdRow">
 189       <table cellpadding="0" cellspacing="0" border="0">
 190         <tr>
 191           <td class="md" nowrap valign="top"> <a class="el" href="classplugin.html#o4">plugin::dn</a> = ""
 192       </table>
 193     </td>
 194   </tr>
 195 </table>
 196 <table cellspacing=5 cellpadding=0 border=0>
 197   <tr>
 198     <td>
 199       &nbsp;
 200     </td>
 201     <td>
 202
 203 <p>
 204 Used standard values.
 205 <p>
 206 dn     </td>
 207   </tr>
 208 </table>
 209 <a name="o1" doxytag="plugin::is_account"></a><p>
 210 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 211   <tr>
 212     <td class="mdRow">
 213       <table cellpadding="0" cellspacing="0" border="0">
 214         <tr>
 215           <td class="md" nowrap valign="top"> <a class="el" href="classplugin.html#o1">plugin::is_account</a> = FALSE
 216       </table>
 217     </td>
 218   </tr>
 219 </table>
 220 <table cellspacing=5 cellpadding=0 border=0>
 221   <tr>
 222     <td>
 223       &nbsp;
 224     </td>
 225     <td>
 226
 227 <p>
 228 Mark plugin as account.
 229 <p>
 230 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.<p>
 231 <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classplugin.html#a0">plugin::plugin()</a> </dd></dl>
 232     </td>
 233   </tr>
 234 </table>
 235 <a name="o2" doxytag="plugin::is_template"></a><p>
 236 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 237   <tr>
 238     <td class="mdRow">
 239       <table cellpadding="0" cellspacing="0" border="0">
 240         <tr>
 241           <td class="md" nowrap valign="top"> <a class="el" href="classplugin.html#o2">plugin::is_template</a> = FALSE
 242       </table>
 243     </td>
 244   </tr>
 245 </table>
 246 <table cellspacing=5 cellpadding=0 border=0>
 247   <tr>
 248     <td>
 249       &nbsp;
 250     </td>
 251     <td>
 252
 253 <p>
 254 Mark plugin as template.
 255 <p>
 256 Defines whether we are creating a template or a normal object. Has conseqences on the way <a class="el" href="classplugin.html#a1">execute()</a> shows the formular and how save() puts the data to LDAP.<p>
 257 <dl compact><dt><b>See also:</b></dt><dd>plugin::save() <a class="el" href="classplugin.html#a1">plugin::execute()</a> </dd></dl>
 258     </td>
 259   </tr>
 260 </table>
 261 <a name="o0" doxytag="plugin::parent"></a><p>
 262 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 263   <tr>
 264     <td class="mdRow">
 265       <table cellpadding="0" cellspacing="0" border="0">
 266         <tr>
 267           <td class="md" nowrap valign="top"> <a class="el" href="classplugin.html#o0">plugin::parent</a> = NULL
 268       </table>
 269     </td>
 270   </tr>
 271 </table>
 272 <table cellspacing=5 cellpadding=0 border=0>
 273   <tr>
 274     <td>
 275       &nbsp;
 276     </td>
 277     <td>
 278
 279 <p>
 280 Reference to parent object.
 281 <p>
 282 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.<p>
 283 <dl compact><dt><b>See also:</b></dt><dd>tab </dd></dl>
 284     </td>
 285   </tr>
 286 </table>
 287 <hr>The documentation for this class was generated from the following file:<ul>
 288 <li>plugin.inc</ul>
 289 <hr size="1"><address style="align: right;"><small>Generated on Sat Jul 26 18:32:23 2003 for GOsa by
 290 <a href="http://www.doxygen.org/index.html">
 291 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 292 </a>1.3.2 </small></address>
 293 </body>
 294 </html>