modules
[ class tree: modules ] [ index: modules ] [ all elements ]

Class: accountContainer

Source Location: /lib/modules.inc

Class Overview


This class includes all modules and attributes of an account.


Variables

Methods



Class Details

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



[ Top ]


Class Variables

$attributes =

[line 897]

Array of all used attributes

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



Type:   mixed


[ Top ]

$attributes_orig =

[line 921]

original LDAP attributes when account was loaded from LDAP


Type:   mixed


[ Top ]

$dn =

[line 909]

DN suffix of the account


Type:   mixed


[ Top ]

$dn_orig =

[line 912]

DN suffix of account when it was loaded


Type:   mixed


[ Top ]

$finalDN =

[line 918]

DN of saved account



Tags:

access:  public

Type:   mixed


[ Top ]

$isNewAccount =

[line 936]

True if this is a newly created account



Tags:

access:  public

Type:   mixed


[ Top ]

$rdn =

[line 915]

RDN attribute of this account


Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 876]

accountContainer __construct( 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 977]

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 1493]

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 getAccountModule [line 946]

baseModule getAccountModule( string $name)

Returns the account module with the given class name



Tags:

return:  account module


Parameters:

string   $name   class name (e.g. posixAccount)

[ Top ]

method getAccountModules [line 960]

array getAccountModules( )

Returns the included account modules.



Tags:

return:  modules


[ Top ]

method getParentDN [line 1841]

String getParentDN( String $dn)

Returns the parent DN of a given DN.



Tags:

return:  DN


Parameters:

String   $dn   DN

[ Top ]

method getRDN [line 1829]

String getRDN( String $dn)

Returns the RDN part of a given DN.



Tags:

return:  RDN


Parameters:

String   $dn   DN

[ Top ]

method get_pdfEntries [line 1742]

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 969]

string get_type( )

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



Tags:

return:  account type


[ Top ]

method load_account [line 1434]

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 1566]

void new_account( )

This function will prepare the object for a new account.



[ Top ]

method save_account [line 1596]

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 1356]

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 1755]

void sortModules( )

Sorts the module buttons for the account page.



[ Top ]

method __sleep [line 1852]

array __sleep( )

Encrypts sensitive data before storing in session.



Tags:

return:  list of attributes which are serialized


[ Top ]

method __wakeup [line 1864]

void __wakeup( )

Decrypts sensitive data after accountContainer was loaded from session.



[ Top ]


Documentation generated on Mon, 28 Apr 2008 20:17:32 +0200 by phpDocumentor 1.4.0