lib/modules/systemQuotas.inc
Properties
Description
Manages user quotas with the object class systemQuotas.Classes
systemQuotas
Description
Manages user quotas with the object class systemQuotas.It implements the complete module interface and uses meta-data provided by the account modules for its functions.
Location and naming of modules
All LAM modules are placed in lib/modules/ and are named "
You can avoid to override many functions by using {@link get_metaData()}.
All module classes should extend the baseModule class.
Methods
build_uploadAccounts, checkQuota, check_profileOptions, display_html_attributes, get_metaData, get_pdfEntries, load_Messages, load_profile, process_attributes,build_uploadAccounts( array $rawAccounts, array $ids, array $partialAccounts, array $selectedModules, ) : array
Description
In this function the LDAP account is built up.Arguments
| Name | Type | Description | Default | 
|---|---|---|---|
| $rawAccounts | array | list of hash arrays (name => value) from user input | |
| $ids | array | list of IDs for column position (e.g. "posixAccount_uid" => 5) | |
| $partialAccounts | array | list of hash arrays (name => value) which are later added to LDAP | |
| $selectedModules | array | list of selected account modules | 
Return value
| Type | Description | 
|---|---|
| array | list of error messages if any | 
checkQuota( String $path, int $softBlock, int $hardBlock, int $softInode, int $hardInode, boolean $uploadIndex = null, ) : array
Description
Checks if the quota parameters are valid.Arguments
| Name | Type | Description | Default | 
|---|---|---|---|
| $path | String | mountpoint | |
| $softBlock | int | soft block limit | |
| $hardBlock | int | hard block limit | |
| $softInode | int | soft inode limit | |
| $hardInode | int | hard inode limit | |
| $uploadIndex | boolean | position is upload table | null | 
Return value
| Type | Description | 
|---|---|
| array | array where error messages are returned | 
check_profileOptions( array $options, ) : array
Description
Checks input values of account profiles.Arguments
| Name | Type | Description | Default | 
|---|---|---|---|
| $options | array | a hash array (name => value) containing the options | 
Return value
| Type | Description | 
|---|---|
| array | list of error messages (array(type, title, text)) to generate StatusMessages, if any | 
display_html_attributes( ) : \htmlElement
Description
Returns the HTML meta data for the main account page.Return value
| Type | Description | 
|---|---|
| \htmlElement | HTML meta data | 
get_metaData( ) : array
Description
Returns meta data that is interpreted by parent classReturn value
| Type | Description | 
|---|---|
| array | array with meta data | 
Tags
| Name | Description | 
|---|---|
| see | 
get_pdfEntries( ) : n/a
Description
Returns a list of PDF entriesReturn value
| Type | Description | 
|---|---|
| n/a | n/a | 
load_Messages( ) : n/a
Description
This function fills the $messages variable with output messages from this module.Return value
| Type | Description | 
|---|---|
| n/a | n/a | 
