lib/modules/pykotaBillingCode.inc

Properties

Description

Manages PyKota billing codes.

Classes

pykotaBillingCode

Properties

 
 
modules  
No 
No 

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 ".inc". E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc". The class name of a module must contain only a-z, A-Z, 0-9, -, and _.

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 class

Return value

Type Description
array array with meta data

Tags

Name Description
see

get_pdfEntries( ) : n/a

Description

Returns a list of PDF entries

Return 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

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

process_attributes( ) : array

Description

Processes user input of the primary module page.
It checks if all input values are correct and updates the associated LDAP attributes.

Return value

Type Description
array list of info/error messages

Properties

$codeCache,

  private  $codeCache = null

cache for existing codes (array(dn1 => pykotaBillingCode1, dn2 => pykotaBillingCode2))


Documentation was generated by phpDocumentor 2.1.0 .

Namespaces

  • global

    Packages