<html>
<head>
<title>Docs For Class quota</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">modules</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                                                                                                                                            
                                                                                                                                                      		  [ <a href="../classtrees_modules.html" class="menu">class tree: modules</a> ]
		  [ <a href="../elementindex_modules.html" class="menu">index: modules</a> ]
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
	<div id="ric">
					<p><a href="../ric_INSTALL.html">INSTALL</a></p>
					<p><a href="../ric_README.html">README</a></p>
			</div>
      <b>Packages:</b><br />
              <a href="../li_configuration.html">configuration</a><br />
              <a href="../li_Help.html">Help</a><br />
              <a href="../li_LDAP.html">LDAP</a><br />
              <a href="../li_lib.html">lib</a><br />
              <a href="../li_lists.html">lists</a><br />
              <a href="../li_main.html">main</a><br />
              <a href="../li_modules.html">modules</a><br />
              <a href="../li_PDF.html">PDF</a><br />
              <a href="../li_profiles.html">profiles</a><br />
              <a href="../li_selfService.html">selfService</a><br />
              <a href="../li_tests.html">tests</a><br />
              <a href="../li_tools.html">tools</a><br />
              <a href="../li_types.html">types</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	  <div class="package">
			<a href="../modules/_lib---modules---account.inc.html">		account.inc
		</a><br>
			<a href="../modules/_lib---baseModule.inc.html">		baseModule.inc
		</a><br>
			<a href="../modules/_lib---createntlm.inc.html">		createntlm.inc
		</a><br>
			<a href="../modules/_templates---account---edit.php.html">		edit.php
		</a><br>
			<a href="../modules/_lib---modules---ieee802device.inc.html">		ieee802device.inc
		</a><br>
			<a href="../modules/_lib---modules---inetLocalMailRecipient.inc.html">		inetLocalMailRecipient.inc
		</a><br>
			<a href="../modules/_lib---modules---inetOrgPerson.inc.html">		inetOrgPerson.inc
		</a><br>
			<a href="../modules/_lib---modules---kolabUser.inc.html">		kolabUser.inc
		</a><br>
			<a href="../modules/_lib---lamdaemon.inc.html">		lamdaemon.inc
		</a><br>
			<a href="../modules/_lib---modules---ldapPublicKey.inc.html">		ldapPublicKey.inc
		</a><br>
			<a href="../modules/_lib---modules.inc.html">		modules.inc
		</a><br>
			<a href="../modules/_lib---modules---nisMailAlias.inc.html">		nisMailAlias.inc
		</a><br>
			<a href="../modules/_lib---modules---posixAccount.inc.html">		posixAccount.inc
		</a><br>
			<a href="../modules/_lib---modules---posixGroup.inc.html">		posixGroup.inc
		</a><br>
			<a href="../modules/_lib---modules---quota.inc.html">		quota.inc
		</a><br>
			<a href="../modules/_lib---modules---sambaAccount.inc.html">		sambaAccount.inc
		</a><br>
			<a href="../modules/_lib---modules---sambaDomain.inc.html">		sambaDomain.inc
		</a><br>
			<a href="../modules/_lib---modules---sambaGroupMapping.inc.html">		sambaGroupMapping.inc
		</a><br>
			<a href="../modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html">		sambaMungedDial.inc
		</a><br>
			<a href="../modules/_lib---modules---sambaSamAccount.inc.html">		sambaSamAccount.inc
		</a><br>
			<a href="../modules/_lib---modules---shadowAccount.inc.html">		shadowAccount.inc
		</a><br>
	  </div><br />

      
      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="../modules/account.html">account</a><br />
	    		<a href="../modules/accountContainer.html">accountContainer</a><br />
	    		<a href="../modules/baseModule.html">baseModule</a><br />
	    		<a href="../modules/ieee802Device.html">ieee802Device</a><br />
	    		<a href="../modules/inetLocalMailRecipient.html">inetLocalMailRecipient</a><br />
	    		<a href="../modules/inetOrgPerson.html">inetOrgPerson</a><br />
	    		<a href="../modules/kolabUser.html">kolabUser</a><br />
	    		<a href="../modules/ldapPublicKey.html">ldapPublicKey</a><br />
	    		<a href="../modules/nisMailAlias.html">nisMailAlias</a><br />
	    		<a href="../modules/posixAccount.html">posixAccount</a><br />
	    		<a href="../modules/posixGroup.html">posixGroup</a><br />
	    		<a href="../modules/quota.html">quota</a><br />
	    		<a href="../modules/samba3domain.html">samba3domain</a><br />
	    		<a href="../modules/sambaAccount.html">sambaAccount</a><br />
	    		<a href="../modules/sambaDomain.html">sambaDomain</a><br />
	    		<a href="../modules/sambaGroupMapping.html">sambaGroupMapping</a><br />
	    		<a href="../modules/sambaMungedDial.html">sambaMungedDial</a><br />
	    		<a href="../modules/sambaSamAccount.html">sambaSamAccount</a><br />
	    		<a href="../modules/shadowAccount.html">shadowAccount</a><br />
	    		<a href="../modules/smbHash.html">smbHash</a><br />
	  </div>

                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: quota</h1>
