# Docs For Class ldapPublicKey

modules

# Class: ldapPublicKey

Source Location: /lib/modules/ldapPublicKey.inc

### Class Overview

    baseModule
       |
       --ldapPublicKey

Manages SSH public keys.

### Methods

- build_uploadAccounts
- display_html_attributes
- get_metaData
- get_pdfEntries
- process_attributes

### Inherited Variables

#### Class: baseModule

baseModule::$attributes
baseModule::$messages
baseModule::$meta
baseModule::$moduleSettings
baseModule::$orig
baseModule::$selfServiceSettings

### Inherited Methods

#### Class: baseModule

baseModule::baseModule()
  Creates a new base module class
baseModule::build_uploadAccounts()
  In this function the LDAP account is built up.
baseModule::can_manage()
  Returns true if this module fits for the current scope.
baseModule::checkSelfServiceOptions()
  Checks if all input values are correct and returns the LDAP commands which should be executed.
baseModule::checkSelfServiceSettings()
  Checks if the self service settings are valid.
baseModule::check_configOptions()
  Checks input values of module settings.
baseModule::check_profileOptions()
  Checks input values of account profiles.
baseModule::delete_attributes()
  Dummy function for modules which use no special options on account deletion.
baseModule::display_html_delete()
  Dummy function for modules which do not print extra HTML code on account deletion.
baseModule::doUploadPostActions()
  This function executes one post upload action.
baseModule::getAccountContainer()
  Returns the accountContainer object.
baseModule::getAttributes()
  Returns the LDAP attributes which are managed in this module.
baseModule::getButtonStatus()
  Controls if the module button the account page is visible and activated.
baseModule::getLDAPAliases()
  Returns a list of aliases for LDAP attributes.
baseModule::getManagedAttributes()
  Returns a list of LDAP attributes which are managed by this module.
baseModule::getManagedObjectClasses()
  Returns a list of managed object classes for this module.
baseModule::getOriginalAttributes()
  Returns the LDAP attributes which are managed in this module (with unchanged values).
baseModule::getRequiredExtensions()
  Returns a list of required PHP extensions.
baseModule::getSelfServiceFields()
  Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
baseModule::getSelfServiceOptions()
  Returns the meta HTML code for each input field.
baseModule::getSelfServiceSearchAttributes()
  Returns a list of possible search attributes for the self service.
baseModule::getSelfServiceSettings()
  Returns a list of self service configuration settings.
baseModule::get_alias()
  Returns an alias name for the module.
baseModule::get_configOptions()
  Returns a list of elements for the configuration.
baseModule::get_dependencies()
  This function returns a list with all depending and conflicting modules.
baseModule::get_help()
  This function return the help entry array for a specific help id. Normally this->meta can be used.
baseModule::get_ldap_filter()
  returns an LDAP filter for the account lists
baseModule::get_metaData()
  Dummy function, meta data is provided by sub classes.
baseModule::get_pdfFields()
  Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
baseModule::get_pdf_entries()
  Returns a hastable with all entries that may be printed out in the PDF. The
baseModule::get_profileOptions()
  Returns a list of elements for the account profiles.
baseModule::get_RDNAttributes()
  Returns a list of possible LDAP attributes which can be used to form the RDN.
baseModule::get_scope()
  Returns the account type of this module (user, group, host)
baseModule::get_uploadColumns()
  Returns an array containing all input columns for the file upload.
baseModule::get_uploadPreDepends()
  Returns a list of module names which must be processed in building the account befor this module.
baseModule::init()
  Initializes the module after it became part of an accountContainer
baseModule::is_base_module()
  Returns true if this module is enough to provide a sensible account.
baseModule::load_attributes()
  This function loads the LDAP attributes for this module.
baseModule::load_Messages()
  This function fills the $messages variable with output messages from this module.
baseModule::load_profile()
  Loads the values of an account profile into internal variables.
baseModule::module_complete()
  This functions is used to check if all settings for this module have been made.
baseModule::module_ready()
  This function is used to check if this module page can be displayed.
baseModule::postDeleteActions()
  Allows the module to run commands after the LDAP entry is deleted.
baseModule::postModifyActions()
  Allows the module to run commands after the LDAP entry is changed or created.
baseModule::preDeleteActions()
  Allows the module to run commands before the LDAP entry is deleted.
baseModule::preModifyActions()
  Allows the module to run commands before the LDAP entry is changed or created.
baseModule::save_attributes()
  Returns a list of modifications which have to be made to the LDAP account.

### Class Details

[line 36]
Manages SSH public keys.
[ Top ]

### Class Methods

### method build_uploadAccounts [line 140]

`array build_uploadAccounts( array $rawAccounts, array $ids, &$partialAccounts, array $partialAccounts)`

In this function the LDAP account is built up.

#### Tags:

return: | list of error messages if any

Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)

#### Parameters:

array | $rawAccounts | list of hash arrays (name => value) from user input
array | $partialAccounts | list of hash arrays (name => value) which are later added to LDAP
array | $ids | list of IDs for column position (e.g. "posixAccount_uid" => 5)
| &$partialAccounts |

[ Top ]

### method display_html_attributes [line 87]

`array display_html_attributes( )`

Returns the HTML meta data for the main account page.

#### Tags:

return: | HTML meta data

[ Top ]

### method get_metaData [line 43]

`array get_metaData( )`

Returns meta data that is interpreted by parent class

#### Tags:

return: | array with meta data

Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)
[ Top ]

### method get_pdfEntries [line 160]

`void get_pdfEntries( )`

Returns a list of PDF entries
[ Top ]

### method process_attributes [line 113]

`array process_attributes( )`

Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.

#### Tags:

return: | list of info/error messages

[ Top ]

Documentation generated on Sun, 04 Nov 2007 12:10:54 +0100 by phpDocumentor 1.4.0