lib/modules/pykotaBillingCode.inc
Properties
Description
Manages PyKota billing codes.Classes
pykotaBillingCode
Description
Manages PyKota billing codes.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, codeExists, display_html_attributes, get_metaData, get_pdfEntries, loadCodeCache, load_Messages, 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 | 
codeExists( String $code, ) : boolean
Description
Returns if the given billing code already exists.Arguments
| Name | Type | Description | Default | 
|---|---|---|---|
| $code | String | pykotaBillingCode attribute value | 
Return value
| Type | Description | 
|---|---|
| boolean | pykotaBillingCode exists | 
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 | 
loadCodeCache( ) : n/a
Description
Loads the list of billing code names into the cache.Return value
| Type | Description | 
|---|---|
| n/a | n/a | 