Source Location: /lib/modules/quota.inc<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre><a href="../modules/baseModule.html">baseModule</a>
   |
   --quota</pre><br />
<div class="description">Manages quotas for users and groups.</div><br /><br />
<h4>Author(s):</h4>
<ul>
          <li>Roland Gruber</li>
      </ul>




    

        
</td>



<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../modules/quota.html#methodcheck_profileOptions">check_profileOptions</a></li>
    <li><a href="../modules/quota.html#methoddisplay_html_attributes">display_html_attributes</a></li>
    <li><a href="../modules/quota.html#methoddoUploadPostActions">doUploadPostActions</a></li>
    <li><a href="../modules/quota.html#methodget_metaData">get_metaData</a></li>
    <li><a href="../modules/quota.html#methodget_pdfEntries">get_pdfEntries</a></li>
    <li><a href="../modules/quota.html#methodget_profileOptions">get_profileOptions</a></li>
    <li><a href="../modules/quota.html#methodget_uploadColumns">get_uploadColumns</a></li>
    <li><a href="../modules/quota.html#methodinitQuotas">initQuotas</a></li>
    <li><a href="../modules/quota.html#methodload_Messages">load_Messages</a></li>
    <li><a href="../modules/quota.html#methodload_profile">load_profile</a></li>
    <li><a href="../modules/quota.html#methodmodule_ready">module_ready</a></li>
    <li><a href="../modules/quota.html#methodpostModifyActions">postModifyActions</a></li>
    <li><a href="../modules/quota.html#methodpreDeleteActions">preDeleteActions</a></li>
    <li><a href="../modules/quota.html#methodprocess_attributes">process_attributes</a></li>
    <li><a href="../modules/quota.html#methodreplaceSpecialChars">replaceSpecialChars</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>




<td valign="top">
<h3>Inherited Variables</h3>
<div class="tags">
<h4>Class: <a href="../modules/baseModule.html">baseModule</a></h4>
<dl>
<dt>
  <a href="../modules/baseModule.html#var$attributes">baseModule::$attributes</a>
  </dt>
<dd>
   
</dd>
<dt>
  <a href="../modules/baseModule.html#var$autoAddObjectClasses">baseModule::$autoAddObjectClasses</a>
  </dt>
<dd>
   
</dd>
<dt>
  <a href="../modules/baseModule.html#var$messages">baseModule::$messages</a>
  </dt>
<dd>
   
</dd>
<dt>
  <a href="../modules/baseModule.html#var$meta">baseModule::$meta</a>
  </dt>
<dd>
   
</dd>
<dt>
  <a href="../modules/baseModule.html#var$moduleSettings">baseModule::$moduleSettings</a>
  </dt>
<dd>
   
</dd>
<dt>
  <a href="../modules/baseModule.html#var$orig">baseModule::$orig</a>
  </dt>
<dd>
   
</dd>
<dt>
  <a href="../modules/baseModule.html#var$selfServiceSettings">baseModule::$selfServiceSettings</a>
  </dt>
<dd>
   
</dd>
</dl>
</div>
</td>

