Class: accountContainer

Source Location: /lib/modules.inc

Class Overview

This class includes all modules and attributes of an account.

Variables

Methods

Class Details

[line 709]
This class includes all modules and attributes of an account.

[ Top ]

Class Variables

$attributes =

[line 737]

Array of all used attributes

Syntax is attribute => array ( objectClass => MUST or MAY, ...)

Type:

mixed

[ Top ]

$attributes_orig =

[line 758]

original LDAP attributes when account was loaded from LDAP

Type:

mixed

[ Top ]

$base =

[line 764]

Name of accountContainer variable in session

Type:

mixed

[ Top ]

$current_page =

[line 767]

This variable stores the name of the currently displayed page

Type:

mixed

[ Top ]

$dn =

[line 749]

DN suffix of the account

Type:

mixed

[ Top ]

$dn_orig =

[line 752]

DN suffix of account when it was loaded

Type:

mixed

[ Top ]

$isNewAccount =

[line 773]

True if this is a newly created account

Type:

mixed

[ Top ]

$module =

[line 746]

This is an array with all module objects

Type:

mixed

[ Top ]

$order =

[line 761]

Module order

Type:

mixed

[ Top ]

$rdn =

[line 755]

RDN attribute of this account

Type:

mixed

[ Top ]

$subpage =

[line 770]

This variable is set to the pagename of a subpage if it should be displayed

Type:

mixed

[ Top ]

$type =

[line 743]

This variale stores the account type.

Currently "user", "group" and "host" are supported.

Type:

mixed

[ Top ]

Class Methods

constructor accountContainer [line 716]

accountContainer accountContainer(
string
$type, string
$base)

Constructor

Parameters:

string	$type	account type
string	$base	key in $_SESSION where this object is saved

[ Top ]

method continue_main [line 789]

void continue_main(
)

This function is called when the user clicks on any button on the account pages.

It prints the HTML code of each account page.

[ Top ]

method fixLDAPAttributes [line 1207]

array fixLDAPAttributes(
array
$attributes, array
$modules)

Fixes spelling errors in the attribute names.

Tags:

return:

fixed attributes

Parameters:

array	$attributes	LDAP attributes
array	$modules	list of active modules

[ Top ]

method get_pdfEntries [line 1523]

list get_pdfEntries(
)

Returns a list of possible PDF entries for this account.

Tags:

return:

of PDF entries (array(<name> => <PDF lines>))

[ Top ]

method get_type [line 781]

string get_type(
)

Returns the accout type of this object (e.g. user, group, host).

Tags:

return:

account type

[ Top ]

method load_account [line 1148]

array load_account(
string
$dn)

Loads an LDAP account with the given DN.

Tags:

return:

error messages

Parameters:

string

$dn

the DN of the account

[ Top ]

method new_account [line 1280]

void new_account(
)

This function will prepare the object for a new account.

[ Top ]

method save_account [line 1309]

array save_account(
)

This function will save an account to the LDAP database.

Tags:

return:

list of status messages if any errors occured

[ Top ]

method save_module_attributes [line 1074]

array save_module_attributes(
array
$attributes, array
$orig)

This function checks which LDAP attributes have changed while the account was edited.

Tags:

return:

an array which can be passed to $this->saveAccount()

Parameters:

array	$attributes	list of current LDAP attributes
array	$orig	list of old attributes when account was loaded

[ Top ]

method sortModules [line 1536]

void sortModules(
)

Sorts the module buttons for the account page.

[ Top ]

method __sleep [line 1599]

array __sleep(
)

Encrypts sensitive data before storing in session.

Tags:

return:

list of attributes which are serialized

[ Top ]

method __wakeup [line 1611]

void __wakeup(
)

Decrypts sensitive data after accountContainer was loaded from session.

[ Top ]

Documentation generated on Wed, 15 Nov 2006 18:00:54 +0100 by phpDocumentor 1.2.3