PHPDoc update

This commit is contained in:
Roland Gruber 2017-02-19 09:14:11 +01:00
parent 7ccd41ef11
commit d949b1bae4
42 changed files with 251 additions and 331 deletions

View File

@ -813,7 +813,7 @@ abstract class baseModule {
* Returns the PDF entries for this module. * Returns the PDF entries for this module.
* *
* @param array $pdfKeys list of PDF keys that are included in document * @param array $pdfKeys list of PDF keys that are included in document
* @return array list of possible PDF entries * @return PDFEntry[] list of key => PDFEntry
*/ */
public function get_pdfEntries($pdfKeys) { public function get_pdfEntries($pdfKeys) {
return array(); return array();

View File

@ -2006,7 +2006,7 @@ class accountContainer {
* Returns a list of possible PDF entries for this account. * Returns a list of possible PDF entries for this account.
* *
* @param array $pdfKeys list of PDF keys that are included in document * @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>)) * @return PDFEntry[] list of key => PDFEntry
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -220,11 +220,9 @@ class account extends baseModule {
} }
/** /**
* Returns the PDF entries for this module. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document */
* @return array list of possible PDF entries
*/
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();
$this->addSimplePDFField($return, 'description', _('Description')); $this->addSimplePDFField($return, 'description', _('Description'));

View File

@ -54,7 +54,7 @@ class asteriskAccount extends baseModule implements passwordService {
/** /**
* Returns true if this module can manage accounts of the current type, otherwise false. * Returns true if this module can manage accounts of the current type, otherwise false.
* *
* @return boolean true if module fits * @return boolean true if module fits
*/ */
public function can_manage() { public function can_manage() {
@ -67,7 +67,7 @@ class asteriskAccount extends baseModule implements passwordService {
* @return array array with meta data * @return array array with meta data
*/ */
function get_metaData() { function get_metaData() {
$return = array(); $return = array();
$return["is_base"] = false; $return["is_base"] = false;
// alias name // alias name
$return["alias"] = _("Asterisk"); $return["alias"] = _("Asterisk");
@ -134,7 +134,7 @@ class asteriskAccount extends baseModule implements passwordService {
'AstAccountCallGroup' => array( 'AstAccountCallGroup' => array(
"Headline" => _("Call groups"), 'attr' => 'AstAccountCallGroup', "Headline" => _("Call groups"), 'attr' => 'AstAccountCallGroup',
"Text" => _("The user's call groups.") "Text" => _("The user's call groups.")
), ),
'AstAccountDTMFMode' => array( 'AstAccountDTMFMode' => array(
"Headline" => _("DTMF mode"), 'attr' => 'AstAccountDTMFMode', "Headline" => _("DTMF mode"), 'attr' => 'AstAccountDTMFMode',
"Text" => _("DTMF mode for SIP client configuration.") "Text" => _("DTMF mode for SIP client configuration.")
@ -244,7 +244,7 @@ class asteriskAccount extends baseModule implements passwordService {
"Text" => _("The selected options will not be managed inside LAM. You can use this to reduce the number of displayed input fields.") "Text" => _("The selected options will not be managed inside LAM. You can use this to reduce the number of displayed input fields.")
), ),
); );
// self service options // self service options
$selfServiceContainer = new htmlTable(); $selfServiceContainer = new htmlTable();
$selfServiceContainer->addElement(new htmlTableExtendedInputField(_('Asterisk realm'), 'asteriskAccount_AsteriskRealm', null)); $selfServiceContainer->addElement(new htmlTableExtendedInputField(_('Asterisk realm'), 'asteriskAccount_AsteriskRealm', null));
$selfServiceContainer->addElement(new htmlHelpLink('AsteriskRealm', get_class($this))); $selfServiceContainer->addElement(new htmlHelpLink('AsteriskRealm', get_class($this)));
@ -415,7 +415,7 @@ class asteriskAccount extends baseModule implements passwordService {
'help' => 'AstAccountDeny', 'help' => 'AstAccountDeny',
); );
} }
if (!$this->isBooleanConfigOptionSet('asteriskAccount_hideAstAccountPermit')) { if (!$this->isBooleanConfigOptionSet('asteriskAccount_hideAstAccountPermit')) {
$return['upload_columns'][] = array( $return['upload_columns'][] = array(
'name' => 'asteriskAccount_AstAccountPermit', 'name' => 'asteriskAccount_AstAccountPermit',
@ -487,7 +487,7 @@ class asteriskAccount extends baseModule implements passwordService {
'help' => 'AstAccountMusicOnHold', 'help' => 'AstAccountMusicOnHold',
); );
} }
if (!$this->isBooleanConfigOptionSet('asteriskAccount_hideAstAccountExpirationTimestamp')) { if (!$this->isBooleanConfigOptionSet('asteriskAccount_hideAstAccountExpirationTimestamp')) {
$return['upload_columns'][] = array( $return['upload_columns'][] = array(
'name' => 'asteriskAccount_AstAccountExpirationTimestamp', 'name' => 'asteriskAccount_AstAccountExpirationTimestamp',
@ -523,7 +523,7 @@ class asteriskAccount extends baseModule implements passwordService {
'help' => 'AstAccountIPAddress', 'help' => 'AstAccountIPAddress',
); );
} }
if (!$this->isBooleanConfigOptionSet('asteriskAccount_hideAstAccountDefaultUser')) { if (!$this->isBooleanConfigOptionSet('asteriskAccount_hideAstAccountDefaultUser')) {
$return['upload_columns'][] = array( $return['upload_columns'][] = array(
'name' => 'asteriskAccount_AstAccountDefaultUser', 'name' => 'asteriskAccount_AstAccountDefaultUser',
@ -579,7 +579,7 @@ class asteriskAccount extends baseModule implements passwordService {
/** /**
* Returns the HTML meta data for the main account page. * Returns the HTML meta data for the main account page.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
function display_html_attributes() { function display_html_attributes() {
@ -975,10 +975,8 @@ class asteriskAccount extends baseModule implements passwordService {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();
@ -1056,7 +1054,7 @@ class asteriskAccount extends baseModule implements passwordService {
$pwdString = asteriskAccount::buildPasswordString($attributes, $this->moduleSettings, $rawAccounts[$i][$ids['asteriskAccount_AstAccountRealmedPassword']]); $pwdString = asteriskAccount::buildPasswordString($attributes, $this->moduleSettings, $rawAccounts[$i][$ids['asteriskAccount_AstAccountRealmedPassword']]);
$partialAccounts[$i]['AstAccountRealmedPassword'] = $pwdString; $partialAccounts[$i]['AstAccountRealmedPassword'] = $pwdString;
} }
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountUserAgent', 'AstAccountUserAgent'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountUserAgent', 'AstAccountUserAgent');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountAMAFlags', 'AstAccountAMAFlags'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountAMAFlags', 'AstAccountAMAFlags');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountCallGroup', 'AstAccountCallGroup'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountCallGroup', 'AstAccountCallGroup');
@ -1075,10 +1073,10 @@ class asteriskAccount extends baseModule implements passwordService {
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountDeny', 'AstAccountDeny'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountDeny', 'AstAccountDeny');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountPermit', 'AstAccountPermit'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountPermit', 'AstAccountPermit');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountPickupGroup', 'AstAccountPickupGroup'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountPickupGroup', 'AstAccountPickupGroup');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountPort', 'AstAccountPort', $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountPort', 'AstAccountPort',
'digit', $this->messages['AstAccountPort'][1], $messages); 'digit', $this->messages['AstAccountPort'][1], $messages);
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountQualify', 'AstAccountQualify'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountQualify', 'AstAccountQualify');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRestrictCID', 'AstAccountRestrictCID'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRestrictCID', 'AstAccountRestrictCID');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRTPTimeout', 'AstAccountRTPTimeout'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRTPTimeout', 'AstAccountRTPTimeout');
@ -1090,13 +1088,13 @@ class asteriskAccount extends baseModule implements passwordService {
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRegistrationContext', 'AstAccountRegistrationContext'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRegistrationContext', 'AstAccountRegistrationContext');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRegistrationExten', 'AstAccountRegistrationExten'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRegistrationExten', 'AstAccountRegistrationExten');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountCanCallForward', 'AstAccountCanCallForward'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountCanCallForward', 'AstAccountCanCallForward');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountIPAddress', 'AstAccountIPAddress', $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountIPAddress', 'AstAccountIPAddress',
'ip', $this->messages['AstAccountIPAddress'][1], $messages); 'ip', $this->messages['AstAccountIPAddress'][1], $messages);
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountDefaultUser', 'AstAccountDefaultUser', $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountDefaultUser', 'AstAccountDefaultUser',
'username', $this->messages['AstAccountDefaultUser'][1], $messages); 'username', $this->messages['AstAccountDefaultUser'][1], $messages);
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRegistrationServer', 'AstAccountRegistrationServer'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountRegistrationServer', 'AstAccountRegistrationServer');
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountLastQualifyMilliseconds', 'AstAccountLastQualifyMilliseconds'); $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'asteriskAccount_AstAccountLastQualifyMilliseconds', 'AstAccountLastQualifyMilliseconds');
} }
@ -1120,13 +1118,13 @@ class asteriskAccount extends baseModule implements passwordService {
/** /**
* Specifies if this module supports to force that a user must change his password on next login. * Specifies if this module supports to force that a user must change his password on next login.
* *
* @return boolean force password change supported * @return boolean force password change supported
*/ */
public function supportsForcePasswordChange() { public function supportsForcePasswordChange() {
return false; return false;
} }
/** /**
* This function is called whenever the password should be changed. Account modules * This function is called whenever the password should be changed. Account modules
* must change their password attributes only if the modules list contains their module name. * must change their password attributes only if the modules list contains their module name.
@ -1145,7 +1143,7 @@ class asteriskAccount extends baseModule implements passwordService {
$this->attributes['AstAccountRealmedPassword'][0] = asteriskAccount::buildPasswordString($this->attributes, $this->moduleSettings, $password); $this->attributes['AstAccountRealmedPassword'][0] = asteriskAccount::buildPasswordString($this->attributes, $this->moduleSettings, $password);
return array(); return array();
} }
/** /**
* Builds the password string for the password attribute. * Builds the password string for the password attribute.
* *
@ -1162,7 +1160,7 @@ class asteriskAccount extends baseModule implements passwordService {
} }
return asteriskAccount::hashPassword($attributes['AstAccountCallerID'][0] . ":" . $astRealm . ":" . $password); return asteriskAccount::hashPassword($attributes['AstAccountCallerID'][0] . ":" . $astRealm . ":" . $password);
} }
/** /**
* Hashes a password value to Asterisk format. * Hashes a password value to Asterisk format.
* *
@ -1181,7 +1179,7 @@ class asteriskAccount extends baseModule implements passwordService {
* <br>del: array of attributes to remove * <br>del: array of attributes to remove
* <br>mod: array of attributes to modify * <br>mod: array of attributes to modify
* <br>info: array of values with informational value (e.g. to be used later by pre/postModify actions) * <br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)
* *
* Calling this method does not require the existence of an enclosing {@link accountContainer}. * Calling this method does not require the existence of an enclosing {@link accountContainer}.
* *
* @param string $fields input fields * @param string $fields input fields
@ -1216,7 +1214,7 @@ class asteriskAccount extends baseModule implements passwordService {
/** /**
* Returns a list of configuration options. * Returns a list of configuration options.
* *
* Calling this method does not require the existence of an enclosing {@link accountContainer}.<br> * Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
* <br> * <br>
* The field names are used as keywords to load and save settings. * The field names are used as keywords to load and save settings.
@ -1225,7 +1223,7 @@ class asteriskAccount extends baseModule implements passwordService {
* @param array $scopes account types (user, group, host) * @param array $scopes account types (user, group, host)
* @param array $allScopes list of all active account modules and their scopes (module => array(scopes)) * @param array $allScopes list of all active account modules and their scopes (module => array(scopes))
* @return mixed htmlElement or array of htmlElement * @return mixed htmlElement or array of htmlElement
* *
* @see htmlElement * @see htmlElement
*/ */
public function get_configOptions($scopes, $allScopes) { public function get_configOptions($scopes, $allScopes) {
@ -1303,7 +1301,7 @@ class asteriskAccount extends baseModule implements passwordService {
$return[] = $configContainer; $return[] = $configContainer;
return $return; return $return;
} }
} }
?> ?>

View File

@ -797,10 +797,8 @@ class asteriskExtension extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$a = $this->attributes; $a = $this->attributes;

View File

@ -362,10 +362,8 @@ class asteriskVoicemail extends baseModule implements passwordService {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -221,10 +221,8 @@ class authorizedServiceObject extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -38,14 +38,14 @@ $Id$
*/ */
class ddns extends baseModule { class ddns extends baseModule {
/** standard DDNS settings */ /** standard DDNS settings */
public $ddns = array(); public $ddns = array();
/** /**
* Returns true if this module can manage accounts of the current type, otherwise false. * Returns true if this module can manage accounts of the current type, otherwise false.
* *
* @return boolean true if module fits * @return boolean true if module fits
*/ */
public function can_manage() { public function can_manage() {
@ -141,7 +141,7 @@ class ddns extends baseModule {
} }
return $return; return $return;
} }
/** /**
* This function fills the message array. * This function fills the message array.
*/ */
@ -153,7 +153,7 @@ class ddns extends baseModule {
$this->messages['zone'][0] = array('ERROR', 'Please enter a zone name.'); $this->messages['zone'][0] = array('ERROR', 'Please enter a zone name.');
$this->messages['zone_reverse'][0] = array('ERROR', 'Please enter the reverse zone.'); $this->messages['zone_reverse'][0] = array('ERROR', 'Please enter the reverse zone.');
} }
/** /**
* This functions returns true if all needed settings are done. * This functions returns true if all needed settings are done.
* *
@ -175,16 +175,16 @@ class ddns extends baseModule {
// Account settings // Account settings
$ip = $this->getDNSServer(); $ip = $this->getDNSServer();
if (!empty($ip) && !check_ip($ip)) return false; if (!empty($ip) && !check_ip($ip)) return false;
$zones = $this->getZoneNames(); $zones = $this->getZoneNames();
if (sizeof($zones) < 2) { if (sizeof($zones) < 2) {
return false; return false;
} }
} }
return true; return true;
} }
/** /**
* Returns a list of modifications which have to be made to the LDAP account. * Returns a list of modifications which have to be made to the LDAP account.
* *
@ -200,7 +200,7 @@ class ddns extends baseModule {
public function save_attributes() { public function save_attributes() {
// done by dhcp_server object // done by dhcp_server object
} }
/** /**
* This function check if ddns is enable. * This function check if ddns is enable.
*/ */
@ -210,7 +210,7 @@ class ddns extends baseModule {
} }
$ldap = $_SESSION['ldap']->server(); $ldap = $_SESSION['ldap']->server();
$dn = $_SESSION['config']->get_suffix('dhcp'); $dn = $_SESSION['config']->get_suffix('dhcp');
$search = @ldap_read($ldap,$dn,"dhcpStatements=ddns-update-style interim", array('dn'), 0, 0, 0, LDAP_DEREF_NEVER); $search = @ldap_read($ldap,$dn,"dhcpStatements=ddns-update-style interim", array('dn'), 0, 0, 0, LDAP_DEREF_NEVER);
if ($search) { if ($search) {
$info = @ldap_get_entries($ldap,$search); $info = @ldap_get_entries($ldap,$search);
@ -226,7 +226,7 @@ class ddns extends baseModule {
} }
return false; return false;
} }
/** /**
* Processes user input of the primary module page. * Processes user input of the primary module page.
* It checks if all input values are correct and updates the associated LDAP attributes. * It checks if all input values are correct and updates the associated LDAP attributes.
@ -235,7 +235,7 @@ class ddns extends baseModule {
*/ */
public function process_attributes() { public function process_attributes() {
$errors = array(); $errors = array();
// Main Settings and Account have to different processes. // Main Settings and Account have to different processes.
if ($this->getAccountContainer()->dn_orig==$_SESSION['config']->get_suffix('dhcp')) { if ($this->getAccountContainer()->dn_orig==$_SESSION['config']->get_suffix('dhcp')) {
// main settings: // main settings:
@ -246,7 +246,7 @@ class ddns extends baseModule {
if (!$this->check_if_ddns_is_enable()) { if (!$this->check_if_ddns_is_enable()) {
return array(); return array();
} }
$errors = $this->process_attributes_account(); $errors = $this->process_attributes_account();
} }
@ -261,41 +261,41 @@ class ddns extends baseModule {
return array(); return array();
} }
$errors = array(); $errors = array();
// Is DDNS active? // Is DDNS active?
$active = $_POST['active']; $active = $_POST['active'];
// Insert fixed IPs into DNS? // Insert fixed IPs into DNS?
$insert_fixed = $_POST['insert_fixed']; $insert_fixed = $_POST['insert_fixed'];
// Client can contribute which is registered into DNS // Client can contribute which is registered into DNS
$client_insert = $_POST['client_insert']; $client_insert = $_POST['client_insert'];
// The path to the key: // The path to the key:
$key_path = trim($_POST['key_path']); $key_path = trim($_POST['key_path']);
$this->setDynDNSActivated(($active == 'on')); $this->setDynDNSActivated(($active == 'on'));
$this->setFixIPs(($insert_fixed == 'on')); $this->setFixIPs(($insert_fixed == 'on'));
$this->setIgnoreClientUpdates(($client_insert == 'on')); $this->setIgnoreClientUpdates(($client_insert == 'on'));
$this->setUpdateKey($key_path); $this->setUpdateKey($key_path);
if (!empty($key_path)) { if (!empty($key_path)) {
if (str_replace("\"","",$_POST['key_path']) != $key_path) { if (str_replace("\"","",$_POST['key_path']) != $key_path) {
$errors[] = $this->messages['key_path'][1]; $errors[] = $this->messages['key_path'][1];
} }
} }
return $errors; return $errors;
} }
/** /**
* Process for account * Process for account
*/ */
public function process_attributes_account() { public function process_attributes_account() {
$errors = array(); $errors = array();
$ip = trim($_POST['ip']); $ip = trim($_POST['ip']);
$zone = trim($_POST['zone']); $zone = trim($_POST['zone']);
$zone_reverse = trim($_POST['zone_reverse']); $zone_reverse = trim($_POST['zone_reverse']);
@ -306,7 +306,7 @@ class ddns extends baseModule {
$errors[] = $this->messages['ip'][0]; $errors[] = $this->messages['ip'][0];
} }
} }
for ($i = 0; $i < sizeof($this->attributes['dhcpStatements']); $i++) { for ($i = 0; $i < sizeof($this->attributes['dhcpStatements']); $i++) {
if (substr($this->attributes['dhcpStatements'][$i], 0, 5) == 'zone ') { if (substr($this->attributes['dhcpStatements'][$i], 0, 5) == 'zone ') {
unset($this->attributes['dhcpStatements'][$i]); unset($this->attributes['dhcpStatements'][$i]);
@ -314,7 +314,7 @@ class ddns extends baseModule {
$i--; $i--;
} }
} }
// Zone inserted? // Zone inserted?
if (!empty($zone)) { if (!empty($zone)) {
if (!empty($ip)) { if (!empty($ip)) {
@ -329,7 +329,7 @@ class ddns extends baseModule {
$errors[] = $this->messages['zone'][0]; $errors[] = $this->messages['zone'][0];
} }
} }
// Zone reverse inserted? // Zone reverse inserted?
if (!empty($zone_reverse)) { if (!empty($zone_reverse)) {
if (!empty($ip)) { if (!empty($ip)) {
@ -346,10 +346,10 @@ class ddns extends baseModule {
} }
return $errors; return $errors;
} }
/** /**
* Returns the HTML meta data for the main account page. * Returns the HTML meta data for the main account page.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
public function display_html_attributes() { public function display_html_attributes() {
@ -372,7 +372,7 @@ class ddns extends baseModule {
$return->addElement($keyInput); $return->addElement($keyInput);
} }
else { else {
// Account edit // Account edit
if (!$this->check_if_ddns_is_enable()) { if (!$this->check_if_ddns_is_enable()) {
$return->addElement(new htmlOutputText(_("DDNS ist not activated. You can activate it in the DHCP settings (DDNS)."))); $return->addElement(new htmlOutputText(_("DDNS ist not activated. You can activate it in the DHCP settings (DDNS).")));
} }
@ -380,7 +380,7 @@ class ddns extends baseModule {
// DNS server // DNS server
$serverInput = new htmlTableExtendedInputField(_('IP address of the DNS server'), 'ip', $this->getDNSServer(), 'dns'); $serverInput = new htmlTableExtendedInputField(_('IP address of the DNS server'), 'ip', $this->getDNSServer(), 'dns');
$return->addElement($serverInput, true); $return->addElement($serverInput, true);
$zones = $this->getZoneNames(); $zones = $this->getZoneNames();
$zone = ''; $zone = '';
$revzone = ''; $revzone = '';
@ -398,15 +398,13 @@ class ddns extends baseModule {
$return->addElement($revZoneInput); $return->addElement($revZoneInput);
} }
} }
return $return; return $return;
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
public function get_pdfEntries($pdfKeys) { public function get_pdfEntries($pdfKeys) {
// attributes are taken from DHCP server object // attributes are taken from DHCP server object
@ -427,7 +425,7 @@ class ddns extends baseModule {
$this->addPDFKeyValue($result, 'reverseZone', _('Reverse zone name'), $revzone); $this->addPDFKeyValue($result, 'reverseZone', _('Reverse zone name'), $revzone);
return $result; return $result;
} }
/** /**
* Returns the IP of the DNS server. * Returns the IP of the DNS server.
* *
@ -450,7 +448,7 @@ class ddns extends baseModule {
} }
return $return; return $return;
} }
/** /**
* Returns the zone names. * Returns the zone names.
* *
@ -478,10 +476,10 @@ class ddns extends baseModule {
$return[1] = $revZone; $return[1] = $revZone;
return $return; return $return;
} }
/** /**
* Returns if DDNS is activated. * Returns if DDNS is activated.
* *
* @return boolean activated * @return boolean activated
*/ */
private function isDynDNSActivated() { private function isDynDNSActivated() {
@ -496,10 +494,10 @@ class ddns extends baseModule {
} }
return $return; return $return;
} }
/** /**
* Sets if DDNS is activated. * Sets if DDNS is activated.
* *
* @param boolean $activated activated * @param boolean $activated activated
*/ */
private function setDynDNSActivated($activated) { private function setDynDNSActivated($activated) {
@ -518,10 +516,10 @@ class ddns extends baseModule {
$this->attributes['dhcpStatements'][] = 'ddns-update-style none'; $this->attributes['dhcpStatements'][] = 'ddns-update-style none';
} }
} }
/** /**
* Returns if fixed IPs are added to DDNS. * Returns if fixed IPs are added to DDNS.
* *
* @return boolean add fixed IPs * @return boolean add fixed IPs
*/ */
private function addFixIPs() { private function addFixIPs() {
@ -536,10 +534,10 @@ class ddns extends baseModule {
} }
return $return; return $return;
} }
/** /**
* Sets if client updates are ignored. * Sets if client updates are ignored.
* *
* @param boolean $add add fixed IPs * @param boolean $add add fixed IPs
*/ */
private function setFixIPs($add) { private function setFixIPs($add) {
@ -555,10 +553,10 @@ class ddns extends baseModule {
$this->attributes['dhcpStatements'][] = 'update-static-leases true'; $this->attributes['dhcpStatements'][] = 'update-static-leases true';
} }
} }
/** /**
* Returns if client updates are ignored. * Returns if client updates are ignored.
* *
* @return boolean ignore client updates * @return boolean ignore client updates
*/ */
private function isIgnoreClientUpdates() { private function isIgnoreClientUpdates() {
@ -573,10 +571,10 @@ class ddns extends baseModule {
} }
return $return; return $return;
} }
/** /**
* Sets if client updates are ignored. * Sets if client updates are ignored.
* *
* @param boolean $ignore ignore client updates * @param boolean $ignore ignore client updates
*/ */
private function setIgnoreClientUpdates($ignore) { private function setIgnoreClientUpdates($ignore) {
@ -595,10 +593,10 @@ class ddns extends baseModule {
$this->attributes['dhcpStatements'][] = 'ignore client-updates'; $this->attributes['dhcpStatements'][] = 'ignore client-updates';
} }
} }
/** /**
* Returns the key for DNS updates. * Returns the key for DNS updates.
* *
* @return String key * @return String key
*/ */
private function getUpdateKey() { private function getUpdateKey() {
@ -613,10 +611,10 @@ class ddns extends baseModule {
} }
return $return; return $return;
} }
/** /**
* Sets the key for DNS updates. * Sets the key for DNS updates.
* *
* @param String $key key * @param String $key key
*/ */
private function setUpdateKey($key) { private function setUpdateKey($key) {
@ -636,7 +634,7 @@ class ddns extends baseModule {
/** /**
* This function loads the LDAP attributes when an account should be loaded. * This function loads the LDAP attributes when an account should be loaded.
* *
* Calling this method requires the existence of an enclosing {@link accountContainer}.<br> * Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
* <br> * <br>
* By default this method loads the object classes and accounts which are specified in {@link getManagedObjectClasses()} * By default this method loads the object classes and accounts which are specified in {@link getManagedObjectClasses()}
@ -647,7 +645,7 @@ class ddns extends baseModule {
public function load_attributes($attributes) { public function load_attributes($attributes) {
// load nothing, attributes are saved in "dhcp_settings" module // load nothing, attributes are saved in "dhcp_settings" module
} }
/** /**
* In this function the LDAP account is built up. * In this function the LDAP account is built up.
* *
@ -676,7 +674,7 @@ class ddns extends baseModule {
} }
return $messages; return $messages;
} }
} }
?> ?>

View File

@ -39,10 +39,10 @@ $Id$
* @return boolean true or false * @return boolean true or false
**/ **/
if (!function_exists('check_ip')) { if (!function_exists('check_ip')) {
/** /**
* Checks if the given IP is valid. * Checks if the given IP is valid.
* *
* @param String $ip IP address * @param String $ip IP address
* @param boolean $subnet IP must be a subnet * @param boolean $subnet IP must be a subnet
*/ */
@ -89,7 +89,7 @@ class dhcp_settings extends baseModule {
private $allowDenyOptions; private $allowDenyOptions;
/** LDAP attributes */ /** LDAP attributes */
public $attributes; public $attributes;
/** /**
* Creates a new dhcp_settings object. * Creates a new dhcp_settings object.
* *
@ -114,7 +114,7 @@ class dhcp_settings extends baseModule {
/** /**
* Returns true if this module can manage accounts of the current type, otherwise false. * Returns true if this module can manage accounts of the current type, otherwise false.
* *
* @return boolean true if module fits * @return boolean true if module fits
*/ */
public function can_manage() { public function can_manage() {
@ -315,7 +315,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
); );
return $return; return $return;
} }
/** /**
* This function fills the message array. * This function fills the message array.
*/ */
@ -343,7 +343,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$this->messages['domainname'][2] = array('ERROR', _('The domain name includes invalid characters. Valid characters are A-Z, a-z, 0-9, ".", "_","-".')); $this->messages['domainname'][2] = array('ERROR', _('The domain name includes invalid characters. Valid characters are A-Z, a-z, 0-9, ".", "_","-".'));
$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->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, ".", "_","-".'));
} }
/** /**
* Returns a list of modifications which have to be made to the LDAP account. * Returns a list of modifications which have to be made to the LDAP account.
* *
@ -366,7 +366,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$return = parent::save_attributes(); $return = parent::save_attributes();
return $return; return $return;
} }
/** /**
* Processes user input of the primary module page. * Processes user input of the primary module page.
* It checks if all input values are correct and updates the associated LDAP attributes. * It checks if all input values are correct and updates the associated LDAP attributes.
@ -406,7 +406,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
$this->setUnknownClients($_POST['unknownClients']); $this->setUnknownClients($_POST['unknownClients']);
} }
// Check domainname: // Check domainname:
if (!empty($_POST['domainname'])) $_POST['domainname'] = trim($_POST['domainname']); if (!empty($_POST['domainname'])) $_POST['domainname'] = trim($_POST['domainname']);
if (!empty($_POST['domainname'])) { if (!empty($_POST['domainname'])) {
@ -441,7 +441,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
} }
$this->setDHCPOption('domain-name-servers', $_POST['dns']); $this->setDHCPOption('domain-name-servers', $_POST['dns']);
// Lease Time // Lease Time
if (!empty($_POST['lease_time'])) { if (!empty($_POST['lease_time'])) {
$_POST['lease_time'] = trim($_POST['lease_time']); $_POST['lease_time'] = trim($_POST['lease_time']);
@ -450,7 +450,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
if (!is_numeric($_POST['lease_time']) && !empty($_POST['lease_time'])) { if (!is_numeric($_POST['lease_time']) && !empty($_POST['lease_time'])) {
$errors[] = $this->messages['lease_time'][0]; $errors[] = $this->messages['lease_time'][0];
} }
// Max lease Time // Max lease Time
if (!empty($_POST['max_lease_time'])) { if (!empty($_POST['max_lease_time'])) {
$_POST['max_lease_time'] = trim($_POST['max_lease_time']); $_POST['max_lease_time'] = trim($_POST['max_lease_time']);
@ -459,7 +459,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
if (!is_numeric($_POST['max_lease_time']) && !empty($_POST['max_lease_time'])) { if (!is_numeric($_POST['max_lease_time']) && !empty($_POST['max_lease_time'])) {
$errors[] = $this->messages['max_lease_time'][0]; $errors[] = $this->messages['max_lease_time'][0];
} }
// Default Gateway // Default Gateway
if (!empty($_POST['routers'])) { if (!empty($_POST['routers'])) {
$_POST['routers'] = trim($_POST['routers']); $_POST['routers'] = trim($_POST['routers']);
@ -468,7 +468,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
} }
$this->setDHCPOption('routers', $_POST['routers']); $this->setDHCPOption('routers', $_POST['routers']);
// Netbios // Netbios
if (!empty($_POST['netbios'])) $_POST['netbios'] = trim($_POST['netbios']); if (!empty($_POST['netbios'])) $_POST['netbios'] = trim($_POST['netbios']);
$netbiosServers = explode(', ', $_POST['netbios']); $netbiosServers = explode(', ', $_POST['netbios']);
@ -483,9 +483,9 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$errors[] = $this->messages['netbios'][0]; $errors[] = $this->messages['netbios'][0];
} }
$this->setDHCPOption('netbios-name-servers', $_POST['netbios']); $this->setDHCPOption('netbios-name-servers', $_POST['netbios']);
$this->setDHCPOption('netbios-node-type', $_POST['netbios_node_type']); $this->setDHCPOption('netbios-node-type', $_POST['netbios_node_type']);
if ($this->getAccountContainer()->dn_orig!=$_SESSION['config']->get_suffix('dhcp')) { if ($this->getAccountContainer()->dn_orig!=$_SESSION['config']->get_suffix('dhcp')) {
// Check subnet // Check subnet
$_POST['subnet'] = trim($_POST['subnet']); $_POST['subnet'] = trim($_POST['subnet']);
@ -500,10 +500,10 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
} }
$this->attributes['dhcpComments'][0] = $_POST['description']; $this->attributes['dhcpComments'][0] = $_POST['description'];
return $errors; return $errors;
} }
/** /**
* Checks if the subnet mask is valid. * Checks if the subnet mask is valid.
* *
@ -523,7 +523,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
return preg_match('/^1*0*$/', $bits); return preg_match('/^1*0*$/', $bits);
} }
/** /**
* Calculates the net mask from the subnet. * Calculates the net mask from the subnet.
* *
@ -539,10 +539,10 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
return $num; return $num;
} }
/** /**
* Returns the HTML meta data for the main account page. * Returns the HTML meta data for the main account page.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
public function display_html_attributes() { public function display_html_attributes() {
@ -593,7 +593,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$nodeSelect = new htmlTableExtendedSelect('netbios_node_type', $nodeOptions, array($nodeType), _('Netbios node type'), 'netbios_type'); $nodeSelect = new htmlTableExtendedSelect('netbios_node_type', $nodeOptions, array($nodeType), _('Netbios node type'), 'netbios_type');
$nodeSelect->setHasDescriptiveElements(true); $nodeSelect->setHasDescriptiveElements(true);
$return->addElement($nodeSelect, true); $return->addElement($nodeSelect, true);
if ($this->getAccountContainer()->dn_orig!=$_SESSION['config']->get_suffix('dhcp')) { if ($this->getAccountContainer()->dn_orig!=$_SESSION['config']->get_suffix('dhcp')) {
// unknown clients // unknown clients
$unknownClients = $this->getUnknownClients(); $unknownClients = $this->getUnknownClients();
@ -622,7 +622,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$return->addElement(new htmlTableExtendedInputField(_('Description'), 'description', $description, 'description'), true); $return->addElement(new htmlTableExtendedInputField(_('Description'), 'description', $description, 'description'), true);
return $return; return $return;
} }
/** /**
* Loads the values of an account profile into internal variables. * Loads the values of an account profile into internal variables.
* *
@ -632,16 +632,16 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
// profile mappings in meta data // profile mappings in meta data
parent::load_profile($profile); parent::load_profile($profile);
$this->attributes['cn'][0] = $profile['cn'][0]; $this->attributes['cn'][0] = $profile['cn'][0];
$this->setDefaultLeaseTime($profile['lease_time'][0]); $this->setDefaultLeaseTime($profile['lease_time'][0]);
$this->setMaxLeaseTime($profile['max_lease_time'][0]); $this->setMaxLeaseTime($profile['max_lease_time'][0]);
$this->setDHCPOption('domain-name', $profile['domainname'][0]); $this->setDHCPOption('domain-name', $profile['domainname'][0]);
$this->setDHCPOption('domain-name-servers', $profile['dns'][0]); $this->setDHCPOption('domain-name-servers', $profile['dns'][0]);
$this->setDHCPOption('routers', $profile['routers'][0]); $this->setDHCPOption('routers', $profile['routers'][0]);
$this->setDHCPOption('netbios-name-servers', $profile['netbios'][0]); $this->setDHCPOption('netbios-name-servers', $profile['netbios'][0]);
$this->setDHCPOption('netbios-node-type', $profile['netbios_node_type'][0]); $this->setDHCPOption('netbios-node-type', $profile['netbios_node_type'][0]);
if ($this->getAccountContainer()->dn_orig!=$_SESSION['config']->get_suffix('dhcp')) { if ($this->getAccountContainer()->dn_orig!=$_SESSION['config']->get_suffix('dhcp')) {
$this->setDHCPOption('subnet-mask', $profile['subnet'][0]); $this->setDHCPOption('subnet-mask', $profile['subnet'][0]);
@ -655,12 +655,10 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$this->attributes['dhcpNetMask'][0] = $num; $this->attributes['dhcpNetMask'][0] = $num;
} }
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$nodeType = $this->getDHCPOption('netbios-node-type'); $nodeType = $this->getDHCPOption('netbios-node-type');
@ -688,10 +686,10 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$this->addSimplePDFField($return, 'netMask', _('Net mask'), 'dhcpNetMask'); $this->addSimplePDFField($return, 'netMask', _('Net mask'), 'dhcpNetMask');
return $return; return $return;
} }
/** /**
* Returns a DHCP option. * Returns a DHCP option.
* *
* @param String $name option name * @param String $name option name
* @return String value * @return String value
*/ */
@ -709,10 +707,10 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
return $return; return $return;
} }
/** /**
* Sets a DHCP option. * Sets a DHCP option.
* *
* @param String $name option name * @param String $name option name
* @param String $value option value * @param String $value option value
*/ */
@ -733,7 +731,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
/** /**
* Returns the default lease time. * Returns the default lease time.
* *
* @return String time * @return String time
*/ */
private function getDefaultLeaseTime() { private function getDefaultLeaseTime() {
@ -748,10 +746,10 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
return $return; return $return;
} }
/** /**
* Sets the default lease time. * Sets the default lease time.
* *
* @param String $time time * @param String $time time
*/ */
private function setDefaultLeaseTime($time) { private function setDefaultLeaseTime($time) {
@ -771,7 +769,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
/** /**
* Returns the unknown clients option. * Returns the unknown clients option.
* *
* @return String unknown clients value * @return String unknown clients value
*/ */
private function getUnknownClients() { private function getUnknownClients() {
@ -787,10 +785,10 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
return $return; return $return;
} }
/** /**
* Sets the unknown clients option. * Sets the unknown clients option.
* *
* @param String $option allow/deny * @param String $option allow/deny
*/ */
private function setUnknownClients($option) { private function setUnknownClients($option) {
@ -811,7 +809,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
/** /**
* Returns the maximum lease time. * Returns the maximum lease time.
* *
* @return String time * @return String time
*/ */
private function getMaxLeaseTime() { private function getMaxLeaseTime() {
@ -826,10 +824,10 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
} }
return $return; return $return;
} }
/** /**
* Sets the maximum lease time. * Sets the maximum lease time.
* *
* @param String $time time * @param String $time time
*/ */
private function setMaxLeaseTime($time) { private function setMaxLeaseTime($time) {
@ -846,7 +844,7 @@ By default, the nodes are configured as H-Nodes which fits for small networks. I
$this->attributes['dhcpStatements'][] = 'max-lease-time ' . $time; $this->attributes['dhcpStatements'][] = 'max-lease-time ' . $time;
} }
} }
/** /**
* In this function the LDAP account is built up. * In this function the LDAP account is built up.
* *

View File

@ -548,10 +548,8 @@ class eduPerson extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -731,10 +731,8 @@ class fixed_ip extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -685,10 +685,8 @@ class freeRadius extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -195,10 +195,8 @@ class hostObject extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -155,10 +155,8 @@ class ieee802device extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -344,10 +344,8 @@ class inetLocalMailRecipient extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -1970,10 +1970,8 @@ class inetOrgPerson extends baseModule implements passwordService {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -390,10 +390,8 @@ class kolabGroup extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -510,10 +510,8 @@ class kolabSharedFolder extends baseModule { // TODO folder type
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -699,10 +699,8 @@ class kolabUser extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -282,10 +282,8 @@ class ldapPublicKey extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -465,10 +465,8 @@ class nisMailAlias extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -521,10 +521,8 @@ class nisMailAliasUser extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -252,10 +252,8 @@ class nisNetGroupHost extends nisNetGroupUser {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -470,10 +470,8 @@ class nisNetGroupUser extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -572,10 +572,8 @@ class nisnetgroup extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -1826,10 +1826,8 @@ class posixAccount extends baseModule implements passwordService {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$uidLabel = _('User name'); $uidLabel = _('User name');

View File

@ -613,10 +613,8 @@ class posixGroup extends baseModule implements passwordService {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -398,10 +398,8 @@ class puppetClient extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -33,13 +33,13 @@ $Id$
* @package modules * @package modules
*/ */
class pykotaBillingCode extends baseModule { class pykotaBillingCode extends baseModule {
/** cache for existing codes (array(dn1 => pykotaBillingCode1, dn2 => pykotaBillingCode2)) */ /** cache for existing codes (array(dn1 => pykotaBillingCode1, dn2 => pykotaBillingCode2)) */
private $codeCache = null; private $codeCache = null;
/** /**
* Returns true if this module can manage accounts of the current type, otherwise false. * Returns true if this module can manage accounts of the current type, otherwise false.
* *
* @return boolean true if module fits * @return boolean true if module fits
*/ */
public function can_manage() { public function can_manage() {
@ -50,7 +50,7 @@ class pykotaBillingCode extends baseModule {
* Returns meta data that is interpreted by parent class * Returns meta data that is interpreted by parent class
* *
* @return array array with meta data * @return array array with meta data
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
*/ */
function get_metaData() { function get_metaData() {
@ -132,7 +132,7 @@ class pykotaBillingCode extends baseModule {
/** /**
* Returns the HTML meta data for the main account page. * Returns the HTML meta data for the main account page.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
function display_html_attributes() { function display_html_attributes() {
@ -206,7 +206,7 @@ class pykotaBillingCode extends baseModule {
} }
return $errors; return $errors;
} }
/** /**
* In this function the LDAP account is built up. * In this function the LDAP account is built up.
* *
@ -251,12 +251,10 @@ class pykotaBillingCode extends baseModule {
} }
return $messages; return $messages;
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();
@ -267,10 +265,10 @@ class pykotaBillingCode extends baseModule {
$this->addSimplePDFField($return, 'pykotaPageCounter', _('Page count')); $this->addSimplePDFField($return, 'pykotaPageCounter', _('Page count'));
return $return; return $return;
} }
/** /**
* Returns if the given billing code already exists. * Returns if the given billing code already exists.
* *
* @param String $code pykotaBillingCode attribute value * @param String $code pykotaBillingCode attribute value
* @return boolean pykotaBillingCode exists * @return boolean pykotaBillingCode exists
*/ */
@ -301,7 +299,7 @@ class pykotaBillingCode extends baseModule {
} }
} }
} }
} }

View File

@ -33,18 +33,18 @@ $Id$
* @package modules * @package modules
*/ */
class pykotaGroup extends baseModule { class pykotaGroup extends baseModule {
/** cache for cn attribute */ /** cache for cn attribute */
private $cnCache = null; private $cnCache = null;
/** cache for pykotaGroupName attribute */ /** cache for pykotaGroupName attribute */
private $pykotaGroupNameCache = null; private $pykotaGroupNameCache = null;
/** list of limit options label => value */ /** list of limit options label => value */
private $limitOptions; private $limitOptions;
/** /**
* Returns if this module also manages the structural object class pykotaObject. * Returns if this module also manages the structural object class pykotaObject.
* This is overridden by a submodule that must provide the structural object class. * This is overridden by a submodule that must provide the structural object class.
* *
* @return boolean structural usage * @return boolean structural usage
*/ */
public function isStructural() { public function isStructural() {
@ -71,7 +71,7 @@ class pykotaGroup extends baseModule {
/** /**
* Returns true if this module can manage accounts of the current type, otherwise false. * Returns true if this module can manage accounts of the current type, otherwise false.
* *
* @return boolean true if module fits * @return boolean true if module fits
*/ */
public function can_manage() { public function can_manage() {
@ -82,7 +82,7 @@ class pykotaGroup extends baseModule {
* Returns meta data that is interpreted by parent class * Returns meta data that is interpreted by parent class
* *
* @return array array with meta data * @return array array with meta data
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
*/ */
function get_metaData() { function get_metaData() {
@ -207,7 +207,7 @@ class pykotaGroup extends baseModule {
/** /**
* Returns the HTML meta data for the main account page. * Returns the HTML meta data for the main account page.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
function display_html_attributes() { function display_html_attributes() {
@ -352,7 +352,7 @@ class pykotaGroup extends baseModule {
/** /**
* This function is used to check if all settings for this module have been made. * This function is used to check if all settings for this module have been made.
* *
* Calling this method requires the existence of an enclosing {@link accountContainer}.<br> * Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
* <br> * <br>
* This function tells LAM if it can create/modify the LDAP account. If your module needs any * This function tells LAM if it can create/modify the LDAP account. If your module needs any
@ -386,7 +386,7 @@ class pykotaGroup extends baseModule {
} }
} }
} }
/** /**
* In this function the LDAP account is built up. * In this function the LDAP account is built up.
* *
@ -457,12 +457,10 @@ class pykotaGroup extends baseModule {
} }
return $messages; return $messages;
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();
@ -477,10 +475,10 @@ class pykotaGroup extends baseModule {
$this->addPDFKeyValue($return, 'pykotaLimitBy', _('Limit type'), $limitByValue); $this->addPDFKeyValue($return, 'pykotaLimitBy', _('Limit type'), $limitByValue);
return $return; return $return;
} }
/** /**
* Returns if the cn attribute should be managed. * Returns if the cn attribute should be managed.
* *
* @return boolean manage cn attribute * @return boolean manage cn attribute
*/ */
private function manageCn() { private function manageCn() {
@ -500,7 +498,7 @@ class pykotaGroup extends baseModule {
/** /**
* Returns if the description attribute should be managed. * Returns if the description attribute should be managed.
* *
* @return boolean manage description attribute * @return boolean manage description attribute
*/ */
private function manageDescription() { private function manageDescription() {
@ -517,10 +515,10 @@ class pykotaGroup extends baseModule {
} }
return false; return false;
} }
/** /**
* Returns if the given cn already exists. * Returns if the given cn already exists.
* *
* @param String $cn cn attribute value * @param String $cn cn attribute value
* @return boolean cn exists * @return boolean cn exists
*/ */
@ -533,7 +531,7 @@ class pykotaGroup extends baseModule {
/** /**
* Returns if the given pykotaGroupName already exists. * Returns if the given pykotaGroupName already exists.
* *
* @param String $pykotaGroupName pykotaGroupName attribute value * @param String $pykotaGroupName pykotaGroupName attribute value
* @return boolean pykotaGroupName exists * @return boolean pykotaGroupName exists
*/ */
@ -543,7 +541,7 @@ class pykotaGroup extends baseModule {
} }
return in_array($pykotaGroupName, $this->pykotaGroupNameCache); return in_array($pykotaGroupName, $this->pykotaGroupNameCache);
} }
/** /**
* Loads the list of group names into the cache. * Loads the list of group names into the cache.
*/ */
@ -560,10 +558,10 @@ class pykotaGroup extends baseModule {
} }
} }
} }
/** /**
* Returns the current group name (cn) of this account. * Returns the current group name (cn) of this account.
* *
* @return String group name * @return String group name
*/ */
private function getCurrentGroupName() { private function getCurrentGroupName() {

View File

@ -33,14 +33,14 @@ $Id$
* @package modules * @package modules
*/ */
class pykotaPrinter extends baseModule { class pykotaPrinter extends baseModule {
/** cache for existing printers (array(dn => array(cn => ..., description => ...))) */ /** cache for existing printers (array(dn => array(cn => ..., description => ...))) */
private $printerCache = null; private $printerCache = null;
/** printer group cache */ /** printer group cache */
private $groupCache = null; private $groupCache = null;
/** list of pass through options: label => value */ /** list of pass through options: label => value */
private $passThroughOptions; private $passThroughOptions;
/** /**
* Creates a new pykotaPrinter object. * Creates a new pykotaPrinter object.
* *
@ -57,7 +57,7 @@ class pykotaPrinter extends baseModule {
/** /**
* Returns true if this module can manage accounts of the current type, otherwise false. * Returns true if this module can manage accounts of the current type, otherwise false.
* *
* @return boolean true if module fits * @return boolean true if module fits
*/ */
public function can_manage() { public function can_manage() {
@ -68,7 +68,7 @@ class pykotaPrinter extends baseModule {
* Returns meta data that is interpreted by parent class * Returns meta data that is interpreted by parent class
* *
* @return array array with meta data * @return array array with meta data
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
*/ */
function get_metaData() { function get_metaData() {
@ -222,7 +222,7 @@ class pykotaPrinter extends baseModule {
/** /**
* Returns the HTML meta data for the main account page. * Returns the HTML meta data for the main account page.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
function display_html_attributes() { function display_html_attributes() {
@ -376,10 +376,10 @@ class pykotaPrinter extends baseModule {
} }
return $errors; return $errors;
} }
/** /**
* This function will create the meta HTML code to show a page to add members. * This function will create the meta HTML code to show a page to add members.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
function display_html_members() { function display_html_members() {
@ -432,7 +432,7 @@ class pykotaPrinter extends baseModule {
$return->addElement($buttonTable); $return->addElement($buttonTable);
return $return; return $return;
} }
/** /**
* Processes user input of the members page. * Processes user input of the members page.
* It checks if all input values are correct and updates the associated LDAP attributes. * It checks if all input values are correct and updates the associated LDAP attributes.
@ -574,12 +574,10 @@ class pykotaPrinter extends baseModule {
} }
return $messages; return $messages;
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();
@ -625,10 +623,10 @@ class pykotaPrinter extends baseModule {
} }
return $return; return $return;
} }
/** /**
* Returns if the given cn already exists. * Returns if the given cn already exists.
* *
* @param String $cn cn attribute value * @param String $cn cn attribute value
* @return boolean cn exists * @return boolean cn exists
*/ */
@ -662,10 +660,10 @@ class pykotaPrinter extends baseModule {
} }
} }
} }
/** /**
* Returns the printer group memberships. * Returns the printer group memberships.
* *
* @return array DNs of parent groups * @return array DNs of parent groups
*/ */
private function getPrinterGroups() { private function getPrinterGroups() {
@ -679,7 +677,7 @@ class pykotaPrinter extends baseModule {
} }
return $this->groupCache; return $this->groupCache;
} }
} }

View File

@ -884,10 +884,8 @@ class pykotaUser extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -611,10 +611,8 @@ class quota extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$this->initQuotas(); $this->initQuotas();

View File

@ -764,10 +764,8 @@ class range extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -36,7 +36,7 @@ class sambaDomain extends baseModule {
/** /**
* Returns true if this module can manage accounts of the current type, otherwise false. * Returns true if this module can manage accounts of the current type, otherwise false.
* *
* @return boolean true if module fits * @return boolean true if module fits
*/ */
public function can_manage() { public function can_manage() {
@ -47,7 +47,7 @@ class sambaDomain extends baseModule {
* Returns meta data that is interpreted by parent class * Returns meta data that is interpreted by parent class
* *
* @return array array with meta data * @return array array with meta data
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
*/ */
function get_metaData() { function get_metaData() {
@ -227,7 +227,7 @@ class sambaDomain extends baseModule {
/** /**
* Returns the HTML meta data for the main account page. * Returns the HTML meta data for the main account page.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
function display_html_attributes() { function display_html_attributes() {
@ -590,10 +590,8 @@ class sambaDomain extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();
@ -610,7 +608,7 @@ class sambaDomain extends baseModule {
$this->addSimplePDFField($return, 'maxPwdAge', _('Maximum password age'), 'sambaMaxPwdAge'); $this->addSimplePDFField($return, 'maxPwdAge', _('Maximum password age'), 'sambaMaxPwdAge');
$this->addSimplePDFField($return, 'lockoutDuration', _('Lockout duration'), 'sambaLockoutDuration'); $this->addSimplePDFField($return, 'lockoutDuration', _('Lockout duration'), 'sambaLockoutDuration');
$this->addSimplePDFField($return, 'lockoutObservationWindow', _('Reset time after lockout'), 'sambaLockoutObservationWindow'); $this->addSimplePDFField($return, 'lockoutObservationWindow', _('Reset time after lockout'), 'sambaLockoutObservationWindow');
if (isset($this->attributes['sambaLogonToChgPwd'])) { if (isset($this->attributes['sambaLogonToChgPwd'])) {
$logonToChgPwd = _('Off'); $logonToChgPwd = _('Off');
if ($this->attributes['sambaPwdHistoryLength'][0] == 2) $logonToChgPwd = _('On'); if ($this->attributes['sambaPwdHistoryLength'][0] == 2) $logonToChgPwd = _('On');

View File

@ -529,10 +529,8 @@ class sambaGroupMapping extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -1904,10 +1904,8 @@ class sambaSamAccount extends baseModule implements passwordService {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -547,10 +547,8 @@ class shadowAccount extends baseModule implements passwordService {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
function get_pdfEntries($pdfKeys) { function get_pdfEntries($pdfKeys) {
$timeZone = getTimeZone(); $timeZone = getTimeZone();

View File

@ -376,10 +376,8 @@ class systemQuotas extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
public function get_pdfEntries($pdfKeys) { public function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -904,10 +904,8 @@ class windowsGroup extends baseModule {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
public function get_pdfEntries($pdfKeys) { public function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -33,10 +33,10 @@ $Id$
* @package modules * @package modules
*/ */
class windowsHost extends baseModule { class windowsHost extends baseModule {
/** /**
* Returns true if this module can manage accounts of the current type, otherwise false. * Returns true if this module can manage accounts of the current type, otherwise false.
* *
* @return boolean true if module fits * @return boolean true if module fits
*/ */
public function can_manage() { public function can_manage() {
@ -47,7 +47,7 @@ class windowsHost extends baseModule {
* Returns meta data that is interpreted by parent class * Returns meta data that is interpreted by parent class
* *
* @return array array with meta data * @return array array with meta data
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
*/ */
public function get_metaData() { public function get_metaData() {
@ -134,7 +134,7 @@ class windowsHost extends baseModule {
/** /**
* Returns the HTML meta data for the main account page. * Returns the HTML meta data for the main account page.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
public function display_html_attributes() { public function display_html_attributes() {
@ -188,10 +188,10 @@ class windowsHost extends baseModule {
} }
return $return; return $return;
} }
/** /**
* This function will create the meta HTML code to show a page to change the member attribute. * This function will create the meta HTML code to show a page to change the member attribute.
* *
* @return htmlElement HTML meta data * @return htmlElement HTML meta data
*/ */
function display_html_managedBy() { function display_html_managedBy() {
@ -227,7 +227,7 @@ class windowsHost extends baseModule {
$return->addElement($buttonTable); $return->addElement($buttonTable);
return $return; return $return;
} }
/** /**
* Processes user input of the members page. * Processes user input of the members page.
* It checks if all input values are correct and updates the associated LDAP attributes. * It checks if all input values are correct and updates the associated LDAP attributes.
@ -279,12 +279,10 @@ class windowsHost extends baseModule {
} }
return $errors; return $errors;
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
public function get_pdfEntries($pdfKeys) { public function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();

View File

@ -2415,10 +2415,8 @@ class windowsUser extends baseModule implements passwordService {
} }
/** /**
* Returns a list of possible PDF entries for this account. * {@inheritDoc}
* * @see baseModule::get_pdfEntries()
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/ */
public function get_pdfEntries($pdfKeys) { public function get_pdfEntries($pdfKeys) {
$return = array(); $return = array();