<td valign="top">
<h3>Inherited Methods</h3>
<div class="tags">
<h4>Class: <a href="../modules/baseModule.html">baseModule</a></h4>
<dl>
    <dt>
    <a href="../modules/baseModule.html#method__construct">baseModule::__construct()</a>
  </dt>
  <dd>
    Creates a new base module class
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodbuild_uploadAccounts">baseModule::build_uploadAccounts()</a>
  </dt>
  <dd>
    In this function the LDAP accounts are built.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodcan_manage">baseModule::can_manage()</a>
  </dt>
  <dd>
    Returns true if this module can manage accounts of the current type, otherwise false.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodcheckSelfServiceOptions">baseModule::checkSelfServiceOptions()</a>
  </dt>
  <dd>
    Checks if all input values are correct and returns the LDAP attributes which should be changed.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodcheckSelfServiceSettings">baseModule::checkSelfServiceSettings()</a>
  </dt>
  <dd>
    Checks if the self service settings are valid.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodcheck_configOptions">baseModule::check_configOptions()</a>
  </dt>
  <dd>
    Checks input values of module settings.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodcheck_profileOptions">baseModule::check_profileOptions()</a>
  </dt>
  <dd>
    Checks input values of account profiles.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methoddelete_attributes">baseModule::delete_attributes()</a>
  </dt>
  <dd>
    This function returns an array with the same syntax as save_attributes().
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methoddisplay_html_attributes">baseModule::display_html_attributes()</a>
  </dt>
  <dd>
    This function creates meta HTML code to display the module page.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methoddisplay_html_delete">baseModule::display_html_delete()</a>
  </dt>
  <dd>
    This function creates meta HTML code which will be displayed when an account should be deleted.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methoddoUploadPostActions">baseModule::doUploadPostActions()</a>
  </dt>
  <dd>
    This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetAccountContainer">baseModule::getAccountContainer()</a>
  </dt>
  <dd>
    Returns the <a href="../modules/accountContainer.html">accountContainer</a> object.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetAttributes">baseModule::getAttributes()</a>
  </dt>
  <dd>
    Returns the LDAP attributes which are managed in this module.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetButtonStatus">baseModule::getButtonStatus()</a>
  </dt>
  <dd>
    Controls if the module button the account page is visible and activated.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetIcon">baseModule::getIcon()</a>
  </dt>
  <dd>
    Returns the path to the module icon.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetLDAPAliases">baseModule::getLDAPAliases()</a>
  </dt>
  <dd>
    Returns a list of aliases for LDAP attributes.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetManagedAttributes">baseModule::getManagedAttributes()</a>
  </dt>
  <dd>
    Returns a list of LDAP attributes which are managed by this module.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetManagedObjectClasses">baseModule::getManagedObjectClasses()</a>
  </dt>
  <dd>
    Returns a list of managed object classes for this module.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetOriginalAttributes">baseModule::getOriginalAttributes()</a>
  </dt>
  <dd>
    Returns the LDAP attributes which are managed in this module (with unchanged values).
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetRequiredExtensions">baseModule::getRequiredExtensions()</a>
  </dt>
  <dd>
    This function returns a list of PHP extensions (e.g. mhash) which are needed by this module.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetSelfServiceFields">baseModule::getSelfServiceFields()</a>
  </dt>
  <dd>
    Returns a list of possible input fields and their descriptions.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetSelfServiceOptions">baseModule::getSelfServiceOptions()</a>
  </dt>
  <dd>
    Returns the meta HTML code for each input field.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetSelfServiceSearchAttributes">baseModule::getSelfServiceSearchAttributes()</a>
  </dt>
  <dd>
    This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodgetSelfServiceSettings">baseModule::getSelfServiceSettings()</a>
  </dt>
  <dd>
    Returns a list of self service configuration settings.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_alias">baseModule::get_alias()</a>
  </dt>
  <dd>
    Returns an alias name for the module.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_configOptions">baseModule::get_configOptions()</a>
  </dt>
  <dd>
    Returns a list of configuration options.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_dependencies">baseModule::get_dependencies()</a>
  </dt>
  <dd>
    This function returns a list with all depending and conflicting modules.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_help">baseModule::get_help()</a>
  </dt>
  <dd>
    This function returns the help entry array for a specific help id.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_ldap_filter">baseModule::get_ldap_filter()</a>
  </dt>
  <dd>
    Returns an LDAP filter for the account lists
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a>
  </dt>
  <dd>
    This function provides meta data which is interpreted by baseModule.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_pdfFields">baseModule::get_pdfFields()</a>
  </dt>
  <dd>
    Returns a hashtable with all entries that may be printed out in the PDF.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_profileOptions">baseModule::get_profileOptions()</a>
  </dt>
  <dd>
    This function defines what attributes will be used in the account profiles and their appearance in the profile editor.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_RDNAttributes">baseModule::get_RDNAttributes()</a>
  </dt>
  <dd>
    Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_scope">baseModule::get_scope()</a>
  </dt>
  <dd>
    Returns the account type of this module (user, group, host)
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_uploadColumns">baseModule::get_uploadColumns()</a>
  </dt>
  <dd>
    Returns an array containing all input columns for the file upload.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodget_uploadPreDepends">baseModule::get_uploadPreDepends()</a>
  </dt>
  <dd>
    Returns a list of module names which must be processed in building the account befor this module.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodinit">baseModule::init()</a>
  </dt>
  <dd>
    Initializes the module after it became part of an <a href="../modules/accountContainer.html">accountContainer</a>
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodis_base_module">baseModule::is_base_module()</a>
  </dt>
  <dd>
    Returns true if your module is a base module and otherwise false.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodload_attributes">baseModule::load_attributes()</a>
  </dt>
  <dd>
    This function loads the LDAP attributes when an account should be loaded.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodload_Messages">baseModule::load_Messages()</a>
  </dt>
  <dd>
    This function fills the $messages variable with output messages from this module.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodload_profile">baseModule::load_profile()</a>
  </dt>
  <dd>
    This function loads the values from an account profile to the module's internal data structures.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodmodule_complete">baseModule::module_complete()</a>
  </dt>
  <dd>
    This functions is used to check if all settings for this module have been made.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodmodule_ready">baseModule::module_ready()</a>
  </dt>
  <dd>
    This function is used to check if this module page can be displayed.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodpostDeleteActions">baseModule::postDeleteActions()</a>
  </dt>
  <dd>
    Allows the module to run commands after the LDAP entry is deleted.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodpostModifyActions">baseModule::postModifyActions()</a>
  </dt>
  <dd>
    Allows the module to run commands after the LDAP entry is changed or created.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodpreDeleteActions">baseModule::preDeleteActions()</a>
  </dt>
  <dd>
    Allows the module to run commands before the LDAP entry is deleted.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodpreModifyActions">baseModule::preModifyActions()</a>
  </dt>
  <dd>
    Allows the module to run commands before the LDAP entry is changed or created.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodprocess_attributes">baseModule::process_attributes()</a>
  </dt>
  <dd>
    This function processes user input.
  </dd>
    <dt>
    <a href="../modules/baseModule.html#methodsave_attributes">baseModule::save_attributes()</a>
  </dt>
  <dd>
    Returns a list of modifications which have to be made to the LDAP account.
  </dd>
  </dl>
