lib/modules/puppetClient.inc
Properties
Description
Manages Puppet configuration options.Classes
puppetClient
Description
Manages Puppet configuration options.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
__construct, build_uploadAccounts, display_html_attributes, getPossibleParentNodes, get_metaData, get_pdfEntries, get_profileOptions, load_Messages, load_profile, process_attributes, save_attributes,__construct( string $scope, ) : n/a
Description
Creates a new authorizedServiceObject object.Arguments
Name | Type | Description | Default |
---|---|---|---|
$scope | string | account type (user, group, host) |
Return value
Type | Description |
---|---|
n/a | n/a |
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 |
display_html_attributes( ) : \htmlElement
Description
Returns the HTML meta data for the main account page.Return value
Type | Description |
---|---|
\htmlElement | HTML meta data |
getPossibleParentNodes( ) : array
Description
Reurns a list of valid parent nodes for this node.Return value
Type | Description |
---|---|
array | parent nodes (e.g. array('node1', 'node2')) |
get_metaData( ) : array
Description
Returns meta data that is interpreted by parent classReturn value
Type | Description |
---|---|
array | array with meta data |
get_pdfEntries( ) : array
Description
Returns the PDF entries for this module.Return value
Type | Description |
---|---|
array | list of possible PDF entries |
get_profileOptions( ) : \htmlElement
Description
This function defines what attributes will be used in the account profiles and their appearance in the profile editor.Calling this method does not require the existence of an enclosing {@link accountContainer}.
The return value is an object implementing htmlElement.
The field name are used as keywords to load and save profiles. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.
Return value
Type | Description |
---|---|
\htmlElement | meta HTML object |
Tags
Name | Description |
---|---|
see | |
see |
load_Messages( ) : n/a
Description
This function fills the error message array with messagesReturn value
Type | Description |
---|---|
n/a | n/a |
load_profile( array $profile, ) : n/a
Description
Loads the values of an account profile into internal variables.Arguments
Name | Type | Description | Default |
---|---|---|---|
$profile | array | hash array with profile values (identifier => value) |
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 |
save_attributes( ) : array
Description
Returns a list of modifications which have to be made to the LDAP account.Return value
Type | Description |
---|---|
array | list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions) |