lib/modules/nisnetgroup.inc

Properties

Description

Manages entries based on the object class nisNetgroup.

Classes

nisnetgroup

Properties

 
 
modules  
No 
No 

Description

Manages entries based on the object class nisNetgroup.
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, display_html_attributes, display_html_group, display_html_select, getGroupList, getHostList, getUserList, get_metaData, get_pdfEntries, load_Messages, module_complete, process_attributes, process_group, process_select, save_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

display_html_attributes( ) : \htmlElement

Description

Returns the HTML meta data for the main account page.

Return value

Type Description
\htmlElement HTML meta data

display_html_group( ) : \htmlElement

Description

Displays the group selection.

Return value

Type Description
\htmlElement meta HTML code

display_html_select( ) : \htmlElement

Description

Displays the host/user selection.

Return value

Type Description
\htmlElement meta HTML code

getGroupList( ) : array

Description

Returns a list of existing NIS net groups.

Return value

Type Description
array group names

getHostList( ) : array

Description

Returns a list of existing hosts.

Return value

Type Description
array host names

getUserList( ) : array

Description

Returns a list of existing users.

Return value

Type Description
array user names

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

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

module_complete( ) : boolean

Description

This functions is used to check if all settings for this module have been made.

Return value

Type Description
boolean true, if settings are complete

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

process_group( ) : array

Description

Processes user input of the group selection 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

process_select( ) : array

Description

Processes user input of the host/user selection 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)

Properties

$cachedGroupList, $cachedHostList, $cachedUserList,

  private  $cachedGroupList = null

group cache


  private  $cachedHostList = null

host cache


  private  $cachedUserList = null

user cache


Documentation was generated by phpDocumentor 2.0.1 .

Namespaces

  • global

    Packages