</div>
</td>

</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 39]<br />
Manages quotas for users and groups.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Roland Gruber</td>
  </tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />


<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">

  <hr />
	<a name="methodcheck_profileOptions"></a>
	<h3>method check_profileOptions <span class="smalllinenumber">[line 477]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array check_profileOptions(
array
$options)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Checks input values of account profiles.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>list of error messages (array(type, title, text)) to generate StatusMessages, if any</td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methodcheck_profileOptions">baseModule::check_profileOptions()</a> (Checks input values of account profiles.)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$options</b>&nbsp;&nbsp;</td>
        <td>a hash array (name =&gt; value) containing the options</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddisplay_html_attributes"></a>
	<h3>method display_html_attributes <span class="smalllinenumber">[line 337]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array display_html_attributes(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the HTML meta data for the main account page.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>HTML meta data</td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methoddisplay_html_attributes">baseModule::display_html_attributes()</a> (This function creates meta HTML code to display the module page.)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddoUploadPostActions"></a>
	<h3>method doUploadPostActions <span class="smalllinenumber">[line 631]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array doUploadPostActions(
array
$data, array
$ids, array
$failed, 
&$temp, array
$temp)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		This function executes one post upload action.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>current status  <br /> array (  <br />  'status' =&gt; 'finished' | 'inProgress'  <br />  'progress' =&gt; 0..100  <br />  'errors' =&gt; array (&lt;array of parameters for StatusMessage&gt;)  <br /> )</td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methoddoUploadPostActions">baseModule::doUploadPostActions()</a> (This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$data</b>&nbsp;&nbsp;</td>
        <td>array containing one account in each element</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$ids</b>&nbsp;&nbsp;</td>
        <td>array(&lt;column_name&gt; =&gt; &lt;column number&gt;)</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$failed</b>&nbsp;&nbsp;</td>
        <td>list of accounts which were not created successfully</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$temp</b>&nbsp;&nbsp;</td>
        <td>variable to store temporary data between two post actions</td>
      </tr>
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>&$temp</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodget_metaData"></a>
	<h3>method get_metaData <span class="smalllinenumber">[line 67]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array get_metaData(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns meta data that is interpreted by parent class<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>array with meta data</td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a> (This function provides meta data which is interpreted by baseModule.)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodget_pdfEntries"></a>
	<h3>method get_pdfEntries <span class="smalllinenumber">[line 533]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array get_pdfEntries(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the PDF entries for this module.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>list of possible PDF entries</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodget_profileOptions"></a>
	<h3>method get_profileOptions <span class="smalllinenumber">[line 420]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>profile get_profileOptions(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns a list of elements for the account profiles.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>elements</td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methodget_profileOptions">baseModule::get_profileOptions()</a> (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodget_uploadColumns"></a>
	<h3>method get_uploadColumns <span class="smalllinenumber">[line 587]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array get_uploadColumns(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns an array containing all input columns for the file upload.<br /><br /><p>Syntax:  <br /> array(  <br />  string: name,  // fixed non-translated name which is used as column name (should be of format: &lt;module name&gt;_&lt;column name&gt;)  <br />  string: description,  // short descriptive name  <br />  string: help,  // help ID  <br />  string: example,  // example value  <br />  boolean: required  // true, if user must set a value for this column  <br /> )</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>column list</td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methodget_uploadColumns">baseModule::get_uploadColumns()</a> (Returns an array containing all input columns for the file upload.)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodinitQuotas"></a>
	<h3>method initQuotas <span class="smalllinenumber">[line 154]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void initQuotas(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Initializes the quota values.<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodload_Messages"></a>
	<h3>method load_Messages <span class="smalllinenumber">[line 43]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void load_Messages(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		this functin fills the error message array with messages<br /><br /><br /><br />

	Overrides <a href="../modules/baseModule.html#methodload_Messages">baseModule::load_Messages()</a> (This function fills the $messages variable with output messages from this module.)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodload_profile"></a>
	<h3>method load_profile <span class="smalllinenumber">[line 511]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void load_profile(
array
$profile)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Loads the values of an account profile into internal variables.<br /><br /><br /><br />

	Overrides <a href="../modules/baseModule.html#methodload_profile">baseModule::load_profile()</a> (This function loads the values from an account profile to the module's internal data structures.)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$profile</b>&nbsp;&nbsp;</td>
        <td>hash array with profile values (identifier =&gt; value)</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodmodule_ready"></a>
	<h3>method module_ready <span class="smalllinenumber">[line 193]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean module_ready(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		This function is used to check if this module page can be displayed.<br /><br /><p>It returns false if a module depends on data from other modules which was not yet entered.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>true, if page can be displayed</td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methodmodule_ready">baseModule::module_ready()</a> (This function is used to check if this module page can be displayed.)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodpostModifyActions"></a>
	<h3>method postModifyActions <span class="smalllinenumber">[line 210]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void postModifyActions(
boolean
$newAccount)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Allows the module to run commands after the LDAP entry is changed or created.<br /><br /><br /><br />

	Overrides <a href="../modules/baseModule.html#methodpostModifyActions">baseModule::postModifyActions()</a> (Allows the module to run commands after the LDAP entry is changed or created.)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">boolean&nbsp;&nbsp;</td>
        <td><b>$newAccount</b>&nbsp;&nbsp;</td>
        <td>new account</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodpreDeleteActions"></a>
	<h3>method preDeleteActions <span class="smalllinenumber">[line 249]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>true, preDeleteActions(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Allows the module to run commands before the LDAP entry is deleted.<br /><br /><p>An error message should be printed if the function returns false.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>if no problems occured</td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methodpreDeleteActions">baseModule::preDeleteActions()</a> (Allows the module to run commands before the LDAP entry is deleted.)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodprocess_attributes"></a>
	<h3>method process_attributes <span class="smalllinenumber">[line 290]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array process_attributes(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Processes user input of the primary module page.<br /><br /><p>It checks if all input values are correct and updates the associated LDAP attributes.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>list of info/error messages</td>
  </tr>
</table>
</div>
<br /><br />

	Overrides <a href="../modules/baseModule.html#methodprocess_attributes">baseModule::process_attributes()</a> (This function processes user input.)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodreplaceSpecialChars"></a>
	<h3>method replaceSpecialChars <span class="smalllinenumber">[line 410]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string replaceSpecialChars(
string
$input)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Replaces special characters in HTML name values.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>output string</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$input</b>&nbsp;&nbsp;</td>
        <td>input string</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>