From bdb5cff592ae6f474e3c131edd939643addc6a62 Mon Sep 17 00:00:00 2001 From: Roland Gruber Date: Sun, 9 Oct 2005 18:05:32 +0000 Subject: [PATCH] code cleanup: removed obsolete parameter from get_pdfentries() and updated PHPDoc comments --- lam/lib/modules.inc | 2 +- lam/lib/modules/account.inc | 11 ++++++----- lam/lib/modules/ieee802device.inc | 4 +++- lam/lib/modules/inetLocalMailRecipient.inc | 4 +++- lam/lib/modules/inetOrgPerson.inc | 11 ++++++----- lam/lib/modules/kolabUser.inc | 6 +++--- lam/lib/modules/nisMailAlias.inc | 4 +++- lam/lib/modules/posixAccount.inc | 9 +++++---- lam/lib/modules/posixGroup.inc | 9 +++++---- lam/lib/modules/quota.inc | 13 ++++++------- lam/lib/modules/sambaAccount.inc | 11 ++++++----- lam/lib/modules/sambaGroupMapping.inc | 11 ++++++----- lam/lib/modules/sambaSamAccount.inc | 11 ++++++----- lam/lib/modules/shadowAccount.inc | 6 +++--- 14 files changed, 62 insertions(+), 50 deletions(-) diff --git a/lam/lib/modules.inc b/lam/lib/modules.inc index 88adf5d9..c753624c 100644 --- a/lam/lib/modules.inc +++ b/lam/lib/modules.inc @@ -1599,7 +1599,7 @@ class accountContainer { function get_pdfEntries() { $return = array(); while(($current = current($this->module)) != null) { - $return = array_merge($return,$current->get_pdfEntries($this->type)); + $return = array_merge($return,$current->get_pdfEntries()); next($this->module); } $return = array_merge($return,array('main_dn' => array('' . _('DN') . '' . $this->dn . ''))); diff --git a/lam/lib/modules/account.inc b/lam/lib/modules/account.inc index 70464550..02fdf68e 100644 --- a/lam/lib/modules/account.inc +++ b/lam/lib/modules/account.inc @@ -215,11 +215,12 @@ class account extends baseModule { return $return; } - /* - * (non-PHPDoc) - * @see baseModule#get_pdfEntries - */ - function get_pdfEntries($account_type = "user") { + /** + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries + */ + function get_pdfEntries() { $return = array(); $return['account_description'] = array('' . _('Description') . '' . $this->attributes['description'][0] . ''); $return['account_uid'] = array('' . _('User name') . '' . $this->attributes['uid'][0] . ''); diff --git a/lam/lib/modules/ieee802device.inc b/lam/lib/modules/ieee802device.inc index 394db370..b2da057e 100644 --- a/lam/lib/modules/ieee802device.inc +++ b/lam/lib/modules/ieee802device.inc @@ -244,7 +244,9 @@ class ieee802Device extends baseModule { } /** - * Returns a list of PDF entries + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries */ function get_pdfEntries() { $return = array(); diff --git a/lam/lib/modules/inetLocalMailRecipient.inc b/lam/lib/modules/inetLocalMailRecipient.inc index 54dbbae4..baafb393 100644 --- a/lam/lib/modules/inetLocalMailRecipient.inc +++ b/lam/lib/modules/inetLocalMailRecipient.inc @@ -348,7 +348,9 @@ class inetLocalMailRecipient extends baseModule { } /** - * Returns a list of PDF entries + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries */ function get_pdfEntries() { $return = array(); diff --git a/lam/lib/modules/inetOrgPerson.inc b/lam/lib/modules/inetOrgPerson.inc index 2967e80b..14da2259 100644 --- a/lam/lib/modules/inetOrgPerson.inc +++ b/lam/lib/modules/inetOrgPerson.inc @@ -672,11 +672,12 @@ class inetOrgPerson extends baseModule { return $return; } - /* - * (non-PHPDoc) - * @see baseModule#get_pdfEntries - */ - function get_pdfEntries($account_type = "user") { + /** + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries + */ + function get_pdfEntries() { return array( 'inetOrgPerson_description' => array('' . _('Description') . '' . $this->attributes['description'][0] . ''), 'inetOrgPerson_host' => array('' . _('Unix workstations') . '' . $this->attributes['host'][0] . ''), diff --git a/lam/lib/modules/kolabUser.inc b/lam/lib/modules/kolabUser.inc index f1f39b2c..564526eb 100644 --- a/lam/lib/modules/kolabUser.inc +++ b/lam/lib/modules/kolabUser.inc @@ -768,9 +768,9 @@ class kolabUser extends baseModule { } /** - * Returns a list of PDF entries - * - * @return array PDF entries + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries */ function get_pdfEntries() { $return = array(); diff --git a/lam/lib/modules/nisMailAlias.inc b/lam/lib/modules/nisMailAlias.inc index 086968f4..f357f4ce 100644 --- a/lam/lib/modules/nisMailAlias.inc +++ b/lam/lib/modules/nisMailAlias.inc @@ -313,7 +313,9 @@ class nisMailAlias extends baseModule { } /** - * Returns a list of PDF entries + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries */ function get_pdfEntries() { $return = array(); diff --git a/lam/lib/modules/posixAccount.inc b/lam/lib/modules/posixAccount.inc index 492bfcf0..2ada0260 100644 --- a/lam/lib/modules/posixAccount.inc +++ b/lam/lib/modules/posixAccount.inc @@ -1113,11 +1113,12 @@ class posixAccount extends baseModule { } } - /* - * (non-PHPDoc) - * @see baseModule#get_pdfEntries + /** + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries */ - function get_pdfEntries($account_type = "user") { + function get_pdfEntries() { return array( 'posixAccount_uid' => array('' . _('User name') . '' . $this->attributes['uid'][0] . ''), 'posixAccount_cn' => array('' . _('Common name') . '' . $this->attributes['cn'][0] . ''), diff --git a/lam/lib/modules/posixGroup.inc b/lam/lib/modules/posixGroup.inc index 8711d972..fd38bb2c 100644 --- a/lam/lib/modules/posixGroup.inc +++ b/lam/lib/modules/posixGroup.inc @@ -441,11 +441,12 @@ class posixGroup extends baseModule { } - /* - * (non-PHPDoc) - * @see baseModule#get_pdfEntries + /** + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries */ - function get_pdfEntries($account_type = "group") { + function get_pdfEntries() { return array( 'posixGroup_cn' => array('' . _('Group name') . '' . $this->attributes['cn'][0] . ''), 'posixGroup_gidNumber' => array('' . _('GID number') . '' . $this->attributes['gidNumber'][0] . ''), diff --git a/lam/lib/modules/quota.inc b/lam/lib/modules/quota.inc index 65fde86d..e0875dce 100644 --- a/lam/lib/modules/quota.inc +++ b/lam/lib/modules/quota.inc @@ -425,13 +425,12 @@ class quota extends baseModule { } } - /** Returns the PDF entries for this module. - * - * @see baseModule#get_pdfEntries - * - * @return array list of possible PDF entries - */ - function get_pdfEntries($account_type = "user") { + /** + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries + */ + function get_pdfEntries() { if (sizeof($this->quota) > 0) { $quotas = array(); $quotas[] = '' . diff --git a/lam/lib/modules/sambaAccount.inc b/lam/lib/modules/sambaAccount.inc index b85ea54e..7bee6d75 100644 --- a/lam/lib/modules/sambaAccount.inc +++ b/lam/lib/modules/sambaAccount.inc @@ -840,11 +840,12 @@ class sambaAccount extends baseModule { return $return; } - /* - * (non-PHPDoc) - * @see baseModule#get_pdfEntries - */ - function get_pdfEntries($account_type = "user") { + /** + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries + */ + function get_pdfEntries() { return array( 'sambaAccount_displayName' => array('' . _('Display name') . 'attributes['displayName'][0] . ''), 'sambaAccount_smbHome' => array('' . _('Home path') . '' . $this->attributes['smbHome'][0] . ''), 'sambaAccount_homeDrive' => array('' . _('Home drive') . '' . $this->attributes['homePath'][0] . ''), diff --git a/lam/lib/modules/sambaGroupMapping.inc b/lam/lib/modules/sambaGroupMapping.inc index ef831f8b..f6b36a41 100644 --- a/lam/lib/modules/sambaGroupMapping.inc +++ b/lam/lib/modules/sambaGroupMapping.inc @@ -305,11 +305,12 @@ class sambaGroupMapping extends baseModule { } - /* - * (non-PHPDoc) - * @see baseModule#get_pdfEntries - */ - function get_pdfEntries($account_type = "User") { + /** + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries + */ + function get_pdfEntries() { return array( 'sambaGroupMapping_gidNumber' => array('' . _('GID number') . '' . $this->attributes['gidNumber'][0] . ''), 'sambaGroupMapping_sambaSID' => array('' . _('Windows group') . '' . $this->attributes['sambaSID'][0] . ''), 'sambaGroupMapping_displayName' => array('' . _('Display name') . '' . $this->attributes['displayName'][0] . ''), diff --git a/lam/lib/modules/sambaSamAccount.inc b/lam/lib/modules/sambaSamAccount.inc index 48fc4aa9..71ec0dd3 100644 --- a/lam/lib/modules/sambaSamAccount.inc +++ b/lam/lib/modules/sambaSamAccount.inc @@ -1191,11 +1191,12 @@ class sambaSamAccount extends baseModule { } } - /* - * (non-PHPDoc) - * @see baseModule#get_pdfEntries - */ - function get_pdfEntries($account_type = "user") { + /** + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries + */ + function get_pdfEntries() { return array( 'sambaSamAccount_displayName' => array('' . _('Display name') . 'attributes['displayName'][0] . ''), 'sambaSamAccount_uid' => array('' . _('User name') . '' . $this->attributes['uid'][0] . ''), 'sambaSamAccount_sambaHomePath' => array('' . _('Home path') . '' . $this->attributes['sambaHomeDrive'][0] . ''), diff --git a/lam/lib/modules/shadowAccount.inc b/lam/lib/modules/shadowAccount.inc index badc67d4..701b2731 100644 --- a/lam/lib/modules/shadowAccount.inc +++ b/lam/lib/modules/shadowAccount.inc @@ -299,9 +299,9 @@ class shadowAccount extends baseModule { } /** - * Returns a list of PDF entries - * - * @return array PDF entries + * Returns the PDF entries for this module. + * + * @return array list of possible PDF entries */ function get_pdfEntries() { return array('shadowAccount_shadowLastChange' => array('' . _('Last password change') . '' . $this->attributes['shadowLastChange'][0] . ''),