WMDE
/
LDAPAccountManager
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

PHPdoc updates

This commit is contained in:
Roland Gruber 2010-06-12 17:17:31 +00:00
parent 4ec1dd9b7d
commit 9222d9cbb8
5 changed files with 73 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lam/lib/modules/asteriskAccount.inc
View File

@ -53,7 +53,7 @@ class asteriskAccount extends baseModule implements passwordService {
}
/**
* Returns meta data that is interpreted by parent class
* Returns meta data that is interpreted by parent class.
*
* @return array array with meta data
*/
@ -378,6 +378,14 @@ class asteriskAccount extends baseModule implements passwordService {
return array();
}
/**
* Builds the password string for the password attribute.
*
* @param array $attributes LDAP attributes
* @param array $moduleSettings module configuration settings
* @param String $password password
* @return String value for password attribute
*/
public static function buildPasswordString(&$attributes, &$moduleSettings, $password) {
$astRealm = asteriskAccount::ASTERISK_DEFAULT_REALM;
$asteriskRealmFromProfile = $moduleSettings['asteriskAccount_AsteriskRealm'][0];

6
lam/lib/modules/ddns.inc
View File

@ -56,8 +56,12 @@ class ddns extends baseModule {
$this->orig = &$this->getAccountContainer()->getAccountModule('dhcp_settings')->orig;
}
/**
* Returns meta data that is interpreted by parent class.
*
* @return array array with meta data
*/
public function get_metaData() {
$return = array();
// manages host accounts
$return["account_types"] = array("dhcp");

16
lam/lib/modules/dhcp_settings.inc
View File

@ -93,6 +93,11 @@ class dhcp_settings extends baseModule {
parent::__construct($scope);
}
/**
* Returns meta data that is interpreted by parent class
*
* @return array array with meta data
*/
public function get_metaData() {
$return = array();
// manages host accounts
@ -324,7 +329,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$this->messages['domainname'][5] = array('ERROR', _('Account %s:') . ' dhcp_settings_domainName', _('The domain name includes invalid characters. Valid characters are A-Z, a-z, 0-9, ".", "_","-".'));
}
/* This function returns an array with 4 entries:
/** This function returns an array with 4 entries:
* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr), 'lamdaemon' => array(cmds)), DN2 .... )
* 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
@ -524,10 +529,11 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
return $num;
}
/* This function will create the html-page
* to show a page with all attributes.
* It will output a complete html-table
*/
/**
* Returns the HTML meta data for the main account page.
*
* @return array HTML meta data
*/
public function display_html_attributes() {
// check if DHCP main settings and valid DHCP entry
if ($_SESSION['config']->get_suffix('dhcp') == $this->getAccountContainer()->dn_orig) {

37
lam/lib/modules/fixed_ip.inc
View File

@ -54,8 +54,14 @@ class fixed_ip extends baseModule {
public $attributes;
/**
* Returns meta data that is interpreted by parent class
*
* @return array array with meta data
*
* @see baseModule::get_metaData()
*/
public function get_metaData() {
$return = array();
// manages host accounts
$return["account_types"] = array("dhcp");
@ -92,6 +98,9 @@ class fixed_ip extends baseModule {
return $return;
}
/**
* This function fills the error message array with messages.
*/
public function load_Messages() {
$this->messages['errors'][0] = array('ERROR', _('One or more errors occured. The invalid fields are marked.'), '');
}
@ -311,10 +320,11 @@ class fixed_ip extends baseModule {
return $errors;
}
/* This function will create the html-page
* to show a page with all attributes.
* It will output a complete html-table
*/
/**
* Returns the HTML meta data for the main account page.
*
* @return array HTML meta data
*/
public function display_html_attributes() {
if ($this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0]=="") {
echo "<b>" . _("Please fill out the DHCP settings first.") . "</b>";
@ -425,14 +435,15 @@ class fixed_ip extends baseModule {
return $return;
}
/* This function returns an array with 4 entries:
* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr), 'lamdaemon' => array(cmds)), DN2 .... )
* 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
* add are attributes which have to be added to ldap entry
* remove are attributes which have to be removed from ldap entry
* lamdaemon are lamdaemon commands to modify homedir, quotas, ...
*/
/**
* This function returns an array with 4 entries:
* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr), 'lamdaemon' => array(cmds)), DN2 .... )
* 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
* add are attributes which have to be added to ldap entry
* remove are attributes which have to be removed from ldap entry
* lamdaemon are lamdaemon commands to modify homedir, quotas, ...
*/
public function save_attributes() {
}

36
lam/lib/modules/range.inc
View File

@ -52,6 +52,13 @@ class range extends baseModule {
// For check, if IPs overlaped.
public $overlaped;
/**
* Returns meta data that is interpreted by parent class
*
* @return array array with meta data
*
* @see baseModule::get_metaData()
*/
public function get_metaData() {
$return = array();
// manages dhcp accounts
@ -93,6 +100,9 @@ class range extends baseModule {
return $return;
}
/**
* This function fills the error message array with messages.
*/
public function load_Messages() {
$this->messages['range_errors'][0] = array('ERROR', _('One or more errors occured. The invalid fields are marked.'), '');
$this->messages['add_range'][0] = array('ERROR', _('New range'), _('Adding the range failed because errors occured.'));
@ -373,10 +383,11 @@ class range extends baseModule {
return $errors;
}
/* This function will create the html-page
* to show a page with all attributes.
* It will output a complete html-table
*/
/**
* Returns the HTML meta data for the main account page.
*
* @return array HTML meta data
*/
public function display_html_attributes() {
if ($this->getAccountContainer()->getAccountModule('dhcp_settings')->attributes['cn'][0]=="") {
echo "<b>" . _("Please fill out the DHCP settings first.") . "</b>";
@ -443,14 +454,15 @@ class range extends baseModule {
return $return;
}
/* This function returns an array with 4 entries:
* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr), 'lamdaemon' => array(cmds)), DN2 .... )
* 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
* add are attributes which have to be added to ldap entry
* remove are attributes which have to be removed from ldap entry
* lamdaemon are lamdaemon commands to modify homedir, quotas, ...
*/
/**
* This function returns an array with 4 entries:
* array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr), 'lamdaemon' => array(cmds)), DN2 .... )
* 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
* add are attributes which have to be added to ldap entry
* remove are attributes which have to be removed from ldap entry
* lamdaemon are lamdaemon commands to modify homedir, quotas, ...
*/
public function save_attributes() {
$return = array();
// Get easy attributes