<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>Type HowTo - General type options</title> <link rel="stylesheet" type="text/css" href="style/layout.css"> <link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico"> </head> <body> <div style="text-align: center;"> <h1>Type HowTo - General type options<br> </h1> <br> <br> <div style="text-align: left;"><br> <h2>1. Alias name</h2> The type name is very limited, therefore every type has an <span style="font-style: italic;">alias name</span>. This <span style="font-style: italic;">alias name</span> has no limitations and can be translated. It may contain special characters but make sure that it does not contain HTML special characters like "<".<br> <br> The <span style="font-style: italic;">alias name</span> is specified with <span style="font-weight: bold;">getAlias()</span><span style="font-weight: bold;"></span>.<br> <br> <span style="font-weight: bold; text-decoration: underline;">Example:</span><br style="font-weight: bold; text-decoration: underline;"> <br> Our <span style="font-style: italic;">smbDomain</span> type will get the alias "Samba domains".<br> <br> <table style="width: 100%; text-align: left;" class="mod-code" border="0" cellpadding="2" cellspacing="2"> <tbody> <tr> <td style="vertical-align: top;"> /**<br> * Returns the alias name of this account type.<br> *<br> * @return string alias name<br> */<br> <span style="font-weight: bold;">function</span> <span style="color: rgb(255, 0, 0);">getAlias()</span> {<br> return _("Samba domains");<br> }<br> </td> </tr> </tbody> </table> <br> <br> <h2>2. Description<br> </h2> Each type has a description so that the user knows what accounts he can manage with that type. The description is displayed in the LAM configuration editor.<br> <br> The description is specified with <span style="font-weight: bold;">getDescription()</span><span style="font-weight: bold;"></span>.<br> <br> <span style="font-weight: bold; text-decoration: underline;">Example:</span><br style="font-weight: bold; text-decoration: underline;"> <br> Our <span style="font-style: italic;">smbDomain</span> type has the description "Samba 3 domain entries".<br> <br> <table style="width: 100%; text-align: left;" class="mod-code" border="0" cellpadding="2" cellspacing="2"> <tbody> <tr> <td style="vertical-align: top;"> /**<br> * Returns the description of this account type.<br> *<br> * @return string description<br> */<br> <span style="font-weight: bold;">function</span> <span style="color: rgb(255, 0, 0);">getDescription()</span> {<br> return _("Samba 3 domain entries");<br> }<br> </td> </tr> </tbody> </table> <br> <br> <span style="font-weight: bold;"></span> <h2><span style="font-weight: bold;"></span></h2> </div> </div> </body> </html>