modules

# Class: accountContainer Source Location: /lib/modules.inc
### Class Overview
This class includes all modules and attributes of an account. | ### Variables $attributes $attributes_orig $base $current_page $dn $dn_orig $isNewAccount $module $order $rdn $subpage $type | ### Methods accountContainer add_attributes continue_main get_module_attributes get_pdfEntries get_type load_account new_account save_account save_module_attributes sortModules __sleep __wakeup
### Class Details [line 691] This class includes all modules and attributes of an account. [ Top ] ### Class Variables #### $attributes = [line 719] Array of all used attributes Syntax is attribute => array ( objectClass => MUST or MAY, ...)
Type: | mixed
[ Top ] #### $attributes_orig = [line 740] original LDAP attributes when account was loaded from LDAP
Type: | mixed
[ Top ] #### $base = [line 746] Name of accountContainer variable in session
Type: | mixed
[ Top ] #### $current_page = [line 749] This variable stores the name of the currently displayed page
Type: | mixed
[ Top ] #### $dn = [line 731] DN suffix of the account
Type: | mixed
[ Top ] #### $dn_orig = [line 734] DN suffix of account when it was loaded
Type: | mixed
[ Top ] #### $isNewAccount = [line 755] True if this is a newly created account
Type: | mixed
[ Top ] #### $module = [line 728] This is an array with all module objects
Type: | mixed
[ Top ] #### $order = [line 743] Module order
Type: | mixed
[ Top ] #### $rdn = [line 737] RDN attribute of this account
Type: | mixed
[ Top ] #### $subpage = [line 752] This variable is set to the pagename of a subpage if it should be displayed
Type: | mixed
[ Top ] #### $type = [line 725] This variale stores the account type. Currently "user", "group" and "host" are supported.
Type: | mixed
[ Top ] ### Class Methods ### constructor accountContainer [line 698]
`accountContainer accountContainer( string $type, string $base)`
Constructor #### Parameters:
string | $type | account type
string | $base | key in $_SESSION where this object is saved
[ Top ] ### method add_attributes [line 1073]
`void add_attributes( mixed $objectClass)`
Add attributes to variable. Syntax is array( attribute = array ( objectClass1 => MUST|MAX, objectClass2 => MUST|MAY ), ... ) #### Tags:
todo: | document this function
[ Top ] ### method continue_main [line 773]
`void continue_main( array $post)`
This function is called when the user clicks on any button on the account pages. It prints the HTML code of each account page. #### Parameters:
array | $post | HTTP POST variables
[ Top ] ### method get_module_attributes [line 1160]
`array get_module_attributes( string $objectClass, [boolean $original = false])`
This function returns all LDAP attributes which are used by the given object class. LDAP attributs which are already in use by another object class are passed as reference. Therefore this function must be called as reference: $result =& ..get_module_attributes #### Tags:
return: | list of attributes
#### Parameters:
string | $objectClass | object class name
boolean | $original | If original is true references will be set to original attributes. This are the original attributes when an LDAP entry is loaded.
[ Top ] ### method get_pdfEntries [line 1610]
`list get_pdfEntries( )`
Returns a list of possible PDF entries for this account. #### Tags:
return: | of PDF entries (array(<name> => <PDF lines>))
[ Top ] ### method get_type [line 763]
`string get_type( )`
Returns the accout type of this object (e.g. user, group, host). #### Tags:
return: | account type
[ Top ] ### method load_account [line 1349]
`void load_account( string $dn)`
Loads an LDAP account with the given DN. #### Parameters:
string | $dn | the DN of the account
[ Top ] ### method new_account [line 1395]
`void new_account( )`
This function will prepare the object for a new account. [ Top ] ### method save_account [line 1424]
`array save_account( )`
This function will save an account to the LDAP database. #### Tags:
return: | list of status messages if any errors occured
[ Top ] ### method save_module_attributes [line 1290]
`array save_module_attributes( array $attributes, array $orig)`
This function checks which LDAP attributes have changed while the account was edited. #### Tags:
return: | an array which can be passed to $this->saveAccount()
#### Parameters:
array | $attributes | list of current LDAP attributes
array | $orig | list of old attributes when account was loaded
[ Top ] ### method sortModules [line 1623]
`void sortModules( )`
Sorts the module buttons for the account page. [ Top ] ### method __sleep [line 1686]
`array __sleep( )`
Encrypts sensitive data before storing in session. #### Tags:
return: | list of attributes which are serialized
[ Top ] ### method __wakeup [line 1698]
`void __wakeup( )`
Decrypts sensitive data after accountContainer was loaded from session. [ Top ] Documentation generated on Tue, 07 Feb 2006 17:03:49 +0100 by phpDocumentor 1.2.3