diff --git a/lam-web/changelog/index.htm b/lam-web/changelog/index.htm deleted file mode 100644 index e22b5f69..00000000 --- a/lam-web/changelog/index.htm +++ /dev/null @@ -1,913 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Changelog

-
-

- - - - - - - - - - - -
2.3.0 (2008-04-30)
-
    -
  • added Polish translation
  • -
  • support phpGroupWare accounts
  • -
  • password policies
  • -
  • redesigned PDF editor
  • -
  • show mail addresses as link in account list
  • -
  • Unix: allow primary group members to be added as memberUid
  • -
  • Kolab: support LAM Pro self service
  • -
  • LAM Pro: new account type for groupOf(Unique)Names
  • -
  • fixed bugs:
  • -
      -
    • XHTML headers should be removed (1912736)
    • -
    -
-

- - - - - - - - - - -
2.2.0 (2008-01-23)
-
    -
  • account lists:
  • -
      -
    • allow to switch sorting
    • -
    • added separate configuration page and store settings in cookies
    • -
    • list size can now be set individually for each account type on the list configuration page
    • -
    • new PDF buttons
    • -
    -
  • use suffix from account list as default for new accounts (patch 1823583)
  • -
  • Security: passwords in configuration files are now saved as hash values
  • -
  • improved design
  • -
  • style fixes for Internet Explorer users
  • -
  • Unix:
  • -
      -
    • allow to set host passwords (RFE 1754069)
    • -
    • allow to generate random passwords for users
    • -
    -
  • Samba 3 groups: Samba part is now optional
  • -
  • Personal: add object classes person and organizationalPerson for new accounts (RFE 1830033)
  • -
  • new LDAP schema check on tests page
  • -
  • LAM Pro:
  • -
      -
    • added possibility for deskside support to reset passwords at account list page
    • -
    • access levels (read only, change passwords, write access) for server profiles
    • -
    -
-

- - - - - - - - - - -
2.1.0 (2007-11-07)
-
    -
  • tabular design for account pages
  • -
  • show DN on account pages
  • -
  • Samba 3: made Samba account optional
  • -
  • Samba 3: manages now terminal server settings
  • -
  • fixed bugs:
  • -
      -
    • LAM Pro: UTF-8 characters are invalid displayed on configuration page (1788752)
    • -
    • LAM works again on PHP 5.1.x (1792447)
    • -
    • Quota: managing group quotas does not work (1811728)
    • -
    • Samba 3 domains: lockout users after bad logon attempts must allow 0 - 999 (1814578)
    • -
    -
-
-

- - - - - - - - - - -
2.0.0 (2007-08-08)
-
    -
  • new translations: Chinese (Simplified), Czech and Portuguese
  • -
  • usability improvements
  • -
  • LDAP accounts including child entries can now be moved
  • -
  • group list can show primary members (RFE 1517679 and patch 1722460)
  • -
  • more translated example texts (RFE 1702140)
  • -
  • inetOrgPerson: now manages homePhone, roomNumber, businessCategory
  • -
  • posixAccount: allow to create home directories in file upload (RFE 1665034)
  • -
  • account lists: display buttons on top and bottom (RFE 1702136)
  • -
  • fixed bugs:
  • -
      -
    • OU editor: help images (1702132)
    • -
    • config editor: extra space (1702269)
    • -
    • fixed some inconsistent help entries (1694863)
    • -
    • user list: refreshing GID translation did not work (1719168)
    • -
    • allow uid as RDN attribute for inetOrgPerson (1740499)
    • -
    • PHP Warning: mcrypt_decrypt(): The IV parameter must be ... (1742543)
    • -
    • uid attribute no longer required for InetOrgPerson (1757215)
    • -
    -
-
-

- - - - - - - - - - -
1.3.0 (2007-03-28)
-
    -
  • improved design
  • -
  • user list can now display jpegPhoto attributes
  • -
  • lamdaemon: support for multiple servers
  • -
  • LAM Pro: users may change their photos (jpegPhoto)
  • -
  • fixed bugs:
  • -
      -
    • ShadowAccount: PDF entry for expire date was wrong (1658868)
    • -
    • Samba groups: fixed help entry (patch 1664542)
    • -
    • Debian package did not include lamdaemonOld.pl (1660493)
    • -
    • NIS mail aliases: allow more characters in alias name (1674198)
    • -
    • fixed syntax errors in some .htaccess files
    • -
    • security fix: HTML special characters in LDAP data were not escaped
    • -
    -
-
-

- - - - - - - - - - -
1.2.0 (2007-01-24)
-
    -
  • Samba 3: better handling of date values
  • -
  • Samba 3: Handling of locked accounts (RFE 1609076)
  • -
  • LAM Pro: modules can define configuration settings (Unix: password hashing)
  • -
  • LAM Pro: management of groupOfNames and groupOfUniqueNames entries (RFE 875482)
  • -
  • fixed bugs:
  • -
      -
    • Lamdaemon test did not work on PHP 4
    • -
    • InetOrgPerson: Problems with error messages (1628799)
    • -
    -
-
-

- - - - - - - - - -
1.1.1 (2006-11-01)
-
    -
  • Lamdaemon: added test page (Tools -> Tests -> Lamdaemon test)
  • -
  • LAM Pro: Samba passwords can now be synchronized with Unix password
  • -
  • Shadow account: better management of expiration date
  • -
  • fixed bugs:
  • -
      -
    • Unix: password hashing problem (1562426)
    • -
    • Unix: No error message for wrong UID numbers in file upload
    • -
    • Filters in account lists get lost when sorting the table
    • -
    -
-
-

- - - - - - - - - -
1.1.0 (2006-09-20)
-
    -
  • Lamdaemon now uses the SSH implementation from PECL which is much more stable
  • -
  • Samba 2/3: "Use Unix password" now on by default (1517678)
  • -
-
-

- - - - - - - - - -
1.0.4 (2006-08-10)
-
    -
  • added Russian translation
  • -
  • Samba 3: added policies for domain objects
  • -
  • inetLocalMailRecipient: print warning if local address is already in use
  • -
-
-

- - - - - - - - - -
1.0.3 (2006-07-05)
-
    -
  • fixed bugs:
  • -
      -
    • Kolab: fixed problem with message about missing password
    • -
    • Unix groups: fixed auto GID
    • -
    • Unix users/groups: fixed silent unlocking of passwords
    • -
    • Unix users/groups: removed invalid password option
    • -
    • Shadow: account expiration date was incorrect in some time zones
    • -
    • User list: fixed problems when deleting users and translated GIDs are activated (1503367)
    • -
    -
-
-

- - - - - - - - - -
1.0.2 (2006-05-24)
-
    -
  • security enhancements: session timeout, logging, host restrictions
  • -
  • handle LDAP attribute aliases correctly
  • -
  • fixed bugs:
  • -
      -
    • PDF creation bug when GID translation is activated (1477111)
    • -
    • allow "@" in passwords (1477878)
    • -
    • Samba 2/3: fixed NT hashes
    • -
    • fixed handling of multi-value attributes (e.g. in inetLocalMailRecipient)
    • -
    -
-
-

- - - - - - - - - -
1.0.1 (2006-04-12)
-
    -
  • LAM can now be installed with "configure" and "make install"
  • -
  • added workaround for misspelled object classes (e.g. sambaSAMAccount by smbldap-tools)
  • -
  • Unix: merged password hash settings for Unix users and groups
  • -
  • Samba 3: added Windows group to profile options
  • -
  • security: LAM checks the session id and client IP
  • -
  • fixed bugs:
  • -
      -
    • Samba 3: hash values were wrong in some rare cases (1440021)
    • -
    • Samba 3: readded time zone selection for logon hours (1407761)
    • -
    • Unix: call of unknown function (1450464)
    • -
    -
-
-

- - - - - - - - - -
1.0.0 (2006-03-01)
-
    -
  • new architecture with support for more account types
  • -
  • new translations: Traditional Chinese, Dutch
  • -
  • fixed bugs:
  • -
      -
    • Samba groups: editing of special groups fixed
    • -
    • changed check for mail addresses (patch 1403922)
    • -
    • fixed JPG upload when MCrypt is enabled
    • -
    • fixed login problems for AD servers
    • -
    • improved sorting of account lists
    • -
    • fixed language setting in default configuration profile
    • -
    • fixed PHP5 warnings (getdate() and mktime())
    • -
    • error messages in Samba domain module (1437425)
    • -
    • fixed expired passwords with shadowAccount module
    • -
    • added lamdaemon.pl compatibility and security patches by Tim Rice
    • -
    -
-
-

- - - - - - - - - -
0.5.3 (2005-12-14)
-
    -
  • accounts are now deleted with subentries
  • -
  • big update for Italian translation
  • -
  • inetOrgPerson: support jpegPhoto images
  • -
  • less restrictive input checks
  • -
  • fixed bugs:
  • -
      -
    • fixed problems with case-insensitive DNs
    • -
    • file upload did not work when max_execution_time=0 (1367957)
    • -
    • posixGroup: fixed help entries
    • -
    -
-
-

- - - - - - - - - -
0.5.2 (2005-11-16)
-
    -
  • new module for SSH public keys
  • -
  • check file permissions on login page
  • -
  • fixed bugs:
  • -
      -
    • creation of home directories did not work
    • -
    • allow spaces in profile names (1333058)
    • -
    • fixed problem with magic_quotes_gpc in profile editor (1333069)
    • -
    • inetOrgPerson: deletion of postal address and fax number now works
    • -
    -
-
-

- - - - - - - - - -
0.5.1 (2005-10-19)
-
    -
  • Samba 3: added support for account expiration
  • -
  • fixed bugs:
  • -
      -
    • automatic UID/GID assignment did not fully work
    • -
    • PDF: additional groups for Unix users
    • -
    • inetOrgPerson: fixed mobile number
    • -
    • Samba 2/3: passwords fixed for file uploads (1311561)
    • -
    • Samba 3: fixed logon hours (patch 1311915)
    • -
    • Samba 3: loading of domain setting from profile did not work
    • -
    • Quota: profile settings fixed
    • -
    • reduced memory usage
    • -
    -
-
-

- - - - - - - - - -
0.5.0 (2005-09-28)
-
    -
  • new architecture:
  • -
      -
    • possibility to create Unix-only accounts
    • -
    • enhanced PDF output
    • -
    • enhanced file upload
    • -
    • enhanced editor for account profiles
    • -
    • dynamic configuration options (based on modules)
    • -
    -
  • new plugin for managing NIS mail aliases (RFE 1050036)
  • -
  • new plugin for managing mail routing with inetLocalMailRecipient (RFE 1092137)
  • -
  • new plugin for managing MAC addresses (RFE 926017)
  • -
  • tree view
  • -
  • schema browser
  • -
  • added developer documentation
  • -
  • all pages in UTF-8
  • -
-
-

- - - - - - - - - -
0.4.10 (2005-07-28)
-
    -
  • added PHP5 support
  • -
-
-
-

- - - - - - - - - -
0.4.9 (2005-03-09)
- fixed bugs:
-  -> fixed error messages when moving an user account
-  -> fixed problem with special group SIDs
-  -> lamdaemon.pl security fix
-
-
-

- - - - - - - - - -
0.4.8 (2005-01-26)
- allow "%" at the beginning of Samba home/profile path -(1107998)
-- fixed bugs:
-  -> fixed IE fix ;-)
-  -> no more warnings for profiles with no additional -groups set
-
-
-

- - - - - - - - - -
0.4.7 (2004-12-18)
- Added "*.exe" to Samba logon script regex (1081715)
-- fixed bugs:
-  -> Fixed doctype of main frame
-  -> Removed syntax check for LDAP suffixes
-  -> Fixed IE bug at login
-  -> Fixed encoding in HTTP header
-  -> Passwords with "'" are now handled correctly at login -(1081460)
-  -> Fixed Samba flags if multiple hosts were created
-  -> Updated .htaccess files to be compatible with newer -Apache versions
-
-
-

- - - - - - - - - -
0.4.6 (2004-05-28)
- fixed bugs:
-  -> Password hashes were not disabled correctly
-  -> Street was copied to postal code on modify (938502)
-  -> Samba host passwords were still wrong
-  -> Underscore was not allowed for host names (934445)
-  -> Deleting postal address or facsimile number failed -(948616)
-  -> TLS error handling (958497)
-  -> Smaller fixes on personal settings page
-
-
-

- - - - - - - - - -
0.4.5 (2004-03-21)
- added French translation
-- fixed bugs:
-  -> StatusMessages with additional variables did not work
-  -> Samba hosts had unnecessary objectClass shadowAccount -(910084)
-  -> Samba host passwords were still wrong
-  -> LAM had problems with non-standard spelled object -classes (907636)
-  -> Perl scripts did not work if Perl is not installed in -/usr/bin/perl (913554)
-  -> roblems when cn!=uid (915041)
-  -> home directories were not deleted by lamdaemon.pl -(913552)
-
-
-

- - - - - - - - - -
0.4.4 (2004-02-29)
- fixed bugs:
-  -> plain posix groups could not be used as Samba 3 -primary group
-  -> if magic_quotes_gpc in php.ini is was set to "Off", -several pages did not work
-  -> some smaller bugs in mass upload
-  -> Samba hash values for hosts were not correct
-  -> Unix passwords could be disabled but not reenabled
-  -> fixed problem with eval() in status.inc (894433)
-
-
-

- - - - - - - - - -
0.4.3 (2004-02-09)
- new login layout
-- added Hungarian and Japanese translations
-- fixed bugs:
-  -> Samba paswords were sometimes empty for new users -(892272)
-  -> links in list views may not work with web servers -other than Apache
-
-
-

- - - - - - - - - -
0.4.2 (2004-01-21)
- added config wizard
-- MHash is only needed for PHP < 4.3
-- use Blowfish for encryption instead of MCrypt
-
-
-

- - - - - - - - - -
0.4.1 (2003-12-29)
- better error handling at login
-- support spaces in DNs
-- PDF text for users
-- create missing OUs recursivly
-- fixed bugs:
-  -> SMD5 passwords were wrong
-  -> primaryGroupSID wrong if SID has no relation to -Algorithmic RID Base
-  -> Samba 2 accounts could not be created
-
-

- - - - - - - - - -
0.4 (Beta 1) (2003-10-29)
- improved design
-- improved documentation
-- Fixed possible error which could delete entries if objectclass didn't -fit
-- Fixed many samba 3.0 related bugs, most related to SIDs
-- edit group members directly
-- support for several password hashes (CRYPT/SHA/SSHA/MD5/SMD5/PLAIN)
-- PDF output for groups and hosts
-
-
-

- - - - - - - - - -
0.3 (Alpha 3) (2003-08-31)
- Samba 3 support
-- manage Samba 3 domains
-- multiple configuration files
-- PDF output
-- better mass creation
-
-

- - - - - - - - - -
0.2 (Alpha 2) (2003-06-05)
- support for multiple OUs + OU-Editor
-- account creation via file upload
-- profile editor
-- experimental Samba 3 support
-- fixed a lot of bugs
-
-

- - - - - - - - - -
0.1 (Alpha 1) (2003-05-24)
Initial release
-
-
- -
- - - - diff --git a/lam-web/cvs-access/index.htm b/lam-web/cvs-access/index.htm deleted file mode 100755 index 130dee75..00000000 --- a/lam-web/cvs-access/index.htm +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

CVS-Access

-

There are basically two ways of accessing the LDAP Account Manager (LAM) CVS repository.

-The first one is through WebCVS. -You can view all LAM CVS files by simply browsing the archive with your browser.
-The second way is through anonymous CVS access with a CVS client of your choice. The commands are:

-cvs -d:pserver:anonymous@lam.cvs.sourceforge.net:/cvsroot/lam login
-cvs -z3 -d:pserver:anonymous@lam.cvs.sourceforge.net:/cvsroot/lam co lam


-More information concerning LAM and CVS can be found at http://sourceforge.net/cvs/?group_id=73243.

- -
- - - - diff --git a/lam-web/debian-packages/ldap-account-manager_2.3.0-1.diff.gz b/lam-web/debian-packages/ldap-account-manager_2.3.0-1.diff.gz deleted file mode 100644 index eb0e2ed4..00000000 Binary files a/lam-web/debian-packages/ldap-account-manager_2.3.0-1.diff.gz and /dev/null differ diff --git a/lam-web/debian-packages/ldap-account-manager_2.3.0-1.dsc b/lam-web/debian-packages/ldap-account-manager_2.3.0-1.dsc deleted file mode 100644 index 6196a9ba..00000000 --- a/lam-web/debian-packages/ldap-account-manager_2.3.0-1.dsc +++ /dev/null @@ -1,29 +0,0 @@ ------BEGIN PGP SIGNED MESSAGE----- -Hash: SHA1 - -Format: 1.0 -Source: ldap-account-manager -Binary: ldap-account-manager -Architecture: all -Version: 2.3.0-1 -Maintainer: Roland Gruber -Homepage: http://lam.sourceforge.net/ -Standards-Version: 3.7.3 -Build-Depends: debhelper (>= 4.1.16), po-debconf -Checksums-Sha1: - 93ff3426a34c0a2109526e9e37f201a208a45ff8 2443111 ldap-account-manager_2.3.0.orig.tar.gz - 09ad837d20dbb8ddd328048704b4eefc20b50244 17095 ldap-account-manager_2.3.0-1.diff.gz -Checksums-Sha256: - 443e869033ea4d7ae69c80bb375a7916ebf3b40809d157203fba2dd939fbc16c 2443111 ldap-account-manager_2.3.0.orig.tar.gz - 21bb3e6ee92f1ebcbe73b39e699e08bf2132169c665048041533954748449dcb 17095 ldap-account-manager_2.3.0-1.diff.gz -Files: - ceb5c6b795be2f3030b695b7f105e6f2 2443111 ldap-account-manager_2.3.0.orig.tar.gz - b3e08d226bc819ac5b7c4b87ad481cc5 17095 ldap-account-manager_2.3.0-1.diff.gz - ------BEGIN PGP SIGNATURE----- -Version: GnuPG v1.4.6 (GNU/Linux) - -iD8DBQFIFhYFq/ywNCsrGZ4RAldzAJ0bEFMFAX4oajce4Hy6vWg2/i+I2ACfdy1o -UGp534ucMMbMN7QRuWOcAIs= -=Vv8k ------END PGP SIGNATURE----- diff --git a/lam-web/debian-packages/ldap-account-manager_2.3.0-1_all.deb b/lam-web/debian-packages/ldap-account-manager_2.3.0-1_all.deb deleted file mode 100644 index 18d349d2..00000000 Binary files a/lam-web/debian-packages/ldap-account-manager_2.3.0-1_all.deb and /dev/null differ diff --git a/lam-web/debian-packages/ldap-account-manager_2.3.0-1_i386.changes b/lam-web/debian-packages/ldap-account-manager_2.3.0-1_i386.changes deleted file mode 100644 index 20822879..00000000 --- a/lam-web/debian-packages/ldap-account-manager_2.3.0-1_i386.changes +++ /dev/null @@ -1,44 +0,0 @@ ------BEGIN PGP SIGNED MESSAGE----- -Hash: SHA1 - -Format: 1.8 -Date: Tue, 28 Apr 2008 16:44:55 +0200 -Source: ldap-account-manager -Binary: ldap-account-manager -Architecture: source all -Version: 2.3.0-1 -Distribution: unstable -Urgency: low -Maintainer: Roland Gruber -Changed-By: Roland Gruber -Description: - ldap-account-manager - webfrontend for managing accounts in an LDAP directory -Closes: 462336 471953 -Changes: - ldap-account-manager (2.3.0-1) unstable; urgency=low - . - * Installation fails if php4 is not installed (Closes: #471953) - * password quality checking (Closes: #462336) -Checksums-Sha1: - 56d82f80161cc8e05a413eeddbec0a0e42d68478 1101 ldap-account-manager_2.3.0-1.dsc - 93ff3426a34c0a2109526e9e37f201a208a45ff8 2443111 ldap-account-manager_2.3.0.orig.tar.gz - 09ad837d20dbb8ddd328048704b4eefc20b50244 17095 ldap-account-manager_2.3.0-1.diff.gz - c032c4bcb93fa3143e9530df8c08c3c0e43523c1 2393982 ldap-account-manager_2.3.0-1_all.deb -Checksums-Sha256: - e51615b58306001d1d34b8c0d22c4a77921c6d4029c8b81ca242a343b0bdb5df 1101 ldap-account-manager_2.3.0-1.dsc - 443e869033ea4d7ae69c80bb375a7916ebf3b40809d157203fba2dd939fbc16c 2443111 ldap-account-manager_2.3.0.orig.tar.gz - 21bb3e6ee92f1ebcbe73b39e699e08bf2132169c665048041533954748449dcb 17095 ldap-account-manager_2.3.0-1.diff.gz - 5a6229d04d63210a676ac3565df22a92ac047b9a59a980b5066af4233e9ac6ea 2393982 ldap-account-manager_2.3.0-1_all.deb -Files: - dd1328bcde69a51c3264f1f1a82b6742 1101 web extra ldap-account-manager_2.3.0-1.dsc - ceb5c6b795be2f3030b695b7f105e6f2 2443111 web extra ldap-account-manager_2.3.0.orig.tar.gz - b3e08d226bc819ac5b7c4b87ad481cc5 17095 web extra ldap-account-manager_2.3.0-1.diff.gz - baf89645f900a8f907e05f1e3bb2257b 2393982 web extra ldap-account-manager_2.3.0-1_all.deb - ------BEGIN PGP SIGNATURE----- -Version: GnuPG v1.4.6 (GNU/Linux) - -iD8DBQFIFhYKq/ywNCsrGZ4RAuJ/AJ0TTviInZxpvODvWMj8hloARr7PgACeLrf9 -zxgekEUyGNjOc2Fd2U3Lbw4= -=m8dD ------END PGP SIGNATURE----- diff --git a/lam-web/debian-packages/ldap-account-manager_2.3.0.orig.tar.gz b/lam-web/debian-packages/ldap-account-manager_2.3.0.orig.tar.gz deleted file mode 100644 index c5fb62ad..00000000 Binary files a/lam-web/debian-packages/ldap-account-manager_2.3.0.orig.tar.gz and /dev/null differ diff --git a/lam-web/developers/devel/FAQ.htm b/lam-web/developers/devel/FAQ.htm deleted file mode 100644 index d5b344b5..00000000 --- a/lam-web/developers/devel/FAQ.htm +++ /dev/null @@ -1,105 +0,0 @@ - - - - Developer FAQ - - - - -
-

Developer FAQ
-

-
-
Q: -Where is the ldap/config object?
-
-A: The ldap object -is in $_SESSION['ldap'] -and the config object in $_SESSION['config'].
-
-
-
-

-
-
Q: -How can I make LDAP operations, where is the user name and password?
-
-A: LAM -automatically reconnects to the LDAP server on every page load. You can -use $_SESSION['ldap']->server() -which is the LDAP server handle.
-Be sure to include ldap.inc before (automatically included for account -modules).
-
-Example: ldap_search($_SESSION['ldap']->server(), $suffix, $filter, $attributes)
-
-
-
-Q: What is the LDAP suffix for -the different account types?
-
-A: Just call $_SESSION['config']->get_Suffix($scope) -where $scope is the account type (user,group, ...).
-Be sure to include ldap.inc before (automatically included for account -modules).
-
-Example: $suffix = $_SESSION['config']->get_Suffix('user')
-
-
-
-Q: How can I check if the user is -really logged in and not calling the scripts by hand?
-
-A: After the user -successfully logged in to LAM the variable $_SESSION['loggedIn'] -is set to true.
-
-
-
-Q: What is the command for these error/warning/info messages?

-
-A: Your script must -include status.inc (automatically included for account -modules) to display these messages.
-The command is StatusMessage(<type>, -<headline>, <text>[, <variables>]).
-
-Parameters:
-
    -
  • <type>: message -type ("ERROR", "WARN", "INFO")
  • -
  • <headline>: -headline for the message (may include format tags)
    -
  • -
  • <type>: text for -the message (may include format tags)
  • -
  • <variables>: -optional, array of variables to include in headline/text
    -The positions in headline/text must be marked with %s before.
  • -
-
-Format of special tags:
-
    -
  • {bold}text{endbold}: "text" is printed bold
  • -
  • {color=#123456}text{endcolor}: "text" is printed in -given color
  • -
  • {link=http://nodomain.org}text{endlink}: This will add a link to -http://nodomain.org which will be labeled "text"
    -
  • -
-
-
-
-
-
- - diff --git a/lam-web/developers/devel/account_modules.htm b/lam-web/developers/devel/account_modules.htm deleted file mode 100644 index 3a468b35..00000000 --- a/lam-web/developers/devel/account_modules.htm +++ /dev/null @@ -1,44 +0,0 @@ - - - - - Account modules - - - -

Account modules
-

-
base module
-
-

-
The account modules control all the -functionality which is specific for LDAP accounts or parts of them. -E.g. they define the account detail pages where the user can edit -accounts, the profile editor sections and much more. They are the core -of LAM.
-
-All account modules are saved in lib/modules/.
-If your module needs any include files etc. please save it in lib/modules/<name of your module>.
-
-Please take a look at the module HowTo for -an example to write your own modules.
-The complete specification for the module interface can be found here.
-
-

Superclass

-All account modules should be -subclasses of the baseModule.
-This allows them to benefit from the meta data in the baseModule and -reduces very much the code since not the complete module interface has -to be implemented.
-
-
-

Module detection

-New modules can simply be copied to lib/modules. -LAM will check what files are inside the directory and provide the user -new modules automatically.
-There is no extra configuration file.
-
-
-
-
- \ No newline at end of file diff --git a/lam-web/developers/devel/account_modules_lib.htm b/lam-web/developers/devel/account_modules_lib.htm deleted file mode 100644 index fe8fc887..00000000 --- a/lam-web/developers/devel/account_modules_lib.htm +++ /dev/null @@ -1,141 +0,0 @@ - - - - - Account modules (modules.inc) - - - - -

Account modules (modules.inc)
-

-
-Modules.inc provides the -interface to all module specific functions. It includes a list of -account independent function and the accountContainer -class. This class represents an LDAP account.
-You should never call module functions directly, always use a function -in modules.inc.
-
-

Account independent functions:

-
-

General functions:

-getModuleAlias: This returns -the alias name of a module. It is used to label buttons or fieldsets.
-
-parseHtml: Converts the LAM -meta HTML code to real HTML code.
-
-
-

Functions for LAM configuration:

-is_base_module: When the given -module is a base module then -this returns true. Every -account type needs exactly one base -module.
-
-getModulesDependencies: Account -modules can specify dependencies to other modules. E.g. Samba accounts -always need a Unix part.
-
-check_module_depends/check_module_conflicts: -This function checks if all module dependencies are satisfied.
-
-getAvailableModules: Returns a -list of available modules. If you need a list of all active modules use -$_SESSION['config']->get_AccountModules().
-
-getConfigOptions: Returns a -list of all configuration options which were defined by the modules.
-
-getConfigDescriptions: Returns -a list of all configuration descriptions and titles for the fieldsets.
-
-checkConfigOptions: Checks if -the user filled in valid values for each option.
-
-
-

Account list functions:

-get_ldap_filter: Each account -list shows only entries which match a given LDAP search filter.
-
-
-

Profile/account pages:

-getRDNAttributes: This returns -a list of possible LDAP RDN -attributes. LAM needs this to build the DN for new accounts.
-
-getProfileOptions: Returns a -list of all profile options which were defined by the account modules.
-
-checkProfileOptions: Checks if -all module options are correct.
-
-
-

Help functions:

-getHelp: Returns a module help -entry.
-
-
-

PDF functions:

-getAvailablePDFFields: Returns -a list of possible PDF fields.
-
-
-

Upload functions:

-getUploadColumns: Returns a -list of possible upload columns and additional information like a -description, help entry and example value.
-
-buildUploadAccounts: Takes the -input of the CSV file and builds the LDAP accounts.
-
-doUploadPostActions: Manages -the execution of actions which need to be done after the accounts are -created.
-
-
-

Class accountContainer:

-This class represents a complete LDAP account. It manages all functions -which concern a specific LDAP entry.
-
-

Important variables:

-There are some class variables which can be of important use in the -account modules.
-
-module: List of account modules -(array('name' => 'object')).
-
-isNewAccount: This variable is true when the account is newly -created, false if loaded from -LDAP.
-
-

Function list:

-continue_main: This function is -called when an account page is displayed. It generates the HTML code -for the account pages.
-
-save_module_attributes: -Finds -differences between current and original account.
-
-load_account: Loads an LDAP -account.
-
-new_account: Creates a new -account.
-
-save_account: Saves an account -to LDAP.
-
-get_pdfEntries: Returns the PDF -values of an account.
-
-
-
- - diff --git a/lam-web/developers/devel/account_pages.htm b/lam-web/developers/devel/account_pages.htm deleted file mode 100644 index c7506423..00000000 --- a/lam-web/developers/devel/account_pages.htm +++ /dev/null @@ -1,32 +0,0 @@ - - - - - Account pages - - - - -

Account pages
-

-
-The account pages are the user interface to create/modify LDAP -accounts. It allows setting basic attributes like the LDAP suffix and -is responsible to show module specific pages.
-
-
-The main script for the account pages is located in templates/account/edit.php. It has -a very simple content. If the page is loaded for the first time it -creates a new accountContainer -inside the session and tells it to load/create an LDAP account. Then it -calles the continue_main() -function of the accountContainer -object which prints all HTML output.
-
-Managing of user input etc. is completly made by the accountContainer.
-
- - diff --git a/lam-web/developers/devel/account_types.htm b/lam-web/developers/devel/account_types.htm deleted file mode 100644 index 2e836ae8..00000000 --- a/lam-web/developers/devel/account_types.htm +++ /dev/null @@ -1,47 +0,0 @@ - - - - - Account types - - - - -

Account types
-

-
base module
-
-

-
The account types define what kind of -accounts can be managed with LAM. If you want to create a new account -module which does not fit in the existing classes of users, groups and -hosts then you need your own account type.
-
-All account types are saved in lib/types/.
-
-Please take a look at the type HowTo for -an example to write your own types.
-The complete specification for the type interface can be found here.
-
-

Superclass

-All account types should be -subclasses of the baseType.
-This reduces very much the code since not the complete type interface -has -to be implemented.
-
-
-

Type detection

-New types can simply be copied to lib/types. -LAM will check what files are inside the directory and provide the user -new types automatically.
-There is no extra configuration file.
-
-
-
-
- - diff --git a/lam-web/developers/devel/account_types_lib.htm b/lam-web/developers/devel/account_types_lib.htm deleted file mode 100644 index b166af2c..00000000 --- a/lam-web/developers/devel/account_types_lib.htm +++ /dev/null @@ -1,43 +0,0 @@ - - - - - Account types (types.inc) - - - - -

Account types (types.inc)
-

-
-Types.inc is the interface to -the account types. It provides information about the type alias names, -descriptions and other things.
-
-

Functions:

-
-

General functions:

-getAlias: This returns -the alias name of a type. It is used to label buttons or fieldsets.
-
-getDescription: Returns a -description for the account type.
-
-
-

Functions for list views:

-getListClassName: Here you can -specify your own class to handle the list view.  This is needed to -label the buttons in the list view.
-
-getDefaultListAttributes: -Returns the default setting for the displayed list attributes. It is -used as default for the LAM configuration.
-
-getListAttributeDescriptions: -Returns a hash array which contains predefined, translated descriptions -of LDAP attributes.
-
-
- - diff --git a/lam-web/developers/devel/base_module.htm b/lam-web/developers/devel/base_module.htm deleted file mode 100644 index 5ecffacf..00000000 --- a/lam-web/developers/devel/base_module.htm +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Base module - - - -

Base module
-

-
base module
-
-

-
The baseModule -is the parent class of all account modules.
-It implements most functions of the module interface and provides -the possibility to use meta data -for the module functions.
-There are also some class variables which are useful for the child -classes.
-
-
-

Meta data

-The baseModule allows you to -not implement the module -interface directly but to provide meta -data which is interpreted by the baseModule.
-If you do not use certain functions of the interface the baseModule also provides dummy -functions. E.g. if your module needs no configuration option you can -just skip this function in your code and the baseModule will tell the -configuration part that there is no option.
-
-To define meta data you have -to implement the function get_metaData(). -This function must return a hash array with the meta options as array -keys.
-Please refer to the module -interface for details about the format of meta data.
-
-
-

Functions
-

-get_scope(): This function -returns the account type ("user", "group", ...) of the module.
-
-For a list of meta data -functions please refer to the module -interface.
-
-
-

Class variables

-$moduleSettings: This variable -contains the configuration settings of all modules.
-$base: This is the name of the -parent accountContainer -($_SESSION[$base]).
-
-
-
-
-
-
-
-
- \ No newline at end of file diff --git a/lam-web/developers/devel/base_type.htm b/lam-web/developers/devel/base_type.htm deleted file mode 100644 index 4a1198bf..00000000 --- a/lam-web/developers/devel/base_type.htm +++ /dev/null @@ -1,27 +0,0 @@ - - - - - Base type - - - - -

Base type
-

-
base type
-
-

-
The baseType -is the parent class of all account types.
-It implements all functions of the type -interface.
-
-However, you surely want to override most of the functions in your -account type class.
-
-
- - diff --git a/lam-web/developers/devel/config.htm b/lam-web/developers/devel/config.htm deleted file mode 100644 index 124bec70..00000000 --- a/lam-web/developers/devel/config.htm +++ /dev/null @@ -1,62 +0,0 @@ - - - - - config.inc - - - - -

config.inc

-
-
-This file includes all functions needed to manage configuration -profiles. It includes classes for the profiles itself and the master -configuration (default profile, master password, etc.).
-
-There are also two global functions for general use: setlanguage and metarefresh
-
-

Meta refresh

-The global function metaRefresh() -takes an URL as argument and prints all HTML code needed for a meta -refresh to this URL.
-
-

Language

-LAM uses gettext to translate -the HTML pages to the different languages. Therefore some preferences -need to be set on every page load. This is done by setlanguage().
-The function should be called directly after starting the session.
-
-The list of possible languages is stored in config/language. It includes the -locale name, the character encoding an the language name.
-All languages use UTF-8 as encoding because LDAP also stores values in -this format.
-
-

Configuration profiles

-Each configuration profile is saved in a single file in config/.
-
-There are two types of configuration options:
-
    -
  • Static options (LDAP server settings, etc.)
    -
  • -
  • Module options (UID/GID ranges)
    -
  • -
-All static options have a describing comment in the configuration file -to make it easier for the user to modify the values. The dynamic -options provided by the modules do not include a comment.
-
-

Master configuration file

-LAM stores the default configuartion profile and a master password in config/config.cfg.
-The master password is verified when the user wants to create/delete -configuration profiles.
- - diff --git a/lam-web/developers/devel/config_files.htm b/lam-web/developers/devel/config_files.htm deleted file mode 100644 index 37bc6219..00000000 --- a/lam-web/developers/devel/config_files.htm +++ /dev/null @@ -1,45 +0,0 @@ - - - - - Configuration profiles - - - - -

Configuration profiles

-
-LAM allows the user to store the configuration settings in profiles. This makes it easy to -manage different LDAP servers. All profile files ae stored in config/ and are named <name>.conf.
-The master configuration file config/config.cfg only stores the -default profile and master password. It has the same file format as the -profiles.
-
-

File format

-LAM allows to store values and comments in the configuration files. -Only one type per line is allowed, it is not possible to mix comments -and values in the same line.
-
-

Settings
-

-<identifier>: <value>
-
-
The first word in the line is taken as identifier for the -setting. It must be followed by a ":" -and a space.
-The rest of the line is taken as the value for this setting.
-
-

Comments

-# Comment
-
-Comments always start with a "#" -as first character and end at the line end. LAM will ignore all lines -starting with a "#".
- - diff --git a/lam-web/developers/devel/config_pages.htm b/lam-web/developers/devel/config_pages.htm deleted file mode 100644 index 813245b6..00000000 --- a/lam-web/developers/devel/config_pages.htm +++ /dev/null @@ -1,78 +0,0 @@ - - - - - LAM - Configuration pages - - - - -
-

Configuration pages

-
-
-
configuration
-
-

Configuration - Login (conflogin.php):

-This is the start page of the configuration editor. The user can select -a profile for editing or go to the profile management page.
-Each account profile is protected with a password which is stored in -the profile.
-The list of possible profiles is returned by getConfigProfiles() -in config.inc, the default profile is returned by an object of class CfgMain from -config.inc.
-
-
-

Configuration - Profile management (profmanage.php):

-Here the user can add and modify configuration profiles or change the -configuration master password.
-The configuration master password prevents unauthorised users from -changing the profiles. The password is saved in config/config.cfg and -managed via the CfgMain -class.
-
-
-

Configuration - Main page (confmain.php):

-This page presents all configuration settings for editing.
-Some of the settings are module independent (e.g. server settings, -language, ...) and displayed always.
-The others are set up by the account modules. Only settings of -currently selected modules are displayed.
-Users may also change the profile password on this page.
-
-
-

Configuration - Module selection (confmodules.php):
-

-On this page the user can select which account modules LAM should use.
-The list of possible modules is returned by getAvailableModules() -in modules.inc and checked for dependencies/conflicts with check_module_depends() -and check_module_conflicts().
-
-Each account type needs exactly one base -module -which is the base of a account by providing a structural object class.
-
-
-

Configuration - Save settings (confsave.php):
-

-This script checks the input and displays possible error messages or an -overview of the saved settings.
-The static settings are set and checked with an object of class Config from -config.inc.
-The account modules manage the input validation for their fields and -are also able to return error messages. This is done with checkConfigOptions() -from modules.inc.
-
-
-
- - diff --git a/lam-web/developers/devel/images/favicon.ico b/lam-web/developers/devel/images/favicon.ico deleted file mode 100644 index 1134d0c2..00000000 Binary files a/lam-web/developers/devel/images/favicon.ico and /dev/null differ diff --git a/lam-web/developers/devel/images/lam_baseModule.png b/lam-web/developers/devel/images/lam_baseModule.png deleted file mode 100644 index 002db6e9..00000000 Binary files a/lam-web/developers/devel/images/lam_baseModule.png and /dev/null differ diff --git a/lam-web/developers/devel/images/lam_baseType.png b/lam-web/developers/devel/images/lam_baseType.png deleted file mode 100644 index 71b48ba7..00000000 Binary files a/lam-web/developers/devel/images/lam_baseType.png and /dev/null differ diff --git a/lam-web/developers/devel/images/lam_config.png b/lam-web/developers/devel/images/lam_config.png deleted file mode 100644 index b3711afc..00000000 Binary files a/lam-web/developers/devel/images/lam_config.png and /dev/null differ diff --git a/lam-web/developers/devel/images/lam_lists.png b/lam-web/developers/devel/images/lam_lists.png deleted file mode 100644 index 1aa637b9..00000000 Binary files a/lam-web/developers/devel/images/lam_lists.png and /dev/null differ diff --git a/lam-web/developers/devel/images/lam_overview.png b/lam-web/developers/devel/images/lam_overview.png deleted file mode 100644 index 303ba858..00000000 Binary files a/lam-web/developers/devel/images/lam_overview.png and /dev/null differ diff --git a/lam-web/developers/devel/images/lam_pdfEditor.png b/lam-web/developers/devel/images/lam_pdfEditor.png deleted file mode 100644 index e9fb8b4b..00000000 Binary files a/lam-web/developers/devel/images/lam_pdfEditor.png and /dev/null differ diff --git a/lam-web/developers/devel/images/lam_profedit.png b/lam-web/developers/devel/images/lam_profedit.png deleted file mode 100644 index 9a2a1639..00000000 Binary files a/lam-web/developers/devel/images/lam_profedit.png and /dev/null differ diff --git a/lam-web/developers/devel/images/lam_upload.png b/lam-web/developers/devel/images/lam_upload.png deleted file mode 100644 index 01896e56..00000000 Binary files a/lam-web/developers/devel/images/lam_upload.png and /dev/null differ diff --git a/lam-web/developers/devel/index.htm b/lam-web/developers/devel/index.htm deleted file mode 100644 index 28fd4683..00000000 --- a/lam-web/developers/devel/index.htm +++ /dev/null @@ -1,126 +0,0 @@ - -LAM development documentation - - - -
-

LDAP Account Manager - Code overview

-These documents are supposed to give developers who want to modify LAM -an overview of the codebase. It focuses mainly on what is done to -generate the HTML output and the most important functions provided by -the library files.
-
-
-overview
-
-
-
-
- - - - - - - - -
-

Web pages:

- -
-

Libraries:

- -
-

Configuration files:

- -
-
-
- - - - - - - -
-

Howtos

- -
-

FAQ

-
-

Specifications

- -
-

Upgrade notes

-
-
- -
-
-
- \ No newline at end of file diff --git a/lam-web/developers/devel/ldap.htm b/lam-web/developers/devel/ldap.htm deleted file mode 100644 index 33a72cf6..00000000 --- a/lam-web/developers/devel/ldap.htm +++ /dev/null @@ -1,55 +0,0 @@ - - - - - ldap.inc - - - - -

ldap.inc

-
-
-This library provides the access to the LDAP server and its content.
-The $_SESSION['ldap'] -object reconnects automatically to the LDAP server on every page load.
-
-
-

1. Server handle

-All PHP functions which access LDAP require a server handle as -parameter. This is managed by ldap.inc.
-You can access it with $_SESSION['ldap']->server.
-
-
-

2. Object classes

-Account modules may want to check if the current LDAP server supports -all required object classes.
-$_SESSION['ldap']->objectClasses -contains a list of object classes and their attributes which is -read from the LDAP server.
-
-
-

3. En-/Decryption

-For security reasons sensitive data like user passwords should be -encrypted before storing in session.
-$_SESSION['ldap']->encrypt(<string>) -encrypts a string and returns a binary object. This can be decrypted -with $_SESSION['ldap']->decrypt(<object>)
-
-Ldap.inc will take care for the crypotographic key.
-
-
-

4. Random values

-Ldap.inc contains a random integer value which is much more secure than -calling mt_rand(). The value -changes on every page load and is accessible in $_SESSION['ldap']->rand.
-If you need multiple values you can get a new value by calling $_SESSION['ldap']->new_rand().
-
- - diff --git a/lam-web/developers/devel/lists.htm b/lam-web/developers/devel/lists.htm deleted file mode 100644 index 5ced52ce..00000000 --- a/lam-web/developers/devel/lists.htm +++ /dev/null @@ -1,95 +0,0 @@ - - - - - LAM - Account lists - - - - -

Account lists

-
-
Account lists
-
-
-
-
-The account lists are all built after the same schema. They provide a -list of found accounts which can be restricted by LDAP filters and the -LDAP OU (Organizational Unit).
-
-The list of LDAP attributes and thus table columns is taken from the -configuration profile (get_...listAttributes() -in config.inc). Each account list has a separate list of attributes.
-Only these attributes are given the LDAP search as attribute parameter.
-There is also a predefined description list for the attributes in -lists.inc. The user may use other values by setting them in the -configuration profile.
-
-The number of accounts per page is limited by a list option. There will be links at the beginning and end of the -list if more accounts were found.
-
-Several common helper functions for sorting and some page elements -reside in lists.inc.
-
-

1. Getting accounts from LDAP

-Each account list has its own LDAP suffix which is saved in the -configuration profile. This is used as search base.
-The account modules provide an LDAP filter (get_ldap_filter() -in modules.inc) to get only accounts of a special type.
-
-This list can be further reduced if the user provides an additional -LDAP filter with the filter boxes or selects another LDAP OU with the -drop-down-box.
-
-

2. Caching LDAP accounts

-The lists usually do not ask the LDAP server for an account list every -time the user changes the page. The accounts are cached in the session.
-
-A new LDAP search is done if the user:
-
    -
  • changes to another account list or tool
  • -
  • adds/modifies an account
  • -
  • selects the "refresh" button
  • -
  • adds additional LDAP filters or changes the LDAP OU
    -
  • -
-
-It is not done if the user:
-
    -
  • changes the list pages if there are more accounts than what can -be shown
  • -
  • sorts the list
  • -
-
-

3. Adding/Editing accounts

-There are buttons at the end of the page to add/delete accounts. Adding -accounts is done by account/edit.php and deleting by delete.php.
-
-The user can use the link in each account row to modify (in -accounts/edit.php) the account. This can also be done by double -clicking the row if Java Script is enabled.
-
-
-

4. Export to PDF

-The user can generate PDF files for the accounts. This is done by the createModulePDF() -function from pdf.inc.
-
-
-

5. Special abilities of some lists

-

5.1. The user list

-If the attribute gidNumber is -shown as table column then there will be an additional checkbox to -translate the GID to the group name.
-This checkbox is hidden if gidNumber -is not part of the attribute list.
-
-

5.2. The group list

-If the attribute memberUID is shown as table column then all values of -this attribute are shown as links.
-These links redirect to userlink.php which tries to find the given user -and redirects to account/edit.php for account modifying.
-
-
-
- \ No newline at end of file diff --git a/lam-web/developers/devel/login.htm b/lam-web/developers/devel/login.htm deleted file mode 100644 index 2a03512a..00000000 --- a/lam-web/developers/devel/login.htm +++ /dev/null @@ -1,71 +0,0 @@ - - - - - Login - - - - -

Login
-

-

-
-

-
The login -page is the first page the user sees when opening LAM. It manages LDAP -authentication and checks the environment of the user.
-
-
-

login.php

-The login page offers authentication, language selection and profile -selection. There are also some environment checks.
-
-

Authentication

-The list of possible users is loaded from the current active profile. -Only the RDN value is offered for selection by the user.
-When the user submits his password then a new Ldap object is created and LAM -tries to connect to the LDAP server.
-If the connection was successful the user is forwarded to the main -frame (main.php). The session variable $_SESSION['loggedIn'] -is set to true. This informs -the other PHP scripts that a valid user is connected (e.g. the user is -allowed to create account profiles).
-
-

Language selection

-The list of possible languages is read from config/language. The current active -profile defines the preselected language and the language of the login -page itself.
-
-

Profile selection
-

-The user can change the active configuration profile at login. A list -of possible profiles is retrieved by getConfigProfiles().
-If the profile is changed then the login replaces the config object in $_SESSION['config'] -by a new one. Then the main login page is loaded and uses the new -values.
-
-

Environment checks

-LAM checks if all needed PHP extensions are installed.
-
    -
  • LDAP: PHP needs LDAP -support
  • -
  • MHash: needed for -password creation
  • -
  • Gettext: needed for -translation
    -
  • -
-
-
-
-
-
- - diff --git a/lam-web/developers/devel/mod_accountPages.htm b/lam-web/developers/devel/mod_accountPages.htm deleted file mode 100644 index 8b88e057..00000000 --- a/lam-web/developers/devel/mod_accountPages.htm +++ /dev/null @@ -1,372 +0,0 @@ - -Module HowTo - Account pages - - - - -
-

Module HowTo - Account pages
-

-
-
-

-

1. Loading the LDAP attributes
-

-Every time the user selects an existing account to modify LAM will load -the complete LDAP entry of it. Your module then should select the -attributes which are useful for it.
-There are two variables in baseModule -which should be used to store the attributes. The $attributes variable stores the -current attributes including changes the user made. The $orig variable stores the attributes -as they were originally when the account was loaded. This allows you to -see what changes were made.
-
-The load_attributes() function -in your module gets the complete attribute list from LDAP.
-
-Example:
-
-The ieee802Device uses an -object class and the 'macAddress' -attribute. Therefore we will save this two values.
-
- - - - - - -
    /**
-    * This function loads all needed attributes into the -object.
-    *
-    * @param array $attr an array as it is retured from -ldap_get_attributes
-    */
-    function load_attributes($attr) {
-        -$this->attributes['objectClass'] = array();
-        -$this->attributes['macAddress'] = array();
-        $this->orig['objectClass'] = -array();
-        $this->orig['macAddress'] = -array();
-        if (isset($attr['objectClass'])) {
-            -unset($attr['objectClass']['count']);
-            -$this->attributes['objectClass'] = $attr['objectClass'];
-            -$this->orig['objectClass'] = $attr['objectClass'];
-        }
-        if (isset($attr['macAddress'])) {
-            -unset($attr['macAddress']['count']);
-            -$this->attributes['macAddress'] = $attr['macAddress'];
-            -$this->orig['macAddress'] = $attr['macAddress'];
-        }
-        return 0;
-    }
-
-
-
-

2. Page display

-Now that you have defined your subpages you will need one function for -each page to display it. The function must return meta HTML code as defined in the modules specification.
-This function is called display_html_<page -name>() where <page -name> is the name of your subpage.
-
-Example:
-
-The -ieee802Device -module has only one subpage called 'attributes'.
-
-The first half of the code displays the existing MAC addresses and the -second an input field for new values.
-The variable $this->attributes -contains the LDAP attributes which are useful for this module.
-
- - - - - - -
    /**
-    * This function will create the meta HTML code to -show a page with all attributes.
-    *
-    * @param array $post HTTP-POST values
-    */
-    function display_html_attributes($post) {
-        $return = array();
-        // list current MACs
-        for ($i = 0; $i < -sizeof($this->attributes['macAddress']); $i++) {
-            $return[] = -array(
-            -    array('kind' => 'text', 'text' => -_('MAC address')),
-            -    array('kind' => 'input', 'name' => -'macAddress' . $i, 'type' => 'text', 'size' => '17', 'maxlength' -=> '17', 'value' => $this->attributes['macAddress'][$i]),
-            -    array('kind' => 'input', 'type' => -'submit', 'name' => 'delMAC' . $i, 'value' => _("Remove")),
-            -    array('kind' => 'help', 'value' => -'mac'));
-        }
-        // input box for new MAC
-        $return[] = array(
-            array('kind' => 'text', 'text' => _('New MAC address')),
-            array('kind' => 'input', 'name' => 'macAddress', 'type' => -'text', 'size' => '17', 'maxlength' => '17', 'value' => ''),
-            array('kind' => 'input', 'type' => 'submit', 'name' => -'addMAC', 'value' => _("Add")),
-            array('kind' => 'help', 'value' => 'mac'),
-            array('kind' => 'input', 'type' => 'hidden', 'value' => -sizeof($this->attributes['macAddress']), 'name' => 'mac_number'));
-        return $return;
-    }
-
-
-
-

3. Processing input data
-

-Every time the user clicks on a submit button while your page is -displayed LAM will call a function in your module.
-This function is called process_<page -name>() where <page -name> is the name of your subpage.
-
-If all input data is ok then return an empty array. If you return one or more error messages then the user will be -redirected to your page.
-
-Example:
-
-The -ieee802Device -module has only one subpage called 'attributes' -and therefore only process_attributes().
-
-The function checks the input fields and fills the LDAP attributes. If -all is ok it will enable the user to move to another module page.
-
- - - - - - -
    /**
-    * Write variables into object and do some regex -checks
-    *
-    * @param array $post HTTP-POST values
-    */
-    function process_attributes($post) {
-        $errors = array();
-        -$this->attributes['macAddress'] = array();
-        // check old MACs
-        if (isset($post['mac_number'])) {
-            for ($i = 0; -$i < $post['mac_number']; $i++) {
-            -    if (isset($post['delMAC' . $i])) continue;
-            -    if (isset($post['macAddress' . $i]) && -($post['macAddress' . $i] != "")) {
-            -        // check if address has correct -format
-            -        if (!get_preg($post['macAddress' -. $i], 'macAddress')) {
-            -            $message = -$this->messages['mac'][0];
-            -            $message[] = -$post['macAddress' . $i];
-            -            $errors[] = $message;
-            -        }
-            -        -$this->attributes['macAddress'][] = $post['macAddress' . $i];
-            -    }
-            }
-        }
-        // check new MAC
-        if (isset($post['macAddress']) -&& ($post['macAddress'] != "")) {
-            // check if -address has correct format
-            if -(get_preg($post['macAddress'], 'macAddress')) {
-            -    $this->attributes['macAddress'][] = -$post['macAddress'];
-            }
-            else {
-            -        $message = -$this->messages['mac'][0];
-            -        $message[] = $post['macAddress'];
-            -        $errors[] = $message;
-            }
-        }
-        -$this->attributes['macAddress'] = -array_unique($this->attributes['macAddress']);
-        return $errors;
-    }
-
-
-
-

4. Defining that your module is ready for user input and LDAP -add/modify

-In most cases you will not need to implement these functions. The baseModule will return true for both functions.
-
-
-There are two functions which control the module status:

-
-The module_ready() function -has to -return true if the user may -move to your module page. If it is false -the user will be shown an error message that your module is not yet -ready. You can use this if your module depends on input data from other -modules (e.g. you need the user name from posixAccount first).
-
-The second function is -module_complete(). The user -cannot do the LDAP operation if one or more modules return false. This defines if all needed -input data for your module was entered.
-Use this function if you want to check that all required attributes are -set.
-
-Example:
-
-The sambaSamAccount -module needs the user's uidNumber -and gidNumber before it can -accept input and the account needs a sambaSID -before it can be saved.
-
- - - - - - -
    /**
-    * This function is used to check if this module page -can be displayed.
-    * It returns false if a module depends on data from -other modules which was not yet entered.
-    *
-    * @return boolean true, if page can be displayed
-    */
-    function module_ready() {
-        if -($_SESSION[$this->base]->module['posixAccount']->attributes['gidNumber'][0]=='') -return false;
-        if -($_SESSION[$this->base]->module['posixAccount']->attributes['uidNumber'][0]=='') -return false;
-        if -($this->attributes['uid'][0]=='') return false;
-        return true;
-    }
-
-    /**
-    * This functions is used to check if all settings -for this module have been made.
-    *
-    * @return boolean true, if settings are complete
-    */
-    function module_complete() {
-        if (!$this->module_ready()) -return false;
-        if -($this->attributes['sambaSID'][0] == '') return false;
-        return true;
-    }
-
-
-
-
-

5. Saving the LDAP attributes
-

-In most cases you will not have to implement this option if you use $this->attributes and $this->orig to manage the LDAP -attributes. The baseModule -will generate the save comands for you.
-
-When all modules report that they are ready for LDAP add/modify and the -user clicks on the add/modify button your module will be asked what -changes have to be made.
-This is done in the function save_attributes().
-
-Example:
-
-The kolabUser module uses -this function to make sure that its object class is saved. Other -modules (e.g. quota) use it build the lamdaemon commands.
-
- - - - - - -
    /**
-    * Returns a list of modifications which have to be -made to the LDAP account.
-    *
-    * @return array list of modifications
-    * <br>This function returns an array with 3 -entries:
-    * <br>array( DN1 ('add' => array($attr), -'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
-    * <br>DN is the DN to change. It may be -possible to change several DNs (e.g. create a new user and add him to -some groups via attribute memberUid)
-    * <br>"add" are attributes which have to be -added to LDAP entry
-    * <br>"remove" are attributes which have to be -removed from LDAP entry
-    * <br>"modify" are attributes which have to -been modified in LDAP entry
-    */
-    function save_attributes() {
-        // add object class if needed
-        if -(!isset($this->attributes['objectClass']) || -!in_array('kolabInetOrgPerson', $this->attributes['objectClass'])) {
-            -$this->attributes['objectClass'][] = 'kolabInetOrgPerson';
-        }
-        return parent::save_attributes();
-    }
-
-
-
- -

-
-
- \ No newline at end of file diff --git a/lam-web/developers/devel/mod_basics.htm b/lam-web/developers/devel/mod_basics.htm deleted file mode 100644 index 98efa65a..00000000 --- a/lam-web/developers/devel/mod_basics.htm +++ /dev/null @@ -1,110 +0,0 @@ - - - - Module HowTo - Basic concepts - - - - -
-

Module HowTo - Basic concepts
-

-
-
-

-

1. Licensing

-LAM is licensed under the GNU -General Public License. This means your plugins need a compatible -license.
-LAM is distributed with a copy of the GPL license.
-
-

2. Naming and position in directory structure

-
-Module names are usually named after the object class they manage. -However, you can use any name you want, it should be short and -containing only a-z and 0-9. The module name is only shown in the -configuration dialog, on all other pages LAM will show a provided alias name.
-All account modules are stored in lib/modules. -The filename must end with .inc -and the file must have the same name as its inside class.
-
-Example: -Our example module will provide the class -ieee802Device, -therefore the file will be called lib/modules/ieee802Device.inc.
-
-
-

3. Defining the class

-All module classes have baeModule -as parent class. This provides common functionality and dummy functions -for all required class functions.
-
-Example:
-
- - - - - - -
/**
-* Provides MAC addresses for hosts.
-*
-* @package modules
-*/
-class
ieee802Device - extends baseModule {
-
-}
-
-
-

4. Meta data

-The module interface inludes a lot of required and optional functions. -Many of these functions do not need to be implemented directly in the -module, you can define meta data -for them and the baseModule -will do the rest.
-Providing meta data is -optional, you can implement the required functions in your class, too.
-
-The baseModule reads the meta data by calling get_metaData() in your class.
-
-Example:
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function get_metaData() {
-        $return = array();
-        // manages host accounts
-        $return["account_types"] = -array("host");
-    }
-
-
-You will see this functions several times in the next parts of this -HowTo.
-
-

-
-
- - diff --git a/lam-web/developers/devel/mod_config.htm b/lam-web/developers/devel/mod_config.htm deleted file mode 100644 index d4e6c138..00000000 --- a/lam-web/developers/devel/mod_config.htm +++ /dev/null @@ -1,183 +0,0 @@ - -Module HowTo - Configuration options - - - - - - -

Module HowTo - Configuration options
-

-

-There might be situations where you want to give the user the -possibility to make general settings which are not useful to place on -the account detail pages or profile editor.
-Therefore LAM allows the modules to define their own configuration -options. E.g. the posixAccount -module uses this to define the ranges for the UIDs.
-LAM will display your configuration options only if the user also -selected your module.
-
-

-

1. Defining configuration options
-

-First you have to define what options you want to offer the user. LAM -will display all options in one fieldset for each module. Please notice -that there will be no separation on account types if you module is -suitable for different account types.
-
-The configuration options are specified with get_configOptions() -or meta['config_options'].
-
-Example:
-
-The posixGroup module offers -three configuration options. The min/maximum values for GIDs and the -password hash type.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // configuration options
-        $return['config_options']['group'] = array(
-            array(
-           -     array('kind' => 'text', 'text' => -'<b>' . -_('Minimum GID number') . " *: </b>"),
-                array('kind' => 'input', 'name' => -'posixGroup_minGID', 'type' => 'text', 'size' => '10', -'maxlength' => '255'),
-           -     array('kind' => 'text', 'value' => -'&nbsp;'),
-           -     array('kind' => 'text', 'text' => -'<b>' . -_('Maximum GID number') . " *: </b>"),
-                array('kind' => 'input', 'name' => -'posixGroup_maxGID', 'type' => 'text', 'size' => '10', -'maxlength' => '255'),
-           -     array('kind' => 'help', 'value' => -'minMaxGID')),
-            array(
-           -     array('kind' => 'text', 'text' => -'<b>' . -_("Password hash type") . ': &nbsp;</b>'),
-                array('kind' => 'select', 'name' => -'posixGroup_pwdHash', 'size' => '1', 'options' => array("CRYPT", "SHA", "SSHA", "MD5", "SMD5", -"PLAIN"), 'options_selected' => array('SSHA')),
-           -     array('kind' => 'text', 'value' => -'&nbsp;'),
-           -     array('kind' => 'text', 'value' => -'&nbsp;'),
-           -     array('kind' => 'text', 'value' => -'&nbsp;'),
-                array('kind' => 'help', 'value' => 'pwdHash'))
-        );
-        [...]
-
-
-The min/maximum GID numbers are defined with simple text boxes. The -password hash is selected with a drop down box and SSHA as default -value.
-You should make sure that the column count (here: 6) is the same for -each row. Otherwise the configuration page might be badly rendered by -the browser.
-
-

2. Checking user input

-Probably you also want to check if the input data is syntactically -correct.
-The baseModule already -provides different checks which can be activated with meta data. However you can also do -the checking in the module.
-Implementing the function check_configOptions() -in your module will allow you to do the checks yourself. Basic checks -can be defined with meta['config_checks'].
-
-Example:
-
-The posixGroup module only -needs to check if the GID numbers are correct. The password hash type -needs not to be checked as it is a selection.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // configuration checks
-        $return['config_checks']['group']['posixGroup_minGID'] = -array (
-            'type' => -'ext_preg',
-            'regex' => -'digit',
-            'required' -=> true,
-           - 'required_message' => $this->messages['gidNumber'][5],
-           - 'error_message' => $this->messages['gidNumber'][5]);
-        $return['config_checks']['group']['posixGroup_maxGID'] = -array (
-            'type' => -'ext_preg',
-            'regex' => -'digit',
-            'required' -=> true,
-           - 'required_message' => $this->messages['gidNumber'][6],
-           - 'error_message' => $this->messages['gidNumber'][6]);
-        $return['config_checks']['group']['cmpGID'] = array (
-            'type' => -'int_greater',
-            'cmp_name1' -=> 'posixGroup_maxGID',
-            'cmp_name2' -=> 'posixGroup_minGID',
-           - 'error_message' => $this->messages['gidNumber'][7]);
-        [...]
-
-
-The type "ext_preg" means that -the baseModule will use the get_preg() function in lib/account.inc for the syntax -check. This function already contains regular expressions for the most -common cases.
-To check if the minimum GID is smaller than the maximum GID we define a -check for the nonexistant option "cmpGID" and define it as optional. -This will do the comparison check.
-
-
-
- \ No newline at end of file diff --git a/lam-web/developers/devel/mod_ext.htm b/lam-web/developers/devel/mod_ext.htm deleted file mode 100644 index c36276c9..00000000 --- a/lam-web/developers/devel/mod_ext.htm +++ /dev/null @@ -1,56 +0,0 @@ - - - - Module HowTo - Defining required extensions - - - - -
-

Module HowTo - Defining required extensions
-

-

-Your account module might require special PHP extensions. LAM can check -this for you and display an error message at the login page.
-
-
-
You will need to implement the function getRequiredExtensions() or use meta['extensions'].
-
-Example:
-
-The posixAccount module needs -to generate password hashes. Therefore it needs the MHash extension.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // PHP extensions
-        $return["extensions"] = -array("mhash");
-        [...]
-
-
-
-
- -

-
-
- - diff --git a/lam-web/developers/devel/mod_general.htm b/lam-web/developers/devel/mod_general.htm deleted file mode 100644 index aa19ec2b..00000000 --- a/lam-web/developers/devel/mod_general.htm +++ /dev/null @@ -1,327 +0,0 @@ - -Module HowTo - General module options - - - - - -
-

Module HowTo - General module options
-

-
-
-

-

1. Account types
-

-LAM currently provides three account types: users, groups, hosts
-
A module can manage one or more account types.
-
-The types are specified with can_manage() -or meta['account_types'].
-
-Example:
-
-Our ieee802Device -module will be used only for host accounts.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // manages host accounts
-     -    $return["account_types"] = array("host");
-        return $return;
-    }
-
-
-
-

2. Base modules
-

-In LDAP every entry needs exactly one structural -object class. Therefore all modules which provide a structural object class are marked -as base module.
-
-This is done with is_base_module() -or meta['is_base'].
-
-Example:
-
-The inetOrgPerson -module manages the structural object class "inetOrgPerson" and -therefore is a base module.
-If your module is not a base module you can skip the meta data for -this, default is false.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // base module
-     -    $return["is_base"] = true;
-        return $return;
-    }
-
-
-
-

3. Alias name

-The module name is very limited, therefore every module has an alias name. This alias name has no limitations and -can be translated. It may contain special characters but make sure that -it does not contain HTML special characters like "<".
-The alias name can be the -same for all managed account types -or differ for each type.
-
-The alias name is specified -with get_alias() -or meta['alias'].
-
-Example:
-
-Our ieee802Device -module will get the alias MAC address.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-         // alias name
-     -    $return["alias"] = _("MAC address");
-        return $return;
-    }
-
-
-
-

4. Dependencies

-Modules can depend on eachother. This is useful if you need to access -attributes from other modules or the managed object classes of your -module are not structural.
-
-The dependencies are specified with get_dependencies() -or meta['dependencies'].
-
-Example:
-
-Our ieee802Device -module depends on the account module (because it is the only structural -module at this time).
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-         // module dependencies
-     -    $return['dependencies'] = array('depends' => -array('account'), 'conflicts' => array());
-        return $return;
-    }
-
-
-
-

5. Messages

-There are many situations where you will display messages to the user. -The modules should define such messages at a common place to make it -easier to modify them without searching the complete file.
-The baseModule offers the $messages variable for this. It -should be filled by a function called load_Messages().
-The baseModule will -automatically check if you have implemented this function and call it -at construction time.
-
-Example:
-
-Now let our ieee802Device -module define a message.
-
- - - - - - -
    /**
-    * This function fills the error message array with -messages
-    */
-    function load_Messages() {
-        $this->messages['mac'][0] = -array('ERROR', 'MAC address is invalid!');  // third array value -is set dynamically
-    }
-
-
-
-

6. Managed object classes
-

-

-You can tell LAM what object classes are managed by your module.
-LAM will then check the spelling of the objectClass attributes and -correct it automatically. This is useful if other applications (e.g. -smbldap-tools) also create accounts and the spelling is differnt.
-
-Example:
-
-The ieee802Device module -manages one object class.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-         // managed object classes
-     -    $return['objectClasses'] = array('ieee802Device');
-        return $return;
-    }
-
-
-
-

7. Known LDAP aliases
-

-LDAP attributes can have several names (e.g. "cn" and "commonName" are -the same). If you manage such attributes then tell LAM about the alias -names.
-LAM will then convert all alias names to the given attribute names -automatically.
-
-Example:
-
-The posixGroup module manages -the "cn" attribute. This attribute is also known under the alias -"commonName".
-This way the module will never see attributes called "commonName" -because LAM renames them as soon as the LDAP entry is loaded.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // LDAP aliases
-     -    $return['LDAPaliases'] = array('commonName' => -'cn');
-        return $return;
-    }
-
-
-
- -

-
-
-

8. Icon
-

-You can specify a icon for you module. It will be displayed on the -account pages and other module specific places (e.g. file upload).
-The icons must be 32x32 pixels in size. The location is relative to the graphics directory.
- -
- -Example:
- -
- -The posixGroup module uses the "tux.png" from the graphics directory.
- -
- - - - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
        // icon
-        $return['icon'] = 'tux.png';
-        return $return;
-    }
-
- -
- -
- - -

- - - - \ No newline at end of file diff --git a/lam-web/developers/devel/mod_help.htm b/lam-web/developers/devel/mod_help.htm deleted file mode 100644 index cb0ce433..00000000 --- a/lam-web/developers/devel/mod_help.htm +++ /dev/null @@ -1,89 +0,0 @@ - - - - Module HowTo - Help entries - - - - -
-

Module HowTo - Help entries
-

-
-
-

-

1. Defining help entries
-

-Your module should provide help for all input fields and other -important things.
-The LAM help system defines an extra ID range for each module. So you -are free in defining your own IDs.
-
-The help entries are specified with get_help() -or meta['help'].
-
-Example:
-
-The ieee802Device -module needs help entries for the MAC address.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-    -     // help Entries
-     -    $return['help'] = array(
-     -        'mac' => array(
-     -            "Headline" -=> _("MAC address"),
-     -            "Text" => -_("This is the MAC address of the network card of the device (e.g. -00:01:02:DE:EF:18).")
-     -        ),
-     -        'macList' => array(
-     -            "Headline" -=> _("MAC address list"),
-     -            "Text" => -_("This is a comma separated list of MAC addresses.")
-     -        ));
-        return $return;
-    }
-
-
-
- -

-
-
- - diff --git a/lam-web/developers/devel/mod_index.htm b/lam-web/developers/devel/mod_index.htm deleted file mode 100644 index 51fa04af..00000000 --- a/lam-web/developers/devel/mod_index.htm +++ /dev/null @@ -1,61 +0,0 @@ - - - - LAM module HowTo - - - - -
-

Module HowTo

-
-
-
-

Basic functions

-
-
-
LAM can be easily extended to support -additional LDAP object classes and attributes.
-This document provides a step-by-step description to build an account -module. The ieee802Device -module which provides MAC addresses for hosts is used as example.
-
-

1. Basic concepts
-

-
-

2. General module options

-
-

3. Account pages

-
-

4. Help entries
-

-
-

5. PDF output
-

-
-

6. File upload

-
-
-
-

-
-

Advanced functions

-This part covers additional functionality of the modules which are only -needed by a minority of modules. The examples are taken from different -existing modules.
-
-

1. Account profiles

-
-

2. Configuration options

-
-

3. Advanced upload options

-
-

4. Defining the RDN

-
-

5. Defining required PHP extensions

-
-
-
-
- - diff --git a/lam-web/developers/devel/mod_pdf.htm b/lam-web/developers/devel/mod_pdf.htm deleted file mode 100644 index fb3dfae5..00000000 --- a/lam-web/developers/devel/mod_pdf.htm +++ /dev/null @@ -1,107 +0,0 @@ - - - - Module HowTo - PDF output - - - - -
-

Module HowTo - PDF output
-

-
-
-

-

1. Defining possible PDF values
-

-The first step to PDF output is defining what values your module -provides. This is needed for the PDF editor, otherwise the user will -not be able to select values from your module.
-
-The PDF values are specified with get_pdfFields() -or meta['PDF_fields'].
-
-Example:
-
-The ieee802Device -module has only one attribute and therefore one PDF value: the MAC -address.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-[...]
-        // available PDF fields
-     -    $return['PDF_fields'] = array(
-     -        'macAddress'
-     -    );
-        return $return;
-    }
-
-
-
-
-

2. Providing data to put into the PDF file
-

-When the user wants to create a PDF file the LDAP account is loaded and -you module is asked for data to put into the PDF file.
-
-This is done with get_pdfEntries().
-
-Example:
-
-The ieee802Device -module will return the MAC address list of the account.
-
- - - - - - -
    /**
-    * Returns a list of PDF entries
-    */
-    function get_pdfEntries() {
-        $return = array();
-        if -(sizeof($this->attributes['macAddress']) > 0) {
-            -$return['ieee802Device_macAddress'] = '<block><key>' . -_('MAC address list') . '</key><value>' . implode(', ', -$this->attributes['macAddress']) . '</value></block>';
-        }
-        return $return;
-    }
-
-
-
-
-
- -

-
-
- - diff --git a/lam-web/developers/devel/mod_profiles.htm b/lam-web/developers/devel/mod_profiles.htm deleted file mode 100644 index 1034b1a3..00000000 --- a/lam-web/developers/devel/mod_profiles.htm +++ /dev/null @@ -1,190 +0,0 @@ - -Module HowTo - Account profiles - - - - - -
-

Module HowTo - Account profiles
-

-

-Account profiles make it easy to set default values for new accounts -and even to reset an existing account to default values.
-Your module should provide the possibility to define default values for -all attributes which do not differ for each account.
-
-

-

1. Defining possible profile options
-

-The first step to account profiles is defining the attributes for which -the user can set default values. You will also have to define the type -(text, checkbox, ...) of the profile options.
-The profile editor then will display a fieldset for each module -containing its profile options.
-
-The profile options are specified with get_profileOptions() -or meta['profile_options'].
-
-Example:
-
-The inetOrgPerson -module has only two attributes which may be set to a default value: job -title and employee type.
-The other attributes are account specific and not useful as profile -options.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // profile elements
-        $return['profile_options'] = array(
-            array(
-            -    array('kind' => 'text', 'text' => -_('Job title') . ":"),
-            -    array('kind' => 'input', 'name' => -'inetOrgPerson_title', 'type' => 'text', 'size' => '30', -'maxlength' => '255'),
-            -    array('kind' => 'help', 'value' => -'title')),
-            array(
-            -    array('kind' => 'text', 'text' => -_('Employee type') . ":"),
-            -    array('kind' => 'input', 'name' => -'inetOrgPerson_employeeType', 'type' => 'text', 'size' => '30', -'maxlength' => '255'),
-            -    array('kind' => 'help', 'value' => -'employeeType'))
-        );
-        [...]
-
-
-This defines two text boxes in the profile editor, one for the job -title and one for the employee type.
-Your profile options should also provide a help link if the description -of the input element might be not enough.
-
-
-

2. Checking user input

-Probably you also want to check if the input data is syntactically -correct.
-The baseModule already -provides different checks which can be activated with meta data. However you can also do -the checking in the module.
-Implementing the function check_profileOptions() -in your module will allow you to do the checks yourself. Basic checks -can be defined with meta['profile_checks'].
-
-Example:
-
-The inetOrgPerson module only -needs some regular expression checks on the input. This can be done by -the baseModule.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // profile checks
-        $return['profile_checks']['inetOrgPerson_title'] = array(
-            'type' => -'ext_preg',
-            'regex' => -'title',
-           - 'error_message' => $this->messages['title'][0]);
-        $return['profile_checks']['inetOrgPerson_employeeType'] = -array(
-            'type' => -'ext_preg',
-            'regex' => -'employeeType',
-           - 'error_message' => $this->messages['employeeType'][0]);
-        [...]
-
-
-The type "ext_preg" means that -the baseModule will use the get_preg() function in lib/account.inc for the syntax -check. This function already contains regular expressions for the most -common cases.
-
-
-

3. Loading an account profile

-When an account profile is loaded the modules have to check what values -they need for their internal data structures.
-The baseModule already -provides the possibility to store profile values directly as LDAP -attributes in $this->attributes. -This is done by defining profile-attribute mappings in meta['profile_mappings'].
-If you have other values than LDAP attributes or need some post -processing you can implement the function load_profile() in your module.
-
-Example:
-
-The inetLocalMailRecipient -module only -needs a static mapping. This can be done by -the baseModule.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // profile mappings
-        $return['profile_mappings'] = array(
-           - 'inetLocalMailRecipient_host' => 'mailHost'
-        );
-        [...]
-
-
-In this example the profile option "inetLocalMailRecipient_host" is -stored as LDAP attribute "mailHost".
-
-
- -

-
-
- \ No newline at end of file diff --git a/lam-web/developers/devel/mod_rdn.htm b/lam-web/developers/devel/mod_rdn.htm deleted file mode 100644 index 35861732..00000000 --- a/lam-web/developers/devel/mod_rdn.htm +++ /dev/null @@ -1,60 +0,0 @@ - - - - Module HowTo - Defining the RDN - - - - -
-

Module HowTo - Defining the RDN
-

-

-Every LDAP DN starts with a RDN (relative DN). This is the value of a -LDAP attribute. Users usually use "uid", groups use "cn".
-You can provide a list of suitable RDN attributes for your module and -give them a priority, too.
-
-
-
You will need to implement the function get_RDNAttributes() or use meta['RDN'].
-
-Example:
-
-The posixAccount module -offers to create accounts with DNs uid=foo,dc=.... and cn=foo,dc=...
-The uid attribute has a higher priority as it is the usual attribute -for Unix accounts.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // RDN attributes
-        $return["RDN"] = array("uid" -=> "normal", "cn" => "low");
-        [...]
-
-
-
-
- -

-
-
- - diff --git a/lam-web/developers/devel/mod_upload.htm b/lam-web/developers/devel/mod_upload.htm deleted file mode 100644 index 4c03252f..00000000 --- a/lam-web/developers/devel/mod_upload.htm +++ /dev/null @@ -1,172 +0,0 @@ - - - - Module HowTo - File upload - - - - -
-

Module HowTo - File upload
-

-
-
-

-

1. Defining upload columns
-

-If you want to support account creation via file upload you have to -define columns in the CSV file.
-Each column has an non-translated identifier, a description, help entry -and several other values.
-
-The upload columns are specified with get_uploadColumns() -or meta['upload_columns'].
-
-Example:
-
-The ieee802Device -module has only one attribute and therefore one column: the MAC address.
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // manages host accounts
-    -    $return["account_types"] = array("host");
-        // upload fields
-     -    $return['upload_columns'] = array(
-     -        array(
-     -            'name' => -'ieee802Device_mac',
-     -            'description' -=> _('MAC address'),
-     -            'help' => -'mac',
-     -            'example' -=> '00:01:02:DE:EF:18'
-     -        )
-      -   );
-        return $return;
-    }
-
-
-
-

2. Building the accounts
-

-When the user has uploaded the CSV file the modules have to transform -the input data to LDAP accounts.
-
-This is done with build_uploadAccounts(). -The function gets the input data and a list of LDAP accounts as -parameter.
-
-Example:
-
-The ieee802Device -module has only one LDAP attribute - 'macAddress' -- and the 'ieee802Device' -objectClass which is added to all accounts.
-
- - - - - - -
    /**
-    * In this function the LDAP account is built up.
-    *
-    * @param array $rawAccounts list of hash arrays -(name => value) from user input
-    * @param array $partialAccounts list of hash arrays -(name => value) which are later added to LDAP
-    * @param array $ids list of IDs for column position -(e.g. "posixAccount_uid" => 5)
-    * @return array list of error messages if any
-    */
-    function build_uploadAccounts($rawAccounts, -$ids, &$partialAccounts) {
-        $messages = array();
-        for ($i = 0; $i < -sizeof($rawAccounts); $i++) {
-            // add object -class
-            if -(!in_array("ieee802Device", $partialAccounts[$i]['objectClass'])) -$partialAccounts[$i]['objectClass'][] = "ieee802Device";
-            // add MACs
-            if -($rawAccounts[$i][$ids['ieee802Device_mac']] != "") {
-            -    $macs = explode(',', -$rawAccounts[$i][$ids['ieee802Device_mac']]);
-            -    // check format
-            -    for ($m = 0; $m < sizeof($macs); $m++) {
-            -        if (get_preg($macs[$m], -'macAddress')) {
-            -            -$partialAccounts[$i]['macAddress'][] = $macs[$m];
-            -        }
-            -        else {
-            -            $errMsg = -$this->messages['mac'][1];
-            -            -array_push($errMsg, array($i));
-            -            $messages[] = -$errMsg;
-            -        }
-            -    }
-            }
-        }
-        return $messages;
-    }
-
-
-
-
-
- -

-
-
- - diff --git a/lam-web/developers/devel/mod_upload2.htm b/lam-web/developers/devel/mod_upload2.htm deleted file mode 100644 index ab706437..00000000 --- a/lam-web/developers/devel/mod_upload2.htm +++ /dev/null @@ -1,123 +0,0 @@ - - - - Module HowTo - Advanced upload options - - - - -
-

Module HowTo - Advanced upload options
-

-

-The ieee802Device module only -needs the basic upload functions for its functionality.
-However there are more possibilities for the modules to control the -file upload.
-
-

-

1. Module order
-

-Your module might depend on the input values of another module. In this -case you probably want that your module is called as the second one.
-
-You can define dependencies to other modules with the function get_uploadPreDepends() or meta['upload_preDepends'].
-
-Example:
-
-The sambaGroupMapping module -needs the group name to set the default displayName. Therefore it depends -on the posixGroup module
-
- - - - - - -
    /**
-    * Returns meta data that is interpreted by parent -class
-    *
-    * @return array array with meta data
-    */
-    function -get_metaData() {
-        $return = array();
-        // upload dependencies
-        $return['upload_preDepends'] = -array('posixGroup');
-        [...]
-
-
-
-

2. Upload post actions
-

-If your module does not only create an account but relates the account -with other existing LDAP entries you can do these modifications after -the account was created.
-This is useful for adding users to groups or setting quotas.
-
-You have to implement the function doUploadPostActions() -in your module. Since post actions are very special there is no meta data for this.
-
-Example:
-
-The posixAccount module -offers to put the user account in additional groups. This is done in -the post actions.
-
- - - - - - -
    /**
-    * This function executes one post upload action.
-    *
-    * @param array $data array containing one account in -each element
-    * @param array $ids array(<column_name> => -<column number>)
-    * @param array $failed list of accounts which were -not created successfully
-    * @param array $temp variable to store temporary -data between two post actions
-    * @return array current status
-    * <br> array (
-    * <br>  'status' => 'finished' | -'inProgress'
-    * <br>  'progress' => 0..100
-    * <br>  'errors' => array (<array -of parameters for StatusMessage>)
-    * <br> )
-    */
-    function doUploadPostActions($data, $ids, -$failed, &$temp) {
-         [...]
-    }
-
-
-Please make sure that the actions in one call of doUploadPostActions() are not very -time consuming (only one LDAP operation). Your function will be called -repeatedly until you give back the status "finished".
-This allows LAM to avoid running longer than the maximum execution time -by sending meta refreshes to the browser.
- -

-
-
- - diff --git a/lam-web/developers/devel/modules-specification.htm b/lam-web/developers/devel/modules-specification.htm deleted file mode 100644 index a618232b..00000000 --- a/lam-web/developers/devel/modules-specification.htm +++ /dev/null @@ -1,1494 +0,0 @@ - - - Module specification - - - - - -

This document describes the module -interface for LDAP Account Manager

-
-
-

1. Location and naming of modules

-All LAM modules are placed in lib/modules/ and are named "<class -name>.inc".
-E.g. if you create a new module and its class name is "qmail" then the -filename would be "qmail.inc".
-
-The class name of a module must contain only a-z, A-Z, 0-9, -, and _.
-All module classes should extend the baseModule class.
-
-

2. Class functions

-

2.1. Functions that have to work without superior accountContainer
-

-


-

-

2.1.1. can_manage*

-
- - - - - - -
function can_manage()
-
-
-Returns true if this module -can manage accounts of the current type, -otherwise false.
-
-
-

2.1.2. get_alias*

-
- - - - - - -
function get_alias()
-
-
-This function returns a more descriptive string than the class name. -Alias names are used for the buttons of the account pages and the -module selection of the configuration wizard.
-Please take care that your alias name is not too long. It may contain -any character but should not include parts that may be interpreted by -the browser (e.g. '<' or '>').
-If you use different aliases dependent on the account type please make -sure that there is a general alias for unknown types.
-
-

2.1.3. is_base_module*

-
- - - - - - -
function is_base_module()
-
-
-Returns true if your module is -a base module and otherwise false.
-
-Every account type needs exactly one base module. A base module manages -a structural object class.
-E.g. the inetOrgPerson module is a base module since its object class -is structural.
-
-

2.1.4. get_ldap_filter*

-
- - - - - - -
function get_ldap_filter()
-
-
-Returns an array('or' => '...', 'and' => '...') that is used to -build the LDAP filter. Usually -used to filter object classes.
-
-All "or" filter parts of the base modules are combined with OR and then -combined with the "and" parts.
-The resulting LDAP filter will look like this: -(&(|(OR1)(OR2)(OR3))(AND1)(AND2)(AND3))
-
-Example: return "('or' => -'(objectClass=posixAccount)', 'and' => '(!(uid=*$))')"
-
-

2.1.5. getManagedObjectClasses*

-
- - - - - - -
function getManagedObjectClasses()
-
-
-Returns an array of object class names which are managed by this module.
-
-This is used to fix spelling errors in LDAP-Entries (e.g. if -"posixACCOUNT" is read instead of "posixAccount" from LDAP).
-
-Example: return "('posixAccount')"
-
-

2.1.6. getLDAPAliases*

-
- - - - - - -
function getLDAPAliases()
-
-
-This function returns a list of LDAP attribute alias names.
-
-return array(<alias name> => -<attribute name>)
-
-

2.1.7. get_RDNAttributes*

-
- - - - - - -
function get_RDNAttributes()
-
-
-Returns a hash array containing a list of possible LDAP attributes that -can be used to form the RDN (Relative Distinguished Name).
-
-The keys of the array are the LDAP attributes, the values are the -priority ("low"/"normal"/"high").
-Attributes with higher priority are placed higher in the drop down box -for the RDN selection.
-
-Example: return "('uid' => -'normal', 'cn' => 'low')"
-
- -

2.1.8. get_dependencies*

-
- - - - - - -
function -get_dependencies()
-
-
-This function returns a list of modules it depends on.
-
-The return value is an array with two sub arrays, "depends" and "conficts".
-All values of the conflict array are string values with module names.
-All values of the depends array are either string values with module -names or arrays which include only string values with module names. If -an element of the depends array is itself an array, this means that -your module depends on one of these modules.
-
-Example: return array("depends" -=> array("posixAccount", array("qmail", "sendmail")), "conflicts" -=> array("exim"));
-
-

2.1.9. get_metaData()

-
- - - - - - -
function get_metaData()
-
-
-Returns an hash array including meta data for the baseModule.
-
-Example: return array("is_base" => -true);
-
-

2.1.10. get_configOptions()*

-
- - - - - - -
function get_configOptions($scopes, -$allScopes)
-
-
-Returns a list of configuration options.
-$scopes is a list of account types (user, group, host) -which are used.
-$allScopes is a list of all -active account modules and their scopes (module => array(scopes))
-
-The return value is an array -that contains meta HTML code.
-
-The type "fieldset" is not allowed here.
-The name attributes are used -as keywords to load and save settings. We recommend to use the module -name as prefix for them (e.g. posixAccount_homeDirectory) to avoid -naming confilcts.
-

2.1.11. check_configOptions*

-
- - - - - - -
function check_configOptions($scopes, -$options)
-
-
-This function checks the input for module configuration settings.
-
-$scopes is a list of used -account types (user, group, host).
-$options -is an hash array -(option name => value) that contains the input. The option values -are all arrays containing one or more elements.
-If the input data is invalid the return value is an array that contains -arrays to build StatusMessages (0 => message type, 1 => message -head, 2 => message text, 3 => additional variables).
-If no errors occured the function returns an empty array.
-
- -

2.1.12. get_scope()

-
- - - - - - -
function get_scope()
-
-
-Returns the account type (user/group/host) of this module object.
-
-This function is provided by the -baseModule and should not be overwritten.
-
-

2.1.13. get_uploadColumns*

-
- - - - - - -
function get_uploadColumns()
-
-
-Returns a list of column entries for the upload .csv-file.
-Each column entry is an array containing these values:
-
    -
  • string -name: fixed non-translated name which is used as column name -(should be of format: <module name>_<column name>)
  • -
  • string -description: short descriptive name
  • -
  • string -help: help ID
  • -
  • string -example: example value
  • -
  • string -values: possible input values (optional)
  • -
  • string default: default value (optional)
    -
  • -
  • boolean -required: true, if user must set a value for this column (optional, default: -"false")
    -
  • -
  • boolean -unique: true if -all values of this column must be different values (optional, default: -"false")
    -
  • -
-
-

2.1.14. get_uploadPreDepends*

-
- - - - - - -
function get_uploadPreDepends()
-
-
-Returns a list of module names which must be processed before this -module at builing accounts.
-The named modules may not be active, LAM will check this automatically.
-
-

2.1.15. build_uploadAccounts

-
- - - - - - -
function get_uploadAccounts($rawAccounts, -$ids, $partialAccounts)
-
-
-This function takes the user input and generates the LDAP accounts.
-
-array -$rawAccounts: The user input data, contains one sub array for -each account.
-array -$ids: Maps the column names to keys for the sub arrays.
-array -$partialAccounts: Containing one sub array for each account, -format is the same as used for ldap_add().
-
-Returns an array which contains sub arrays to generate StatusMessages -if any errors occured.
-
-

2.1.16. do_uploadPostActions

-
- - - - - - -
function do_uploadPostActions($data, $ids, -$failed, &$temp)
-
-
-This function is responsible to do additional tasks after the account -has been created in LDAP.
-E.g. modifying group memberships, adding Quota etc..
-
-This function is called as long as the returned status is 'finished'. Please make sure that -one function call lasts no longer than 3-4 seconds. Otherwise the -upload may fail because the time limit is exceeded. You should not make -more than one LDAP operation in each call.
-
-array -$data: The user input data, contains one sub array for each -account.
-array -$ids: Maps the column names to keys for the sub arrays.
-array -$failed: List of account numbers which could not be successfully -uploaded to LDAP.
-array -&$temp: Pointer to temporary variable which can be used to -save information between two function calls.
-
-return array (
-    'status' => -'finished' | 'inProgress'   // Defines if all -operations are complete
-    'progress' => -0..100   // The progress of the operations in percent
-    'errors' => -array()   // List of arrays which are used to generate -StatusMessages
-    )
-
-

2.1.17. get_profileOptions*

-
- - - - - - -
function get_profileOptions()
-
-
-This function defines what attributes will be used in the account -profiles and their appearance in the profile editor.
-
-The return value is an array -that contains meta HTML code.
-
-The type "fieldset" is not allowed here.
-The name attributes are used -as keywords to load and save profiles. We recommend to use the module -name as prefix for them (e.g. posixAccount_homeDirectory) to avoid -naming confilcts.
-
-

2.1.18. check_profileOptions*

-
- - - - - - -
function check_profileOptions($options)
-
-
-This function checks the input for a new or modified account profile.
-
-$options -is an hash array -(option name => value) that contains the input. The option values -are all arrays containing one or more elements.
-If the input data is invalid the return value is an array that contains -arrays to build StatusMessages (0 => message type, 1 => message -head, 2 => message text, 3 => additional variables).
-If no errors occured the function returns an empty array.
-
-

2.1.19. load_profile*

-
- - - - - - -
function load_profile($profile)
-
-
-This function loads the values from an account profile to the module's -internal data structures.
-
-$profile -is an hash array (identifier => array(values))  with all values -of an account profile.
-
-

2.1.20. getRequiredExtensions*

-
- - - - - - -
function getRequiredExtensions()
-
-
-This function returns a list of PHP extensions (e.g. mhash) which are -needed by this module.
-
- -

2.1.21. getSelfServiceSearchAttributes*

- -
- - - - - - - - -
function getSelfServiceSearchAttributes()
-
- -
- -This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.
-
- -

2.1.22. getSelfServiceFields*

- -
- - - - - - - - -
function getSelfServiceFields()
-
- -
- -This function returns a list of possible self service fields and their descriptions.
-
-return array ('myField' => 'Field description');
-
- -

2.1.23. getSelfServiceOptions

- -
- - - - - - - - -
function getSelfServiceOptions($fields, $attributes)
-
- -
-Builds and returns the meta HTML code for each self service field.
-
-$fields: list of self service field names
-$attributes: LDAP attributes of the current account (all lower case)
-
- -

2.1.24. checkSelfServiceOptions

- -
- - - - - - - - -
function checkSelfServiceOptions($fields, $attributes)
-
- -
-Returns a list of LDAP operations and error messages.
-
-$fields:
list of self service field names
- -$attributes: LDAP attributes of the current account (all lower case)
-
-return array(
-    'messages' => array(array('ERROR', 'Error topic', 'Error message')),
-    'add' => array('mail' => array('test@test.com')),
-    'mod' => array(),
-    'del' => array(),
-);
-
- -
-

2.1.25. getSelfServiceSettings

- - -
- - - - - - - - - - -
function getSelfServiceSettings()
-
- - -
-Returns a list of self service configuration settings.
-
- - -The return value is an array -that contains meta HTML code.
- -
- -The type "fieldset" is not allowed here.
- -The name attributes are used -as keywords to load and save settings. We recommend to use the module -name as prefix for them (e.g. posixAccount_homeDirectory) to avoid -naming confilcts.
- -
- - -

2.1.26. checkSelfServiceSettings

- - -
- - - - - - - - - - -
function checkSelfServiceSettings($options)
-
- - -
-Checks if the self service settings are valid.
- -
- -$options: is an hash array -(option name => value) that contains the input. The option values -are all arrays containing one or more elements.
-
-If the input data is invalid the return value is an array that contains -arrays to build StatusMessages (0 => message type, 1 => message -head, 2 => message text, 3 => additional variables).
- -If no errors occured the function returns an empty array.
- -
- - -
-
-
-

2.2. Functions which are called inside of an account container
-

-

2.2.1. init

-
- - - - - - -
function init($base)
-
-
-Every module needs a initializing function that has an account -container as argument $base.
-With this account container you can interact with other modules and use -several helper functions.
-
-

2.2.2. module_ready

-
- - - - - - -
function module_ready()
-
-
-Your module might depend on input of other modules. This function -determines if the user can change to your module page or not.
-The return value is true if -your module accepts input, otherwise false.
-
-This function is implemented by the baseModule -which returns true as default.
-
-

2.2.3. module_complete

-
- - - - - - -
function module_complete()
-
-
-This function tells LAM if it can create/modify the LDAP account. If -your module needs any additional input then set this to false. The user will be notified -that your module needs more input.
-
-This function is implemented by the baseModule -which returns true as default.
-
-

2.2.4. getButtonStatus
-

-
- - - - - - -
function getButtonStatus()
-
-
-This function tells LAM if the module button on the account page is -visible and active.
-The function may return these values:
-
    -
  • enabled: button is -visible and active
  • -
  • disabled: button is -visible and deactivated (greyed)
  • -
  • hidden: no button will be -shown
    -
  • -
-
-

2.2.4. get_help

-
- - - - - - -
function get_help($helpID)
-
-
-This function is called when a page requests a help topic from this -module.
-$helpID is the help identifier; -it must only contain a-z, A-Z, 0-9 --, . and _.
-It must return the help entry as array for the submitted help -identifier. The format of the array to be returned is described in -section 4. "Help entry syntax".
-
-

2.2.7. get_pdfEntries

-
- - - - - - -
function get_PDF_Entries()
-
-
-This function is called when a PDF is to be created.
-It returns the fields which are printed in the PDF file for the -specified account type. At the monent there is no (easy) possibility -for the user to decide which fields are to be displayed. Perhaps there -will be a PDF config tool in future releases where you can offer the -user to decide which fields are to be displayed on the PDF file. The -format of the array to be returned is described in section 5. "PDF -syntax".
-
-

2.2.8. dynamic_Message
-

-
- - - - - - -
function dynamic_Message($attribute, $id)
-
-
-This function is only needed when a status message contains strings -with variables.
-$attribute is the attribute the -message is corresponding to.
-$id selects the exact message.
-
-Returnis an array as expected from StatusMessage().
-
-

2.2.9. load_Messages
-

-
- - - - - - -
function load_Messages()
-
-
-This function is fills the array $this->messages. First Index (x) is -the attribute the message is corresponding to.
-Second Index (y) selects the exact message. Third Index (z) contains an -array as expected from StatusMessage().
-$this->messages[x][y][z]
-
-

2.2.10. load_attributes
-

-
- - - - - - -
function load_attributes($attr)
-
-
-This function loads attributes when an account should be loaded.
-$attr is an array like the -array returned by get_ldap_attributes(dn of account) but without count -indicees.
-If all attributes are very simple are part of the dn of account it's -possible to just call $this->load_ldap_attributes($attr)
-which is part of baseModule.
-The function load_ldap_attributes loads all attributes which fit to the -objectClass of the module.
-This function has t be expanded when attributes have to be loaded from -a different DN or handled completly
-separat.
-
-

2.2.11. save_attributes
-

-
- - - - - - -
function save_attributes()
-
-
-This function returns an array with changes which should be saved.
-The return array has the following syntax: First index is the ldap dn -which should be changed. Second
-index is the kind of modification. Possible values are: 'add', -'modify', 'notchanged', 'remove'.
-Third index is the attribute which should be changes. Fourth index is -an array with all values of
-an attribute.
-If you want to call lamdaemon -first index is 'lamdaemon'. Second index is 'command'. Third index is -the command
-itself which should be executed by lamdaemon.
-
-This function is implemented by the baseModule -which builds the required comands from $this-attributes -and $this->orig.
-
-

2.2.12. delete_attributes
-

-
- - - - - - -
function delete_attributes($post)
-
-
-This function returns an array with the same syntax as -save_attributes(). It additional LDAP changes when an account is -deleted.
-$post is the $_POST array.
-
-
-

2.2.13. process_attributes
-

-
- - - - - - -
function process_attributes($post)
-
-
-This function processes user input. It checks user input. It also -saves changes in attributes.
-It may -return an array which contains status messages. Each entry is an array -containing the status message parameters.
-$post is the $_POST -array.
-
-Example:
-
-return array(0 => array('ERROR', 'Invalid input!', 'This is not -allowed here.'));
-
-
-

2.2.14. process_*
-

-
- - - - - - -
function process_*($post)
-
-
-This function has the exact behavoir like process_attributes function. -* is the name of the subpage which
-should be processed.
-$post is the $_POST array. It -is needed to interact with the user.
-
-
-

2.2.15. display_html_attributes($post)
-

-
- - - - - - -
function display_html_attributes($post)
-
-
-This function creates meta HTML code. The code is the page the module -wants to display.
-Return is an array of meta HTML code.
-$post is the $_POST array. It -is needed t interact with the user.
-
-
-

2.2.16. display_html_*($post)
-

-
- - - - - - -
function display_html_*($post)
-
-
-This function has the exact behavoir like display_html_attributes(). * -is the name of the subpage which
-should be displayed.
-$post is the $_POST array. It -is needed t interact with the user.
-
-
-
-

2.2.17. display_html_delete($post)
-

-
- - - - - - -
function display_html_delete($post)
-
-
-This function creates meta HTML code. The code will be displayed when -an account should be deleted.
-This is needed to interact, e.g. should the home directory be deleted?
-The output of all modules is displayed on a single page.
-Return is an array of meta HTML code.
-$post is the $_POST array. It -is needed t interact with the user.
-
-
-
-*: These functions do not need to be -implemented if meta data is supplied. See 6 for a list of meta data -formats.
-


-

-

3. Meta HTML code

-The modules are not allowed to display HTML code directly but return -meta HTML code. This allows to have a common design for all module -pages.
-Meta HTML code is always returned as a three dimensional array[a][b][c] where a is the row number, b is the coumn number and c is is a data elememt.
-
-Format for data elements:
-
-A data element is an array -which contains the data to display.
-All data elements must -contail a value "kind" which -defines what kind of element should be displayed.
-
-These are the possibilies for kind -and what other options are implicated:
-
-
    -
  • fieldset: Inserts a -fieldset.
  • -
      -
    • legend: The legend of -the fieldset.
    • -
    • value: A data element. Can be used -recursively.
    • -
    -
  • help: Adds a help link.
  • -
      -
    • value: The help number -for the help entry.
    • -
    • scope: The account type -for the help entry.
      -
    • -
    -
  • input: Adds a HTML input -element.
  • -
      -
    • name: The name of the -element, will be used later as variable name when user input is -returned.
    • -
    • type: allowed values: -submit, reset, checkbox, text, password, file, hidden
    • -
    • checked: Boolean value, -if true a checkbox will be checked. This value is only needed or -checkboxes.
    • -
    • disabled: Boolean -value, if true the element will be disabled.
    • -
    • size: The length of the -input element, only used for text, password and file.
    • -
    • maxlength: The maximum -size of the input element, only used for text, password and file.
    • -
    • value: The element will -have this value as default. Button elements will have this as caption.
    • -
    -
  • select: This will add a -select field.
  • -
      -
    • name: The name of the -element, will be used later as variable name when user input is -returned.
    • -
    • multiple: Boolean -value, if set to true the user can select more than one entry.
    • -
    • options: Array of -string. This is the list of option values the user can select.
    • -
    • options_selected: Array -of string. This is the list of pre selected elements, must contain -values that are also in options.
    • -
    • descriptiveOptions: -Boolean value, if set to true then all elements in options -must be arrays themselves (array(value, - description)) (default: -false)
      -
    • -
    • size: The size of the -select field, if set to 1 a dropdown box will be displayed.
    • -
    • noSorting: If set to -true then the entries will not be sorted. Default is false.
      -
    • -
    -
  • table: Adds a table. Can -be used recursively.
  • -
      -
    • value: A data element. Can be used -recursively.
    • -
    -
  • text: Inserts a text -element.
  • -
      -
    • text: The text to -display.
    • -
    -
  • textarea: Adds a -multiline text field.
  • -
      -
    • name: The name of the -element, will be used later as variable name when user input is -returned.
    • -
    • rows: Number of rows -(required)
      -
    • -
    • cols: Number of -characters for each line (required)
      -
    • -
    • readonly: Boolean -value, if true the text field will be read only.
      -
    • -
    -
  • image: Displays an image.
  • -
      -
    • path: Path to the image
    • -
    • width: Width of the -image
    • -
    • height: Height of the -image
    • -
    • alt: Alt text of the -image
      -
    • -
    -
-
-Beneath those values a "td" -value may be added. This has to be an array with one or more of these -options:
-
-
    -
  • colspan: Like the HTML -colspan attribute for td elements
  • -
  • rowspan: Like the HTML -rowspan attribute for td elements
  • -
  • align: -left/center/right/justify Like the HTML align attribute
  • -
  • valign: top/middle/bottom -Like the HTML valign attribute
  • -
  • width: Like the HTML -height attribute for td elements
    -
  • -
-
-Input buttons which should load a different subpage of a module must -have a special name attribute:
-
-name => 'form_subpage_' . <module name> . '_' . <subpage name> . '_' . <button name>
-
    -
  • <module name>: name -of this account module (e.g. 'posixAccount')
  • -
  • <subpage name>: -name of next subpage (e.g. 'attributes')
  • -
  • <button name>: a -name to distinguish buttons (e.g. 'ok'/'cancel'/'back')
    -
  • -
-
-
-Example:
-
-
array(
-  0 => array(
-    0 => array("kind" => "text", "text" => -"This is an -example", "td" => array("colspan" => 3))
-  ),
-  1 => array(
-    0 => array("kind" => "text", "text" => -"Input:"),
-    1 => array("kind" => "input", "name" => -"myinput", -"type" => "text"),
-    2 => array("kind" => "help", "value" => "42")
-  ),
-
  2 => array(
-    0 => array("kind" => "input", "name" => -'form_subpage_myModule_attributes_back', "value" => _("Back"))
-  )
-
)
-

-
-


-

-

4. Help entry syntax

-The array that is returned by the get_help function must follow the -below described syntax. Fields marked REQUIRED are neccessary -under any circumstances. Fields marked OPTIONAL may be left out -when not needed.
-There are basically two different types of help entries that can be -used. Internal help entries, that means the headline, text, etc is -included in the help entry or external help entries, that means the -help entry has only a reference pointing to a HTML/PHP page that offers -the help entry. -
-


-4.1. Internal help entries

-ext (REQUIRED)
-Must be FALSE in this case. -
-
-Headline (REQUIRED)
-The headline of this help entry. Can consist of any alpha-numeric -characters. No HTML/CSS elements are not allowed here. -
-
-Text (REQUIRED)
-The text of this help entry. Can constist if any alpha-numeric -characters and can contain placeholder for variables passed to this -help entry. The placeholder must follow the syntax for placeholder -defined by the PHP printf function. HTML/CSS elements are -allowed here as long as they follow the XHTML1.0 Strict specification.
-
-When placeholders are included you can submit the values that should be -displayed there as arguments when calling the templates/help.php -file. There they are attached as var1, var2 and so on. -The names must follow the following rules:
-
    -
  • 1. They must be named var$i where $i is any positive -number except the '0'.
  • -
  • 2. This number ($i) must either be '1' or $i -1 must be present.
  • -
-
-SeeAlso (OPTIONAL)
-An array of references to anonther related subjects. Each row of the -array must contain a field called "text" with the text that should be -displayed and may contain a field called "link" which is used as value -for the href attribute of a HTML tag when set. -
-
-


-4.2. External help entries

-ext (REQUIRED)
-Must be TRUE in this case. -
-
-Link (REQUIRED)
-The complete filename of the file stored under the help/ directory -which should be displayed when this help entry is called. -

-
-


-

-

5. PDF syntax

-The get_pdfEntries() function uses XML formatted commands to define the -PDF output. Each part in the PDF document is surrounded by "<block>" -and "</block>".
-
-Inside the <block> tags there are different ways to format the -output:
-
    -
  • simple line with attribute name -and value: <block><key>attribute -name</key><value>attribute -value</value></block>
  • -
  • table: <block><key>attribute -name</key><tr><td>value<td><td>value<td></tr></block><block><tr><td>value</td><td>value<td></tr></block>
  • -
-
-Special commands:
-
    -
  • Alignment in <td>: -You can specify the alignment in <td> tags with align=(L|R|C) -(e.g. <td align=\"L\">)
  • -
  • Cell width: <td> -allows an attribute "width" to set the cell width (e.g. <td -width=20%> or <td width=30>).
    -
  • -
  • Line breaks: Line breaks -can be specified by adding a <br /> -tag. The new line will start at the left border of the PDF document.
  • -
-
-Examples:
-
-1. Simple name+value lines:
-
-In most cases you will just want to display a single line per attribute -with its name and value.
-
-    'myAttribute' -=> '<block><key>AttrName</key><value>12345</value></block>'
-
-This will give the following PDF output: AttrName: 12345
-
-
-2. Multiline values:

-
-Sometimes you have multivalued attributes where it is not applicable to -write all values in one line but where you want to list your values one -below the other or show a table.
-This can be done by using the <td> tag. This example only uses -one column but can just use more <td> tags per <block> tag -to display more columns.
-
-    'myAttribute' -=> '<block><key>AttrName</key><tr><td -align=\"L\">123</td></tr></block><block><tr><td -align=\"L\">456</td></tr></block><block><tr><td -align=\"L\">789</td></tr></block>'
-
-This will give the following PDF output:
-
- - - - - - - - - - - - - - - -
AttrName:
-
123
-

-
456
-

-
789
-
-
-
-
-
-

6. Module meta data

-

6.1 can_manage() -

-    "account_types" => array
-
-    Example: -array("user", "host")
-
-

6.2 is_base_module()

-    "is_base" => boolean
-
-

6.3 get_ldap_filter()

-    "ldap_filter" => array
-
-   Example: array('or' => -'objectClass=posixAccount', 'and' => '(!(uid=*$))')
-
-
-

6.4 getManagedObjectClasses()

-    "objectClasses" => array
-
-   Example: array('posixAccount')
-
-
-

6.5 getLDAPaliases()
-

-"LDAPaliases" => array()
-
-
Example: array('commonName' -=> 'cn')
-
-
-
- -

6.6 get_RDNAttributes()

-    "RDN" => array
-
-   Example: array('uid' => -'normal', 'cn' => 'low')
-
-
- -

6.7 get_dependencies()
-

-    "dependencies" => array
-
-   Example: array("depends" -=> array("posixAccount", array("qmail", "sendmail")), "conflicts" -=> array("exim"))
-

-

6.8 get_profileOptions()
-

-    "profile_options" => array
-
-   Syntax for array is the same as for the -return value of get_profileOptions().
-
-
-

6.9 check_profileOptions()
-

-    "profile_checks" => array
-
-   The keys of the array are -the names of the option identifiers.
-   Each array element is an array containing these values:
-
-
-
    -
  • type: -determines how to check input
  • -
      -
    • regex: check with regular expression from regex variable, case sensitive
    • -
    • regex_i: check with regular expression from regex variable, case insensitive
    • -
    • int_greater: integer value of cmp_name1 must be -greater than the integer value from the option cmp_name2
    • -
    • int_greaterOrEqual: integer value of cmp_name1 -must be greater or equal than the integer value from the option cmp_name2
    • -
    -
  • error_message: message that is displayed if input value -was syntactically incorrect
  • -
      -
    • array -to build StatusMessages (0 => message type, 1 => message -head, 2 => message text, 3 => additional variables)
    • -
    -
  • regex: regular expression string (only if type is regex/regex_i)
  • -
  • cmp_name1: -name of first input -variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)
  • -
  • cmp_name2: name of second input -variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)
    -
  • -
  • required: true or false, if this input field must be -filled set to true (optional)
    -
  • -
  • required_message: message that is displayed if no input value was -given (only if required == true)
  • -
      -
    •  array to build StatusMessages (0 => message type, 1 -=> message -head, 2 => message text, 3 => additional variables)
    • -
    -
-
-

6.10 load_profile()
-

-    "profile_mappings" => array('profile_identifier1' -=> 'LDAP_attribute1', 'profile_identifier2' => 'LDAP_attribute2')
-
-    The mapped values are stored directly in -$this->attributes.
-
-
-

6.11 get_configOptions()
-

-    "config_options" => array('user' => array, -'host' => array, 'all' => array)
-
-    The values from 'all' -are always returned, the other values only if they are inside the $scopes array.
-
-   Syntax for sub arrays is the same as for -the -return value of get_configOptions().
-

6.12 check_configOptions()
-

-    "config_checks" => array('user' => array, -'host' => 'array', 'all' => array)
-
-    The values from 'all' are always used for checking, -the other values only if they are inside the $scopes array.
-
-
   Syntax for sub arrays is the same as for -check_profileOptions().
-
-
-

6.13 get_uploadColumns()

-"upload_columns" => array()
-
-Syntax for array is the same as for -the -return value of get_uploadColumns().
-

-

6.14 get_uploadPreDepends()

-"upload_preDepends" => array()
-
-Syntax for array is the same as for -the -return value of get_uploadPreDepends().
-

-

6.15 getRequiredExtensions()
-

-"extensions" => array()
-
-
Example: array('mhash')
-
- -

6.16 getSelfServiceSearchAttributes()
-

- -"selfServiceSearchAttributes" => array()
- -
-
Example: array('uid')
-
- -

6.17 getSelfServiceFields()
-

- -"selfServiceFieldSettings" => array()
- -
-
Example: array('pwd' => 'Password')
-
- - \ No newline at end of file diff --git a/lam-web/developers/devel/other_libs.htm b/lam-web/developers/devel/other_libs.htm deleted file mode 100644 index 1ff54e1a..00000000 --- a/lam-web/developers/devel/other_libs.htm +++ /dev/null @@ -1,51 +0,0 @@ - - - - - Other libraries - - - - -

Other libraries
-

-
-

Lamdaemon (lamdaemon.pl)
-

-
-

LDAP cache (cache.inc)

-
-

Account lists (lists.inc)

-This file provides basic functions used by the account lists. They -cover major parts of the HTML output.
-There is also one list of LDAP attribute descriptions per account type. -They allow to have translated descriptions of the most common -attributes.
-
-

Status messages (status.inc)

-Status.inc provides the function StatusMessage() -which can be used to display error, warning and information messages.
-The function uses preg_replace() to convert the special tags to HTML -tags. The message variables are included with printf().
-
-The parameters of StatusMessage() -are described in the developer FAQ.
-
-

Tree view and schema browser

-The files tree.inc and schema.inc contain functions which are needed by -the tree view and the schema browser.
-These functions were copied from phpLDAPadmin -(PLA).
-
-
    -
  • tree.inc: tree functions -(from functions.php and some other files in PLA)
  • -
  • schema.inc: for schema -browser (from schema_functions.php in PLA)
    -
  • -
- - diff --git a/lam-web/developers/devel/ou-edit.htm b/lam-web/developers/devel/ou-edit.htm deleted file mode 100644 index 62542e07..00000000 --- a/lam-web/developers/devel/ou-edit.htm +++ /dev/null @@ -1,32 +0,0 @@ - - - - - OU editor - - - - -

OU editor
-

-
-
-This is a simple tool for creating and deleting organizational units -(OU) inside the LDAP tree.
-OUs can be managed for the LDAP suffixes of all account types.
-
-

1. Creating OUs
-

-The user -provides the name of the new OU which can include a-z, 0-9, "_", "-" -and " ".
-LAM will then create a new OU object under the selected LDAP suffix.
-
-

2. Deleting OUs

-If the user selects to delete an OU he will be asked if he is really -sure and then the OU is deleted.
-There is no recursive deletion.
-
- - diff --git a/lam-web/developers/devel/pdf_editor.htm b/lam-web/developers/devel/pdf_editor.htm deleted file mode 100644 index b4758e64..00000000 --- a/lam-web/developers/devel/pdf_editor.htm +++ /dev/null @@ -1,108 +0,0 @@ - - - - - PDF editor - - - - -

PDF editor
-

-

-
-
-

-
-
The PDF -editor allows the user to create templates for the PDF output.
-These templates are saved as files in config/pdf.
-
-

Pdfmain.php
-

-This is the start page of the PDF -editor. The user can select to add/modify/remove selected PDF -profiles.
-
-The list of existing PDF profiles is returned by getPDFStructureDefinitions() in pdfstruct.inc. It includes all -structure names without file extensions for a given account type.
-
-Depending on the selection of the user he is forwarded to pdfpage.php -or pdfdelete.php.
-
-

Pdfpage.php
-

-The user can edit the PDF structures on this page.
-
-The structure is loaded with loadPDFStructureDefinitions() -from pdfstruct.inc. If it -does not yet exist then the default structure is loaded.
-It is stored in $_SESSION['currentPDFStructure'] -(sections) and $_SESSION['currentPageDefinitions'] -(head line and logo).
-
-At the top of the page the head line and logo can be edited. The list -of available logos is retrieved with getAvailableLogos() -from pdfstruct.inc.
-
-The sections on the left side are displayed like they are defined in $_SESSION['currentPDFStructure']. -Each item has links to move or delete it. Section titles may be changed.
-
-The list of available PDF entries on the right side is retrieved from getAvailablePDFFields() in modules.inc.
-
-Near the bottom there the user can add a new section. The list of -available PDF entries is retrieved as above.
-
-When the user pushes one of the buttons or clicks on a link then there -are several actions:
-
    -
  • Abort button: The user is -redirected back to pdfmain.php.
    -
  • -
  • Save button: The -structure name is checked for correctness and the file is saved with savePDFStructureDefinitions() -from pdfstruct.inc.
  • -
  • Add section button: LAM -adds a static text or section to the structure.
  • -
  • Add entry button: Adds a -new entry to the selected section.
  • -
  • Change name button: -Changes the name of the section title or the section attribute.
  • -
  • Remove entry link: If the -entry is a section then all parts of this section are removed. -Otherwise a single entry is removed.
  • -
  • Move up/down links: The -entry or section is moved up or down.
  • -
-
-$_SESSION['currentPDFStructure'] -is an array that contains all XML tags of the PDF structure. If you -want to modify the structure always remember to put the opening and -closing tags at the right place.
-
-

Pdfdelete.php

-When the user selected to delete a structure in pdfmain.php he is redirected to -this page.
-
-LAM will ask once again if the user is sure to delete the structure. If -this is the case the structure will be deleted with deletePDFStructureDefinition() from pdfstruct.inc.
-
-
-
-
-
-
- - diff --git a/lam-web/developers/devel/pdf_libs.htm b/lam-web/developers/devel/pdf_libs.htm deleted file mode 100644 index 20135493..00000000 --- a/lam-web/developers/devel/pdf_libs.htm +++ /dev/null @@ -1,41 +0,0 @@ - - - - - PDF (pdf.inc, pdfstruct.inc) - - - - -

PDF (pdf.inc, pdfstruct.inc)
-

-
-These files control the management of PDF structures and creation of -PDF files.
-
-
-

pdfstruct.inc

-This file includes all functions which are needed to manage the PDF -structures. You can load/save/delete structures, get a list of -available structures and logos.
-
-
-

pdf.inc

-The pdf.inc library is used to create a PDF file.
-
-createModulePDF() takes a list -of accountContainer objects -and a PDF structure as parameters. The function then creates a PDF -file, saves it to the tmp -folder and returns the file name.
-
-
-The lamPDF class extends the UFPDF class and adds the LAM -specific header and footer.
-It also defines the used font. Currently only Bitstream-Vera is -supported.
-
- - diff --git a/lam-web/developers/devel/pdf_profiles.htm b/lam-web/developers/devel/pdf_profiles.htm deleted file mode 100644 index 8d9c4f9a..00000000 --- a/lam-web/developers/devel/pdf_profiles.htm +++ /dev/null @@ -1,100 +0,0 @@ - - - - - PDF templates - - - - -

PDF templates
-

-
-Every PDF structure is saved as a single file in config/pdf. The -file extension is the account type (user, group, ...) plus ".xml" (e.g. -default.user.xml).
-
-

Format

-The root tag is <pdf> -with the attributes filename for the -logo and headline -for the title.
-
-There are two types of subentries in <pdf>:
-
    -
  • sections
  • -
  • text
    -
  • -
-

Sections:

-Sections are parts of the PDF file where data from the account profiles -(e.g. LDAP attributes) is shown. Each section has a title and a list of -entries.
-
-The title is defined with the name attribute -inside the section tag. If the title begins with a "_" then LAM -interprets it as entry. This means that LAM will insert the value part -of this entry here.
-
-Each section has a list of subentries which are defined with the <entry> tag. The have only one -attribute which is name and -contains the identifier of this entry.
-
-

Text:

-LAM allows to display a fixed text in the PDF which is defined with the -<text> tag. The text is -just written inside the tags.
-
-
-
-Example:
-
-<pdf type="user" filename="printLogo.jpg" headline="LDAP Account -Manager">
-    <text>This document includes your personal -account settings.</text>
-    <section name="Personal User Infos">
-        <entry -name="inetOrgPerson_givenName" />
-        <entry name="inetOrgPerson_sn" -/>
-        <entry -name="inetOrgPerson_street" />
-        <entry -name="inetOrgPerson_postalCode" />
-        <entry -name="inetOrgPerson_postalAddress" />
-        <entry -name="inetOrgPerson_mail" />
-        <entry -name="inetOrgPerson_telephoneNumber" />
-        <entry -name="inetOrgPerson_mobileTelephoneNumber" />
-        <entry -name="inetOrgPerson_facsimileTelephoneNumber" />
-    </section>
-    <section name="Unix User Settings">
-        <entry name="posixAccount_uid" -/>
-        <entry -name="posixAccount_userPassword" />
-        <entry -name="posixAccount_primaryGroup" />
-        <entry -name="posixAccount_additionalGroups" />
-        <entry -name="posixAccount_homeDirectory" />
-        <entry -name="posixAccount_loginShell" />
-    </section>
-</pdf>
-
-
- - diff --git a/lam-web/developers/devel/phpdoc/Help/_help---help.inc.html b/lam-web/developers/devel/phpdoc/Help/_help---help.inc.html deleted file mode 100644 index b12a5184..00000000 --- a/lam-web/developers/devel/phpdoc/Help/_help---help.inc.html +++ /dev/null @@ -1,93 +0,0 @@ - - -Docs for page help.inc - - - - - - - - - - - - - -
Help
- - - [ class tree: Help ] - [ index: Help ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: help.inc

-Source Location: /help/help.inc

- -
-
- - -

Page Details:

-LDAP Account Manager help entries.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:31 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/Help/_templates---help.php.html b/lam-web/developers/devel/phpdoc/Help/_templates---help.php.html deleted file mode 100644 index b940be0a..00000000 --- a/lam-web/developers/devel/phpdoc/Help/_templates---help.php.html +++ /dev/null @@ -1,162 +0,0 @@ - - -Docs for page help.php - - - - - - - - - - - - - -
Help
- - - [ class tree: Help ] - [ index: Help ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: help.php

-Source Location: /templates/help.php

- -
-
- - -

Page Details:

-LDAP Account Manager help page.



-

Tags:

-
- - - - - - - -
author:  Michael Duergner
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../lib/ldap.inc") [line 36]
-LDAP connection

include_once("../lib/status.inc") [line 45]
-status messages

include_once("../lib/modules.inc") [line 110]
-include_once("../help/help.inc") [line 48]
-help data

include_once("../lib/config.inc") [line 39]
-configuration

-

-

-
-
- -

displayHelp [line 84]

-
-
-
- void displayHelp( -array $helpEntry, array $helpVariables) -
-

- - Print help site for a specific help number.



- -

Parameters

- - - - - - - - - - - -
array  $helpEntry  The help entry that is to be displayed.
array  $helpVariables  The help variables that are used to replace the spacer in the help text.
-
[ Top ]


-
-
- -

echoHTMLFoot [line 70]

-
-
-
- void echoHTMLFoot( -) -
-

- - Print HTML footer of the help page.



- -
[ Top ]


-
-
- -

echoHTMLHead [line 56]

-
-
-
- void echoHTMLHead( -) -
-

- - Print HTML header of the help page.



- -
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:31 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/LDAP/Ldap.html b/lam-web/developers/devel/phpdoc/LDAP/Ldap.html deleted file mode 100644 index 7676a135..00000000 --- a/lam-web/developers/devel/phpdoc/LDAP/Ldap.html +++ /dev/null @@ -1,535 +0,0 @@ - - -Docs For Class Ldap - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- -

Class: Ldap

-Source Location: /lib/ldap.inc

- - - - - - - - - -
- -

Class Overview

-

-
Ldap manages connection to LDAP and includes several helper functions.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 52]
-Ldap manages connection to LDAP and includes several helper functions.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 73]

-
-
-
- Ldap __construct( -object -$config) -
-

- -

- - -

Parameters:

-
- - - - - - -
object  $config  an object of class Config
-

-
[ Top ]
-
-
- -

method close [line 125]

-
-
-
- void close( -) -
-

- - Closes connection to server



- - -
[ Top ]
-
-
- -

method cmp_array [line 314]

-
-
-
- integer cmp_array( -string -$a, string -$b) -
-

- - Helper function to sort the unit DNs



-

Tags:

-
- - - - -
return:  0 if equal, 1 if $a is greater, -1 if $b is greater
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
string  $a  first argument to compare
string  $b  second argument to compare
-

-
[ Top ]
-
-
- -

method connect [line 89]

-
-
-
- mixed connect( -string -$user, string -$passwd) -
-

- - Connects to the server using the given username and password



-

Tags:

-
- - - - -
return:  if connect succeeds the server handle is returned, else false
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
string  $user  user name
string  $passwd  password
-

-
[ Top ]
-
-
- -

method decrypt [line 252]

-
-
-
- string decrypt( -object -$data) -
-

- - Decrypts a string



-

Tags:

-
- - - - -
return:  decrypted string
-
-

- - -

Parameters:

-
- - - - - - -
object  $data  string to decrypt
-

-
[ Top ]
-
-
- -

method decrypt_login [line 291]

-
-
-
- array decrypt_login( -) -
-

- - Decrypts username and password



-

Tags:

-
- - - - -
return:  array(user name, password)
-
-

- - -
[ Top ]
-
-
- -

method destroy [line 300]

-
-
-
- void destroy( -) -
-

- - Closes connection to LDAP server and deletes encrypted username/password



- - -
[ Top ]
-
-
- -

method encrypt [line 226]

-
-
-
- object encrypted encrypt( -string -$data) -
-

- - Encrypts a string



-

Tags:

-
- - - - -
return:  string
-
-

- - -

Parameters:

-
- - - - - - -
string  $data  string to encrypt
-

-
[ Top ]
-
-
- -

method encrypt_login [line 280]

-
-
-
- void encrypt_login( -string -$username, string -$password) -
-

- - Encrypts username and password



- - -

Parameters:

-
- - - - - - - - - - - -
string  $username  LDAP user name
string  $password  LDAP password
-

-
[ Top ]
-
-
- -

method new_rand [line 212]

-
-
-
- int new_rand( -) -
-

- - Calculates a new value for rand



-

Tags:

-
- - - - -
return:  New random value
-
-

- - -
[ Top ]
-
-
- -

method search_units [line 135]

-
-
-
- array search_units( -string -$suffix) -
-

- - Returns an array with all organizational units under the given suffix



-

Tags:

-
- - - - -
return:  DNs of organizational units
-
-

- - -

Parameters:

-
- - - - - - -
string  $suffix  search suffix
-

-
[ Top ]
-
-
- -

method server [line 166]

-
-
-
- object connection server( -) -
-

- - Returns the LDAP connection handle



-

Tags:

-
- - - - -
return:  handle
-
-

- - -
[ Top ]
-
-
- -

method __sleep [line 176]

-
-
-
- void __sleep( -) -
-

- - Closes connection to LDAP server before serialization



- - -
[ Top ]
-
-
- -

method __wakeup [line 183]

-
-
-
- void __wakeup( -) -
-

- - Reconnects to LDAP server when deserialized



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/LDAP/_lib---ldap.inc.html b/lam-web/developers/devel/phpdoc/LDAP/_lib---ldap.inc.html deleted file mode 100644 index 4fe0951c..00000000 --- a/lam-web/developers/devel/phpdoc/LDAP/_lib---ldap.inc.html +++ /dev/null @@ -1,138 +0,0 @@ - - -Docs for page ldap.inc - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: ldap.inc

-Source Location: /lib/ldap.inc

- -
-
- -
-

Classes:

-
Ldap
-
Ldap manages connection to LDAP and includes several helper functions.
-


- -

Page Details:

-ldap.inc provides basic functions to connect to the OpenLDAP server.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("config.inc") [line 32]
-Access to configuration data

include_once("schema.inc") [line 34]
-LDAP schema

-

-

-
-
- -

hex2bin [line 42]

-
-
-
- binary hex2bin( -string $value) -
-

- - Converts a HEX string to a binary value



-

Tags:

-
- - - - -
return:  result binary
-
-

- -

Parameters

- - - - - - -
string  $value  HEX string
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/FPDF.html b/lam-web/developers/devel/phpdoc/PDF/FPDF.html deleted file mode 100644 index 0bfceeae..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/FPDF.html +++ /dev/null @@ -1,3230 +0,0 @@ - - -Docs For Class FPDF - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class: FPDF

-Source Location: /lib/fpdf.php

- - - - - - - - - - -
- -

Class Overview

-

-
Main FPDF class for creating PDF documents


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
UFPDF
-
Main UFPDF class for creating Unicode PDF documents
-
-
-
-
- - -

Class Details

-
-[line 28]
-Main FPDF class for creating PDF documents



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$AliasNbPages =

-

[line 82]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$author =

-

[line 79]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$AutoPageBreak =

-

[line 72]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$bMargin =

-

[line 49]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$buffer =

-

[line 34]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$cMargin =

-

[line 50]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$ColorFlag =

-

[line 70]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$compress =

-

[line 37]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$CoreFonts =

-

[line 54]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$creator =

-

[line 81]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$CurOrientation =

-

[line 39]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$CurrentFont =

-

[line 64]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$DefOrientation =

-

[line 38]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$diffs =

-

[line 57]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$DrawColor =

-

[line 67]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$fh =

-

[line 43]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$fhPt =

-

[line 42]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$FillColor =

-

[line 68]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$FontFamily =

-

[line 61]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$FontFiles =

-

[line 56]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$fonts =

-

[line 55]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$FontSize =

-

[line 66]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$FontSizePt =

-

[line 65]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$FontStyle =

-

[line 62]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$fw =

-

[line 43]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$fwPt =

-

[line 42]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$h =

-

[line 45]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$hPt =

-

[line 44]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$images =

-

[line 58]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$InFooter =

-

[line 74]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$k =

-

[line 41]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$keywords =

-

[line 80]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$lasth =

-

[line 52]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$LayoutMode =

-

[line 76]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$LineWidth =

-

[line 53]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$links =

-

[line 60]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$lMargin =

-

[line 46]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$n =

-

[line 32]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$offsets =

-

[line 33]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$OrientationChanges =

-

[line 40]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$page =

-

[line 31]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$PageBreakTrigger =

-

[line 73]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$PageLinks =

-

[line 59]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$pages =

-

[line 35]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$PDFVersion =

-

[line 83]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$rMargin =

-

[line 48]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$state =

-

[line 36]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$subject =

-

[line 78]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$TextColor =

-

[line 69]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$title =

-

[line 77]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$tMargin =

-

[line 47]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$underline =

-

[line 63]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$w =

-

[line 45]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$wPt =

-

[line 44]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$ws =

-

[line 71]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$x =

-

[line 51]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$y =

-

[line 51]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$ZoomMode =

-

[line 75]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor FPDF [line 90]

-
-
-
- FPDF FPDF( -[ -$orientation = 'P'], [ -$unit = 'mm'], [ -$format = 'A4']) -
-

- - *****************************************************************************

* Public methods * * *****************************************************************************




- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $orientation  
  $unit  
  $format  
-

-
[ Top ]
-
-
- -

method AcceptPageBreak [line 628]

-
-
-
- void AcceptPageBreak( -) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::AcceptPageBreak()
-
-
-

- -
[ Top ]
-
-
- -

method AddFont [line 474]

-
-
-
- void AddFont( - -$family, [ -$style = ''], [ -$file = '']) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::AddFont()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $family  
  $style  
  $file  
-

-
[ Top ]
-
-
- -

method AddLink [line 593]

-
-
-
- void AddLink( -) -
-

- -

- - -
[ Top ]
-
-
- -

method AddPage [line 320]

-
-
-
- void AddPage( -[ -$orientation = '']) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $orientation  
-

-
[ Top ]
-
-
- -

method AliasNbPages [line 285]

-
-
-
- void AliasNbPages( -[ -$alias = '{nb}']) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::AliasNbPages()
-
-
-

- -

Parameters:

-
- - - - - - -
  $alias  
-

-
[ Top ]
-
-
- -

method Cell [line 634]

-
-
-
- void Cell( - -$w, [ -$h = 0], [ -$txt = ''], [ -$border = 0], [ -$ln = 0], [ -$align = ''], [ -$fill = 0], [ -$link = '']) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::Cell()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  $w  
  $h  
  $txt  
  $border  
  $ln  
  $align  
  $fill  
  $link  
-

-
[ Top ]
-
-
- -

method Close [line 303]

-
-
-
- void Close( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Error [line 291]

-
-
-
- void Error( - -$msg) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $msg  
-

-
[ Top ]
-
-
- -

method Footer [line 392]

-
-
-
- void Footer( -) -
-

- -

- - -
[ Top ]
-
-
- -

method GetStringWidth [line 436]

-
-
-
- void GetStringWidth( - -$s) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::GetStringWidth()
-
-
-

- -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method GetX [line 967]

-
-
-
- void GetX( -) -
-

- -

- - -
[ Top ]
-
-
- -

method GetY [line 982]

-
-
-
- void GetY( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Header [line 387]

-
-
-
- void Header( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Image [line 907]

-
-
-
- void Image( - -$file, -$x, -$y, [ -$w = 0], [ -$h = 0], [ -$type = ''], [ -$link = '']) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  $file  
  $x  
  $y  
  $w  
  $h  
  $type  
  $link  
-

-
[ Top ]
-
-
- -

method Line [line 456]

-
-
-
- void Line( - -$x1, -$y1, -$x2, -$y2) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
  $x1  
  $y1  
  $x2  
  $y2  
-

-
[ Top ]
-
-
- -

method Link [line 611]

-
-
-
- void Link( - -$x, -$y, -$w, -$h, -$link) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
  $x  
  $y  
  $w  
  $h  
  $link  
-

-
[ Top ]
-
-
- -

method Ln [line 957]

-
-
-
- void Ln( -[ -$h = '']) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $h  
-

-
[ Top ]
-
-
- -

method MultiCell [line 713]

-
-
-
- void MultiCell( - -$w, -$h, -$txt, [ -$border = 0], [ -$align = 'J'], [ -$fill = 0]) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::MultiCell()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  $w  
  $h  
  $txt  
  $border  
  $align  
  $fill  
-

-
[ Top ]
-
-
- -

method Open [line 297]

-
-
-
- void Open( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Output [line 1005]

-
-
-
- void Output( -[ -$name = ''], [ -$dest = '']) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $name  
  $dest  
-

-
[ Top ]
-
-
- -

method PageNo [line 397]

-
-
-
- void PageNo( -) -
-

- -

- - -
[ Top ]
-
-
- -

method Rect [line 462]

-
-
-
- void Rect( - -$x, -$y, -$w, -$h, [ -$style = '']) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
  $x  
  $y  
  $w  
  $h  
  $style  
-

-
[ Top ]
-
-
- -

method SetAuthor [line 267]

-
-
-
- void SetAuthor( - -$author) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $author  
-

-
[ Top ]
-
-
- -

method SetAutoPageBreak [line 225]

-
-
-
- void SetAutoPageBreak( - -$auto, [ -$margin = 0]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $auto  
  $margin  
-

-
[ Top ]
-
-
- -

method SetCompression [line 246]

-
-
-
- void SetCompression( - -$compress) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $compress  
-

-
[ Top ]
-
-
- -

method SetCreator [line 279]

-
-
-
- void SetCreator( - -$creator) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $creator  
-

-
[ Top ]
-
-
- -

method SetDisplayMode [line 233]

-
-
-
- void SetDisplayMode( - -$zoom, [ -$layout = 'continuous']) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $zoom  
  $layout  
-

-
[ Top ]
-
-
- -

method SetDrawColor [line 403]

-
-
-
- void SetDrawColor( - -$r, [ -$g = -1], [ -$b = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $r  
  $g  
  $b  
-

-
[ Top ]
-
-
- -

method SetFillColor [line 414]

-
-
-
- void SetFillColor( - -$r, [ -$g = -1], [ -$b = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $r  
  $g  
  $b  
-

-
[ Top ]
-
-
- -

method SetFont [line 522]

-
-
-
- void SetFont( - -$family, [ -$style = ''], [ -$size = 0]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $family  
  $style  
  $size  
-

-
[ Top ]
-
-
- -

method SetFontSize [line 582]

-
-
-
- void SetFontSize( - -$size) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $size  
-

-
[ Top ]
-
-
- -

method SetKeywords [line 273]

-
-
-
- void SetKeywords( - -$keywords) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $keywords  
-

-
[ Top ]
-
-
- -

method SetLeftMargin [line 205]

-
-
-
- void SetLeftMargin( - -$margin) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $margin  
-

-
[ Top ]
-
-
- -

method SetLineWidth [line 448]

-
-
-
- void SetLineWidth( - -$width) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $width  
-

-
[ Top ]
-
-
- -

method SetLink [line 601]

-
-
-
- void SetLink( - -$link, [ -$y = 0], [ -$page = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $link  
  $y  
  $page  
-

-
[ Top ]
-
-
- -

method SetMargins [line 195]

-
-
-
- void SetMargins( - -$left, -$top, [ -$right = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $left  
  $top  
  $right  
-

-
[ Top ]
-
-
- -

method SetRightMargin [line 219]

-
-
-
- void SetRightMargin( - -$margin) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $margin  
-

-
[ Top ]
-
-
- -

method SetSubject [line 261]

-
-
-
- void SetSubject( - -$subject) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $subject  
-

-
[ Top ]
-
-
- -

method SetTextColor [line 426]

-
-
-
- void SetTextColor( - -$r, [ -$g = -1], [ -$b = -1]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $r  
  $g  
  $b  
-

-
[ Top ]
-
-
- -

method SetTitle [line 255]

-
-
-
- void SetTitle( - -$title) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $title  
-

-
[ Top ]
-
-
- -

method SetTopMargin [line 213]

-
-
-
- void SetTopMargin( - -$margin) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $margin  
-

-
[ Top ]
-
-
- -

method SetX [line 973]

-
-
-
- void SetX( - -$x) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $x  
-

-
[ Top ]
-
-
- -

method SetXY [line 998]

-
-
-
- void SetXY( - -$x, -$y) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $x  
  $y  
-

-
[ Top ]
-
-
- -

method SetY [line 988]

-
-
-
- void SetY( - -$y) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $y  
-

-
[ Top ]
-
-
- -

method Text [line 617]

-
-
-
- void Text( - -$x, -$y, -$txt) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::Text()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $x  
  $y  
  $txt  
-

-
[ Top ]
-
-
- -

method Write [line 826]

-
-
-
- void Write( - -$h, -$txt, [ -$link = '']) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::Write()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $h  
  $txt  
  $link  
-

-
[ Top ]
-
-
- -

method _beginpage [line 1445]

-
-
-
- void _beginpage( - -$orientation) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $orientation  
-

-
[ Top ]
-
-
- -

method _dochecks [line 1078]

-
-
-
- void _dochecks( -) -
-

- - *****************************************************************************

* Protected methods * * *****************************************************************************




- - -
[ Top ]
-
-
- -

method _dounderline [line 1498]

-
-
-
- void _dounderline( - -$x, -$y, -$txt) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::_dounderline()
-
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $x  
  $y  
  $txt  
-

-
[ Top ]
-
-
- -

method _enddoc [line 1410]

-
-
-
- void _enddoc( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _endpage [line 1484]

-
-
-
- void _endpage( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _escape [line 1627]

-
-
-
- void _escape( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method _freadint [line 1614]

-
-
-
- void _freadint( - -$f) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $f  
-

-
[ Top ]
-
-
- -

method _getfontpath [line 1088]

-
-
-
- void _getfontpath( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _newobj [line 1490]

-
-
-
- void _newobj( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _out [line 1640]

-
-
-
- void _out( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method _parsejpg [line 1507]

-
-
-
- void _parsejpg( - -$file) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $file  
-

-
[ Top ]
-
-
- -

method _parsepng [line 1531]

-
-
-
- void _parsepng( - -$file) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $file  
-

-
[ Top ]
-
-
- -

method _putcatalog [line 1378]

-
-
-
- void _putcatalog( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putfonts [line 1166]

-
-
-
- void _putfonts( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putheader [line 1398]

-
-
-
- void _putheader( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putimages [line 1283]

-
-
-
- void _putimages( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putinfo [line 1362]

-
-
-
- void _putinfo( -) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::_putinfo()
-
-
-

- -
[ Top ]
-
-
- -

method _putpages [line 1095]

-
-
-
- void _putpages( -) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::_putpages()
-
-
-

- -
[ Top ]
-
-
- -

method _putresourcedict [line 1337]

-
-
-
- void _putresourcedict( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putresources [line 1349]

-
-
-
- void _putresources( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putstream [line 1633]

-
-
-
- void _putstream( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method _puttrailer [line 1403]

-
-
-
- void _puttrailer( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _putxobjectdict [line 1331]

-
-
-
- void _putxobjectdict( -) -
-

- -

- - -
[ Top ]
-
-
- -

method _textstring [line 1621]

-
-
-
- void _textstring( - -$s) -
-

- -

- -

Overridden in child classes as:
-

-
UFPDF::_textstring()
-
-
-

- -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/PDF/UFPDF.html b/lam-web/developers/devel/phpdoc/PDF/UFPDF.html deleted file mode 100644 index 735d30e1..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/UFPDF.html +++ /dev/null @@ -1,1647 +0,0 @@ - - -Docs For Class UFPDF - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class: UFPDF

-Source Location: /lib/ufpdf.php

- - - - - - - - - -
- -

Class Overview

-
FPDF
-   |
-   --UFPDF

-
Main UFPDF class for creating Unicode PDF documents


-

Author(s):

-
    -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - - -
-

Child classes:

-
-
-
lamPDF
-
Creates a LAM information page in PDF format.
-
-
-
-

Inherited Variables

-
-

Class: FPDF

-
-
- FPDF::$AliasNbPages -
-
- -
-
- FPDF::$author -
-
- -
-
- FPDF::$AutoPageBreak -
-
- -
-
- FPDF::$bMargin -
-
- -
-
- FPDF::$buffer -
-
- -
-
- FPDF::$cMargin -
-
- -
-
- FPDF::$ColorFlag -
-
- -
-
- FPDF::$compress -
-
- -
-
- FPDF::$CoreFonts -
-
- -
-
- FPDF::$creator -
-
- -
-
- FPDF::$CurOrientation -
-
- -
-
- FPDF::$CurrentFont -
-
- -
-
- FPDF::$DefOrientation -
-
- -
-
- FPDF::$diffs -
-
- -
-
- FPDF::$DrawColor -
-
- -
-
- FPDF::$fh -
-
- -
-
- FPDF::$fhPt -
-
- -
-
- FPDF::$FillColor -
-
- -
-
- FPDF::$FontFamily -
-
- -
-
- FPDF::$FontFiles -
-
- -
-
- FPDF::$fonts -
-
- -
-
- FPDF::$FontSize -
-
- -
-
- FPDF::$FontSizePt -
-
- -
-
- FPDF::$FontStyle -
-
- -
-
- FPDF::$fw -
-
- -
-
- FPDF::$fwPt -
-
- -
-
- FPDF::$h -
-
- -
-
- FPDF::$hPt -
-
- -
-
- FPDF::$images -
-
- -
-
- FPDF::$InFooter -
-
- -
-
- FPDF::$k -
-
- -
-
- FPDF::$keywords -
-
- -
-
- FPDF::$lasth -
-
- -
-
- FPDF::$LayoutMode -
-
- -
-
- FPDF::$LineWidth -
-
- -
-
- FPDF::$links -
-
- -
-
- FPDF::$lMargin -
-
- -
-
- FPDF::$n -
-
- -
-
- FPDF::$offsets -
-
- -
-
- FPDF::$OrientationChanges -
-
- -
-
- FPDF::$page -
-
- -
-
- FPDF::$PageBreakTrigger -
-
- -
-
- FPDF::$PageLinks -
-
- -
-
- FPDF::$pages -
-
- -
-
- FPDF::$PDFVersion -
-
- -
-
- FPDF::$rMargin -
-
- -
-
- FPDF::$state -
-
- -
-
- FPDF::$subject -
-
- -
-
- FPDF::$TextColor -
-
- -
-
- FPDF::$title -
-
- -
-
- FPDF::$tMargin -
-
- -
-
- FPDF::$underline -
-
- -
-
- FPDF::$w -
-
- -
-
- FPDF::$wPt -
-
- -
-
- FPDF::$ws -
-
- -
-
- FPDF::$x -
-
- -
-
- FPDF::$y -
-
- -
-
- FPDF::$ZoomMode -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: FPDF

-
-
- FPDF::FPDF() -
-
- ***************************************************************************** -
-
- FPDF::AcceptPageBreak() -
-
- -
-
- FPDF::AddFont() -
-
- -
-
- FPDF::AddLink() -
-
- -
-
- FPDF::AddPage() -
-
- -
-
- FPDF::AliasNbPages() -
-
- -
-
- FPDF::Cell() -
-
- -
-
- FPDF::Close() -
-
- -
-
- FPDF::Error() -
-
- -
-
- FPDF::Footer() -
-
- -
-
- FPDF::GetStringWidth() -
-
- -
-
- FPDF::GetX() -
-
- -
-
- FPDF::GetY() -
-
- -
-
- FPDF::Header() -
-
- -
-
- FPDF::Image() -
-
- -
-
- FPDF::Line() -
-
- -
-
- FPDF::Link() -
-
- -
-
- FPDF::Ln() -
-
- -
-
- FPDF::MultiCell() -
-
- -
-
- FPDF::Open() -
-
- -
-
- FPDF::Output() -
-
- -
-
- FPDF::PageNo() -
-
- -
-
- FPDF::Rect() -
-
- -
-
- FPDF::SetAuthor() -
-
- -
-
- FPDF::SetAutoPageBreak() -
-
- -
-
- FPDF::SetCompression() -
-
- -
-
- FPDF::SetCreator() -
-
- -
-
- FPDF::SetDisplayMode() -
-
- -
-
- FPDF::SetDrawColor() -
-
- -
-
- FPDF::SetFillColor() -
-
- -
-
- FPDF::SetFont() -
-
- -
-
- FPDF::SetFontSize() -
-
- -
-
- FPDF::SetKeywords() -
-
- -
-
- FPDF::SetLeftMargin() -
-
- -
-
- FPDF::SetLineWidth() -
-
- -
-
- FPDF::SetLink() -
-
- -
-
- FPDF::SetMargins() -
-
- -
-
- FPDF::SetRightMargin() -
-
- -
-
- FPDF::SetSubject() -
-
- -
-
- FPDF::SetTextColor() -
-
- -
-
- FPDF::SetTitle() -
-
- -
-
- FPDF::SetTopMargin() -
-
- -
-
- FPDF::SetX() -
-
- -
-
- FPDF::SetXY() -
-
- -
-
- FPDF::SetY() -
-
- -
-
- FPDF::Text() -
-
- -
-
- FPDF::Write() -
-
- -
-
- FPDF::_beginpage() -
-
- -
-
- FPDF::_dochecks() -
-
- ***************************************************************************** -
-
- FPDF::_dounderline() -
-
- -
-
- FPDF::_enddoc() -
-
- -
-
- FPDF::_endpage() -
-
- -
-
- FPDF::_escape() -
-
- -
-
- FPDF::_freadint() -
-
- -
-
- FPDF::_getfontpath() -
-
- -
-
- FPDF::_newobj() -
-
- -
-
- FPDF::_out() -
-
- -
-
- FPDF::_parsejpg() -
-
- -
-
- FPDF::_parsepng() -
-
- -
-
- FPDF::_putcatalog() -
-
- -
-
- FPDF::_putfonts() -
-
- -
-
- FPDF::_putheader() -
-
- -
-
- FPDF::_putimages() -
-
- -
-
- FPDF::_putinfo() -
-
- -
-
- FPDF::_putpages() -
-
- -
-
- FPDF::_putresourcedict() -
-
- -
-
- FPDF::_putresources() -
-
- -
-
- FPDF::_putstream() -
-
- -
-
- FPDF::_puttrailer() -
-
- -
-
- FPDF::_putxobjectdict() -
-
- -
-
- FPDF::_textstring() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 37]
-Main UFPDF class for creating Unicode PDF documents



-

Tags:

-
- - - - -
see:  FPDF::FPDF()
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor UFPDF [line 45]

-
-
-
- UFPDF UFPDF( -[ -$orientation = 'P'], [ -$unit = 'mm'], [ -$format = 'A4']) -
-

- - *****************************************************************************

* Public methods * * *****************************************************************************




- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $orientation  
  $unit  
  $format  
-

-
[ Top ]
-
-
- -

method AcceptPageBreak [line 113]

-
-
-
- void AcceptPageBreak( -) -
-

- -

- - Overrides FPDF::AcceptPageBreak() (parent method not documented)

-
[ Top ]
-
-
- -

method AddFont [line 73]

-
-
-
- void AddFont( - -$family, [ -$style = ''], [ -$file = '']) -
-

- -

- - Overrides FPDF::AddFont() (parent method not documented)

-

Parameters:

-
- - - - - - - - - - - - - - - - -
  $family  
  $style  
  $file  
-

-
[ Top ]
-
-
- -

method AliasNbPages [line 407]

-
-
-
- void AliasNbPages( -[ -$alias = '{nb}']) -
-

- -

- - Overrides FPDF::AliasNbPages() (parent method not documented)

-

Parameters:

-
- - - - - - -
  $alias  
-

-
[ Top ]
-
-
- -

method Cell [line 119]

-
-
-
- void Cell( - -$w, [ -$h = 0], [ -$txt = ''], [ -$border = 0], [ -$ln = 0], [ -$align = 'J'], [ -$fill = 0], [ -$link = '']) -
-

- -

- - Overrides FPDF::Cell() (parent method not documented)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  $w  
  $h  
  $txt  
  $border  
  $ln  
  $align  
  $fill  
  $link  
-

-
[ Top ]
-
-
- -

method code2utf [line 697]

-
-
-
- void code2utf( - -$num) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $num  
-

-
[ Top ]
-
-
- -

method GetStringWidth [line 50]

-
-
-
- void GetStringWidth( - -$s) -
-

- -

- - Overrides FPDF::GetStringWidth() (parent method not documented)

-

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method MultiCell [line 199]

-
-
-
- void MultiCell( - -$w, -$h, -$txt, [ -$border = 0], [ -$align = 'J'], [ -$fill = 0]) -
-

- -

- - Overrides FPDF::MultiCell() (parent method not documented)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  $w  
  $h  
  $txt  
  $border  
  $align  
  $fill  
-

-
[ Top ]
-
-
- -

method strlen [line 705]

-
-
-
- void strlen( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method Text [line 102]

-
-
-
- void Text( - -$x, -$y, -$txt) -
-

- -

- - Overrides FPDF::Text() (parent method not documented)

-

Parameters:

-
- - - - - - - - - - - - - - - - -
  $x  
  $y  
  $txt  
-

-
[ Top ]
-
-
- -

method utf8_substr [line 709]

-
-
-
- void utf8_substr( - -$str, -$start) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  $str  
  $start  
-

-
[ Top ]
-
-
- -

method utf8_to_codepoints [line 726]

-
-
-
- void utf8_to_codepoints( - -$txt) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $txt  
-

-
[ Top ]
-
-
- -

method utf8_to_utf16be [line 597]

-
-
-
- void utf8_to_utf16be( - -&$txt, [ -$bom = true]) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - -
  &$txt  
  $bom  
-

-
[ Top ]
-
-
- -

method Write [line 324]

-
-
-
- void Write( - -$h, -$txt, [ -$link = '']) -
-

- -

- - Overrides FPDF::Write() (parent method not documented)

-

Parameters:

-
- - - - - - - - - - - - - - - - -
  $h  
  $txt  
  $link  
-

-
[ Top ]
-
-
- -

method _dounderline [line 481]

-
-
-
- void _dounderline( - -$x, -$y, -$width, -$txt) -
-

- -

- - Overrides FPDF::_dounderline() (parent method not documented)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
  $x  
  $y  
  $width  
  $txt  
-

-
[ Top ]
-
-
- -

method _escapetext [line 498]

-
-
-
- void _escapetext( - -$s) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-
- -

method _putinfo [line 506]

-
-
-
- void _putinfo( -) -
-

- -

- - Overrides FPDF::_putinfo() (parent method not documented)

-
[ Top ]
-
-
- -

method _putpages [line 522]

-
-
-
- void _putpages( -) -
-

- -

- - Overrides FPDF::_putpages() (parent method not documented)

-
[ Top ]
-
-
- -

method _puttruetypeunicode [line 419]

-
-
-
- void _puttruetypeunicode( - -$font) -
-

- - *****************************************************************************

* Protected methods * * *****************************************************************************




- - -

Parameters:

-
- - - - - - -
  $font  
-

-
[ Top ]
-
-
- -

method _textstring [line 490]

-
-
-
- void _textstring( - -$s) -
-

- -

- - Overrides FPDF::_textstring() (parent method not documented)

-

Parameters:

-
- - - - - - -
  $s  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---font---vera.php.html b/lam-web/developers/devel/phpdoc/PDF/_lib---font---vera.php.html deleted file mode 100644 index e094d311..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---font---vera.php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -Docs for page vera.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: vera.php

-Source Location: /lib/font/vera.php

- -
-
- - -

Page Details:

-This file includes information about the Bitstream Vera font.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---font---verab.php.html b/lam-web/developers/devel/phpdoc/PDF/_lib---font---verab.php.html deleted file mode 100644 index b239d9e3..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---font---verab.php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -Docs for page verab.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: verab.php

-Source Location: /lib/font/verab.php

- -
-
- - -

Page Details:

-This file includes information about the Bitstream Vera font.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---font---verabi.php.html b/lam-web/developers/devel/phpdoc/PDF/_lib---font---verabi.php.html deleted file mode 100644 index fa3c6934..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---font---verabi.php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -Docs for page verabi.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: verabi.php

-Source Location: /lib/font/verabi.php

- -
-
- - -

Page Details:

-This file includes information about the Bitstream Vera font.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---font---verai.php.html b/lam-web/developers/devel/phpdoc/PDF/_lib---font---verai.php.html deleted file mode 100644 index d1512f35..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---font---verai.php.html +++ /dev/null @@ -1,123 +0,0 @@ - - -Docs for page verai.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: verai.php

-Source Location: /lib/font/verai.php

- -
-
- - -

Page Details:

-This file includes information about the Bitstream Vera font.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---fpdf.php.html b/lam-web/developers/devel/phpdoc/PDF/_lib---fpdf.php.html deleted file mode 100644 index 996eb706..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---fpdf.php.html +++ /dev/null @@ -1,141 +0,0 @@ - - -Docs for page fpdf.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: fpdf.php

-Source Location: /lib/fpdf.php

- -
-
- -
-

Classes:

-
FPDF
-
Main FPDF class for creating PDF documents
-


- -

Page Details:

-This file includes the FPDF implementation which is used to generate PDF files.



-

Tags:

-
- - - - -
author:  Olivier Plathey
-
-

-

-

-
- -

FPDF_VERSION [line 21]

-
-
-
- FPDF_VERSION = '1.53' -
-
- - *****************************************************************************

Software: FPDF * Version: 1.53 * Date: 2004-12-31 * Author: Olivier PLATHEY * License: Freeware * * You may use, modify and redistribute this software as you wish. * *****************************************************************************



-
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---lamPDF.inc.html b/lam-web/developers/devel/phpdoc/PDF/_lib---lamPDF.inc.html deleted file mode 100644 index 39db685e..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---lamPDF.inc.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Docs for page lamPDF.inc - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: lamPDF.inc

-Source Location: /lib/lamPDF.inc

- -
-
- -
-

Classes:

-
lamPDF
-
Creates a LAM information page in PDF format.
-


- -

Page Details:

-LDAP Account Manager PDF printing library. It consists of lamPDF class, the createModulePDF() function that may be called by other pages and furthermore some helper functions.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---pdf.inc.html b/lam-web/developers/devel/phpdoc/PDF/_lib---pdf.inc.html deleted file mode 100644 index b95c1b13..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---pdf.inc.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs for page pdf.inc - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: pdf.inc

-Source Location: /lib/pdf.inc

- -
-
- - -

Page Details:

-LDAP Account Manager PDF printing library. It consists of lamPDF class, the createModulePDF() function that may be called by other pages and furthermore some helper functions.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-

-

Includes:

-
-include_once('pdfstruct.inc') [line 39]
-access to PDF configuration files

include_once('xml_parser.inc') [line 36]
-XML functions

-

-

-
- -

LAMPDF_LINEWIDTH [line 33]

-
-
-
- LAMPDF_LINEWIDTH = 190 -
-
- - PDF line width


-
-
[ Top ]


-
-
- -

createModulePDF [line 56]

-
-
-
- void createModulePDF( -array $accounts, [string $pdf_structure = &quot;default&quot;]) -
-

- - This function creates the PDF output of one or more accounts. At the moment this function can create a PDF page for user, group and host accounts. But this is not limited by the function itself but by the account types that are allowed in LAM and the exsisting PDF structure definitions.



- -

Parameters

- - - - - - - - - - - -
array  $accounts  A numbered array containing all accounts the PDF page should be created for. The entries of the array must be AccountContainer objects.
string  $pdf_structure  The filename of the structure definition that should be used to create the PDF page. If not submitted the 'default.user' structure definition for the appropriate account type.
-
[ Top ]


-
-
- -

getSectionHeadline [line 166]

-
-
-
- string getSectionHeadline( -string $line) -
-

- - Creates a section headline.



-

Tags:

-
- - - - -
return:  XML code for headline
-
-

- -

Parameters

- - - - - - -
string  $line  section name
-
[ Top ]


-
-
- -

processAttributes [line 294]

-
-
-
- array processAttributes( -string $attrs, [array $return = array()]) -
-

- - Processes width, height and alignment attributes.



-

Tags:

-
- - - - -
return:  XML code
-
-

- -

Parameters

- - - - - - - - - - - -
string  $attrs  attributes
array  $return  XML code
-
[ Top ]


-
-
- -

processFormatTags [line 261]

-
-
-
- array processFormatTags( -string $line, string $style) -
-

- - Formats the XML code.



-

Tags:

-
- - - - -
return:  XML code
-
-

- -

Parameters

- - - - - - - - - - - -
string  $line  XML code of PDF entry
string  $style  style commands
-
[ Top ]


-
-
- -

processLine [line 185]

-
-
-
- array processLine( -string $line, [boolean $first_td = true], $fontName) -
-

- - Creates the XML code for an PDF entry.



-

Tags:

-
- - - - -
return:  XML codes
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $line  XML code of PDF entry
boolean  $first_td  True if this is the first column
  $fontName  
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:43 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---pdfstruct.inc.html b/lam-web/developers/devel/phpdoc/PDF/_lib---pdfstruct.inc.html deleted file mode 100644 index cd7d0329..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---pdfstruct.inc.html +++ /dev/null @@ -1,295 +0,0 @@ - - -Docs for page pdfstruct.inc - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: pdfstruct.inc

-Source Location: /lib/pdfstruct.inc

- -
-
- - -

Page Details:

-Functions to manage the PDF structures.



-

Tags:

-
- - - - -
author:  Michael Dürgner
-
-

-

Includes:

-
-include_once("ldap.inc") [line 34]
-LDAP object

include_once("config.inc") [line 31]
-LAM configuration

-

-

-
-
- -

deletePDFStructureDefinition [line 158]

-
-
-
- boolean deletePDFStructureDefinition( -string $scope, string $definition) -
-

- - Deletes XML file with PDF structure definitions.



-

Tags:

-
- - - - -
return:  True if file was deleted or false if a problem occured.
-
-

- -

Parameters

- - - - - - - - - - - -
string  $scope  account type
string  $definition  Name of definition to delete
-
[ Top ]


-
-
- -

getAvailableLogos [line 176]

-
-
-
- array getAvailableLogos( -) -
-

- - This function returns an array with all aviliable logo images.



-

Tags:

-
- - - - -
return:  list of logo files
-
-

- -
[ Top ]


-
-
- -

getPDFStructureDefinitions [line 47]

-
-
-
- array getPDFStructureDefinitions( -[string $scope = &quot;user&quot;]) -
-

- - This function will return all available PDF structure definitions for the submitted account scope.



-

Tags:

-
- - - - -
return:  All available PDF structure definitions for the submitted account scope. Each entry is a string being the filename that may be passed to the createModulePDF() function as second argument.
-
-

- -

Parameters

- - - - - - -
string  $scope  The account scope the PDF structure definitions should be returned.
-
[ Top ]


-
-
- -

loadPDFStructureDefinitions [line 72]

-
-
-
- array loadPDFStructureDefinitions( -[string $scope = 'user'], [string $pdf_structure = 'default']) -
-

- - This function is used to get pdf structure from xml file.

Used in createModulePDF.




-

Tags:

-
- - - - -
return:  PDF structure
-
-

- -

Parameters

- - - - - - - - - - - -
string  $scope  The account scope for wich the PDF structure should be returned.
string  $pdf_structure  Structure name of selected scope wich should be returned.
-
[ Top ]


-
-
- -

savePDFStructureDefinitions [line 100]

-
-
-
- string savePDFStructureDefinitions( -string $scope, string $definition) -
-

- - Saves PDF structure definitions to XML file in format: <name>.<scope>.xml



-

Tags:

-
- - - - -
return:  "no perms" if access denied or "ok".
-
-

- -

Parameters

- - - - - - - - - - - -
string  $scope  account type
string  $definition  Name of definition
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:44 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---ufpdf.php.html b/lam-web/developers/devel/phpdoc/PDF/_lib---ufpdf.php.html deleted file mode 100644 index 4943d52d..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---ufpdf.php.html +++ /dev/null @@ -1,148 +0,0 @@ - - -Docs for page ufpdf.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: ufpdf.php

-Source Location: /lib/ufpdf.php

- -
-
- -
-

Classes:

-
UFPDF
-
Main UFPDF class for creating Unicode PDF documents
-


- -

Page Details:

-This file includes UFPDF which adds Unicode support to FPDF.



-

Tags:

-
- - - - - - - -
author:  Steven Wittens
author:  Andrea Rossato
-
-

-

Includes:

-
-include_once('fpdf.php') [line 29]
-
-

-

-
- -

UFPDF_VERSION [line 27]

-
-
-
- UFPDF_VERSION = '0.1' -
-
- - *****************************************************************************

Software: UFPDF, Unicode Free PDF generator * Version: 0.1 * based on FPDF 1.52 by Olivier PLATHEY * Date: 2004-09-01 * Author: Steven Wittens <steven@acko.net> * License: GPL * * UFPDF is a modification of FPDF to support Unicode through UTF-8. * * This file includes modifications from Andrea Rossato which fix line breaking * in Write()/MultiCell(). * * *****************************************************************************



-
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_lib---xml_parser.inc.html b/lam-web/developers/devel/phpdoc/PDF/_lib---xml_parser.inc.html deleted file mode 100644 index f7937557..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_lib---xml_parser.inc.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Docs for page xml_parser.inc - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: xml_parser.inc

-Source Location: /lib/xml_parser.inc

- -
-
- -
-

Classes:

-
xmlParser
-
-


- -

Page Details:

-LDAP Account Manager xmlParser class



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html b/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html deleted file mode 100644 index c0a812f3..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfdelete.php.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Docs for page pdfdelete.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: pdfdelete.php

-Source Location: /templates/pdfedit/pdfdelete.php

- -
-
- - -

Page Details:

-Manages deletion of pdf structures.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 33]
-security functions

include_once('../../lib/pdfstruct.inc') [line 35]
-helper functions for pdf

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:44 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html b/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html deleted file mode 100644 index cdbcc412..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfmain.php.html +++ /dev/null @@ -1,131 +0,0 @@ - - -Docs for page pdfmain.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: pdfmain.php

-Source Location: /templates/pdfedit/pdfmain.php

- -
-
- - -

Page Details:

-This is the main window of the pdf structure editor.



-

Tags:

-
- - - - -
author:  Michael D�rgner
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 32]
-security functions

include_once("../../lib/pdfstruct.inc") [line 34]
-access to PDF configuration files

include_once("../../lib/ldap.inc") [line 36]
-LDAP object

include_once("../../lib/config.inc") [line 38]
-for language settings

include_once("../../lib/modules.inc") [line 40]
-module functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:44 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html b/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html deleted file mode 100644 index 96e5c3fc..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/_templates---pdfedit---pdfpage.php.html +++ /dev/null @@ -1,135 +0,0 @@ - - -Docs for page pdfpage.php - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: pdfpage.php

-Source Location: /templates/pdfedit/pdfpage.php

- -
-
- - -

Page Details:

-Displays the main page of the PDF editor where the user can select the displayed entries.



-

Tags:

-
- - - - - - - -
author:  Michael Duergner
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/pdfstruct.inc') [line 38]
-access to PDF configuration files

include_once("../../lib/security.inc") [line 36]
-security functions

include_once('../../lib/ldap.inc') [line 40]
-LDAP object

include_once('../../lib/config.inc') [line 42]
-LAM configuration

include_once('../../lib/xml_parser.inc') [line 46]
-XML functions

include_once('../../lib/modules.inc') [line 44]
-module functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:44 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/PDF/lamPDF.html b/lam-web/developers/devel/phpdoc/PDF/lamPDF.html deleted file mode 100644 index 65913ff1..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/lamPDF.html +++ /dev/null @@ -1,1161 +0,0 @@ - - -Docs For Class lamPDF - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamPDF

-Source Location: /lib/lamPDF.inc

- - - - - - - - - -
- -

Class Overview

-
FPDF
-   |
-   --UFPDF
-      |
-      --lamPDF

-
Creates a LAM information page in PDF format.


-

Author(s):

-
    -
  • Michael Duergner
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: FPDF

-
-
- FPDF::$AliasNbPages -
-
- -
-
- FPDF::$author -
-
- -
-
- FPDF::$AutoPageBreak -
-
- -
-
- FPDF::$bMargin -
-
- -
-
- FPDF::$buffer -
-
- -
-
- FPDF::$cMargin -
-
- -
-
- FPDF::$ColorFlag -
-
- -
-
- FPDF::$compress -
-
- -
-
- FPDF::$CoreFonts -
-
- -
-
- FPDF::$creator -
-
- -
-
- FPDF::$CurOrientation -
-
- -
-
- FPDF::$CurrentFont -
-
- -
-
- FPDF::$DefOrientation -
-
- -
-
- FPDF::$diffs -
-
- -
-
- FPDF::$DrawColor -
-
- -
-
- FPDF::$fh -
-
- -
-
- FPDF::$fhPt -
-
- -
-
- FPDF::$FillColor -
-
- -
-
- FPDF::$FontFamily -
-
- -
-
- FPDF::$FontFiles -
-
- -
-
- FPDF::$fonts -
-
- -
-
- FPDF::$FontSize -
-
- -
-
- FPDF::$FontSizePt -
-
- -
-
- FPDF::$FontStyle -
-
- -
-
- FPDF::$fw -
-
- -
-
- FPDF::$fwPt -
-
- -
-
- FPDF::$h -
-
- -
-
- FPDF::$hPt -
-
- -
-
- FPDF::$images -
-
- -
-
- FPDF::$InFooter -
-
- -
-
- FPDF::$k -
-
- -
-
- FPDF::$keywords -
-
- -
-
- FPDF::$lasth -
-
- -
-
- FPDF::$LayoutMode -
-
- -
-
- FPDF::$LineWidth -
-
- -
-
- FPDF::$links -
-
- -
-
- FPDF::$lMargin -
-
- -
-
- FPDF::$n -
-
- -
-
- FPDF::$offsets -
-
- -
-
- FPDF::$OrientationChanges -
-
- -
-
- FPDF::$page -
-
- -
-
- FPDF::$PageBreakTrigger -
-
- -
-
- FPDF::$PageLinks -
-
- -
-
- FPDF::$pages -
-
- -
-
- FPDF::$PDFVersion -
-
- -
-
- FPDF::$rMargin -
-
- -
-
- FPDF::$state -
-
- -
-
- FPDF::$subject -
-
- -
-
- FPDF::$TextColor -
-
- -
-
- FPDF::$title -
-
- -
-
- FPDF::$tMargin -
-
- -
-
- FPDF::$underline -
-
- -
-
- FPDF::$w -
-
- -
-
- FPDF::$wPt -
-
- -
-
- FPDF::$ws -
-
- -
-
- FPDF::$x -
-
- -
-
- FPDF::$y -
-
- -
-
- FPDF::$ZoomMode -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: UFPDF

-
-
- UFPDF::UFPDF() -
-
- ***************************************************************************** -
-
- UFPDF::AcceptPageBreak() -
-
- -
-
- UFPDF::AddFont() -
-
- -
-
- UFPDF::AliasNbPages() -
-
- -
-
- UFPDF::Cell() -
-
- -
-
- UFPDF::code2utf() -
-
- -
-
- UFPDF::GetStringWidth() -
-
- -
-
- UFPDF::MultiCell() -
-
- -
-
- UFPDF::strlen() -
-
- -
-
- UFPDF::Text() -
-
- -
-
- UFPDF::utf8_substr() -
-
- -
-
- UFPDF::utf8_to_codepoints() -
-
- -
-
- UFPDF::utf8_to_utf16be() -
-
- -
-
- UFPDF::Write() -
-
- -
-
- UFPDF::_dounderline() -
-
- -
-
- UFPDF::_escapetext() -
-
- -
-
- UFPDF::_putinfo() -
-
- -
-
- UFPDF::_putpages() -
-
- -
-
- UFPDF::_puttruetypeunicode() -
-
- ***************************************************************************** -
-
- UFPDF::_textstring() -
-
- -
-
-

Class: FPDF

-
-
- FPDF::FPDF() -
-
- ***************************************************************************** -
-
- FPDF::AcceptPageBreak() -
-
- -
-
- FPDF::AddFont() -
-
- -
-
- FPDF::AddLink() -
-
- -
-
- FPDF::AddPage() -
-
- -
-
- FPDF::AliasNbPages() -
-
- -
-
- FPDF::Cell() -
-
- -
-
- FPDF::Close() -
-
- -
-
- FPDF::Error() -
-
- -
-
- FPDF::Footer() -
-
- -
-
- FPDF::GetStringWidth() -
-
- -
-
- FPDF::GetX() -
-
- -
-
- FPDF::GetY() -
-
- -
-
- FPDF::Header() -
-
- -
-
- FPDF::Image() -
-
- -
-
- FPDF::Line() -
-
- -
-
- FPDF::Link() -
-
- -
-
- FPDF::Ln() -
-
- -
-
- FPDF::MultiCell() -
-
- -
-
- FPDF::Open() -
-
- -
-
- FPDF::Output() -
-
- -
-
- FPDF::PageNo() -
-
- -
-
- FPDF::Rect() -
-
- -
-
- FPDF::SetAuthor() -
-
- -
-
- FPDF::SetAutoPageBreak() -
-
- -
-
- FPDF::SetCompression() -
-
- -
-
- FPDF::SetCreator() -
-
- -
-
- FPDF::SetDisplayMode() -
-
- -
-
- FPDF::SetDrawColor() -
-
- -
-
- FPDF::SetFillColor() -
-
- -
-
- FPDF::SetFont() -
-
- -
-
- FPDF::SetFontSize() -
-
- -
-
- FPDF::SetKeywords() -
-
- -
-
- FPDF::SetLeftMargin() -
-
- -
-
- FPDF::SetLineWidth() -
-
- -
-
- FPDF::SetLink() -
-
- -
-
- FPDF::SetMargins() -
-
- -
-
- FPDF::SetRightMargin() -
-
- -
-
- FPDF::SetSubject() -
-
- -
-
- FPDF::SetTextColor() -
-
- -
-
- FPDF::SetTitle() -
-
- -
-
- FPDF::SetTopMargin() -
-
- -
-
- FPDF::SetX() -
-
- -
-
- FPDF::SetXY() -
-
- -
-
- FPDF::SetY() -
-
- -
-
- FPDF::Text() -
-
- -
-
- FPDF::Write() -
-
- -
-
- FPDF::_beginpage() -
-
- -
-
- FPDF::_dochecks() -
-
- ***************************************************************************** -
-
- FPDF::_dounderline() -
-
- -
-
- FPDF::_enddoc() -
-
- -
-
- FPDF::_endpage() -
-
- -
-
- FPDF::_escape() -
-
- -
-
- FPDF::_freadint() -
-
- -
-
- FPDF::_getfontpath() -
-
- -
-
- FPDF::_newobj() -
-
- -
-
- FPDF::_out() -
-
- -
-
- FPDF::_parsejpg() -
-
- -
-
- FPDF::_parsepng() -
-
- -
-
- FPDF::_putcatalog() -
-
- -
-
- FPDF::_putfonts() -
-
- -
-
- FPDF::_putheader() -
-
- -
-
- FPDF::_putimages() -
-
- -
-
- FPDF::_putinfo() -
-
- -
-
- FPDF::_putpages() -
-
- -
-
- FPDF::_putresourcedict() -
-
- -
-
- FPDF::_putresources() -
-
- -
-
- FPDF::_putstream() -
-
- -
-
- FPDF::_puttrailer() -
-
- -
-
- FPDF::_putxobjectdict() -
-
- -
-
- FPDF::_textstring() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 38]
-Creates a LAM information page in PDF format.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 64]

-
-
-
- lamPDF __construct( -[array -$page_definitions = array()], -$fontName, string -$account_type) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
string  $account_type  
array  $page_definitions  
  $fontName  
-

-
[ Top ]
-
-
- -

method footer [line 120]

-
-
-
- void footer( -) -
-

- -

- - -
[ Top ]
-
-
- -

method header [line 88]

-
-
-
- void header( -) -
-

- -

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/PDF/xmlParser.html b/lam-web/developers/devel/phpdoc/PDF/xmlParser.html deleted file mode 100644 index a07ee24f..00000000 --- a/lam-web/developers/devel/phpdoc/PDF/xmlParser.html +++ /dev/null @@ -1,215 +0,0 @@ - - -Docs For Class xmlParser - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class: xmlParser

-Source Location: /lib/xml_parser.inc

- - - - - - - - - -
- -

Class Overview

-

-


-

Author(s):

-
    -
  • Michael Duergner
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 36]
-

-

Tags:

-
- - - - -
author:  Michael Duergner
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 46]

-
-
-
- xmlParser __construct( -) -
-

- - Constructor



- - -
[ Top ]
-
-
- -

method parse [line 60]

-
-
-
- array parse( -string -$filename) -
-

- -

- - -

Parameters:

-
- - - - - - -
string  $filename  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_Help.html b/lam-web/developers/devel/phpdoc/classtrees_Help.html deleted file mode 100644 index ea8c009f..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_Help.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Class Trees for Package Help - - - - - - - - - - - - - -
Help
- - - [ class tree: Help ] - [ index: Help ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package Help

-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_LDAP.html b/lam-web/developers/devel/phpdoc/classtrees_LDAP.html deleted file mode 100644 index 9985c30c..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_LDAP.html +++ /dev/null @@ -1,67 +0,0 @@ - - -Class Trees for Package LDAP - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package LDAP

-
-
Root class Ldap

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_PDF.html b/lam-web/developers/devel/phpdoc/classtrees_PDF.html deleted file mode 100644 index 48d55530..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_PDF.html +++ /dev/null @@ -1,76 +0,0 @@ - - -Class Trees for Package PDF - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package PDF

-
-
Root class FPDF

- - -
-
Root class xmlParser

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_configuration.html b/lam-web/developers/devel/phpdoc/classtrees_configuration.html deleted file mode 100644 index 06f984bb..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_configuration.html +++ /dev/null @@ -1,72 +0,0 @@ - - -Class Trees for Package configuration - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package configuration

-
-
Root class LAMCfgMain

- - -
-
Root class LAMConfig

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_lib.html b/lam-web/developers/devel/phpdoc/classtrees_lib.html deleted file mode 100644 index caa1a2f9..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_lib.html +++ /dev/null @@ -1,79 +0,0 @@ - - -Class Trees for Package lib - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package lib

-
-
Root class cache

- - -
-
Root class ObjectClassAttribute

- - -
-
Root class SchemaItem

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_lists.html b/lam-web/developers/devel/phpdoc/classtrees_lists.html deleted file mode 100644 index dc313d45..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_lists.html +++ /dev/null @@ -1,81 +0,0 @@ - - -Class Trees for Package lists - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package lists

-
-
Root class lamList

- - -
-
Root class lamListOption

- - -
-
Root class lamListTool

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_main.html b/lam-web/developers/devel/phpdoc/classtrees_main.html deleted file mode 100644 index c9755174..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_main.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Class Trees for Package main - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package main

-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_modules.html b/lam-web/developers/devel/phpdoc/classtrees_modules.html deleted file mode 100644 index 21403db4..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_modules.html +++ /dev/null @@ -1,89 +0,0 @@ - - -Class Trees for Package modules - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package modules

-
-
Root class accountContainer

- - -
-
Root class baseModule

- - -
-
Root class samba3domain

- - -
-
Root class sambaMungedDial

- - -
-
Root class smbHash

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_profiles.html b/lam-web/developers/devel/phpdoc/classtrees_profiles.html deleted file mode 100644 index 351492bd..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_profiles.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Class Trees for Package profiles - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package profiles

-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_selfService.html b/lam-web/developers/devel/phpdoc/classtrees_selfService.html deleted file mode 100644 index 62ba65e6..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_selfService.html +++ /dev/null @@ -1,67 +0,0 @@ - - -Class Trees for Package selfService - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package selfService

-
-
Root class selfServiceProfile

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_tests.html b/lam-web/developers/devel/phpdoc/classtrees_tests.html deleted file mode 100644 index 2fc48e9c..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_tests.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Class Trees for Package tests - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package tests

-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_tools.html b/lam-web/developers/devel/phpdoc/classtrees_tools.html deleted file mode 100644 index 466e4fb8..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_tools.html +++ /dev/null @@ -1,81 +0,0 @@ - - -Class Trees for Package tools - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package tools

-
-
Root class LAMTool

- - -
-
Root class LdapExportInfo

- - -
-
Root class PlaAbstractExporter

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/classtrees_types.html b/lam-web/developers/devel/phpdoc/classtrees_types.html deleted file mode 100644 index d0ef5b91..00000000 --- a/lam-web/developers/devel/phpdoc/classtrees_types.html +++ /dev/null @@ -1,69 +0,0 @@ - - -Class Trees for Package types - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class Trees for Package types

-
-
Root class baseType

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/configuration/LAMCfgMain.html b/lam-web/developers/devel/phpdoc/configuration/LAMCfgMain.html deleted file mode 100644 index 2a812af2..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/LAMCfgMain.html +++ /dev/null @@ -1,402 +0,0 @@ - - -Docs For Class LAMCfgMain - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Class: LAMCfgMain

-Source Location: /lib/config.inc

- - - - - - - - - - -
- -

Class Overview

-

-
This class manages config.cfg.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 882]
-This class manages config.cfg.



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$allowedHosts =

-

[line 900]

- list of hosts which may access LAM



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$default =

-

[line 885]

- Default profile



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$logDestination =

-

[line 897]

- log destination ("SYSLOG":syslog, "/...":file, "NONE":none)



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$logLevel =

-

[line 894]

- log level



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sessionTimeout =

-

[line 891]

- Time of inactivity before session times out (minutes)



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 909]

-
-
-
- LAMCfgMain __construct( -) -
-

- - Loads preferences from config file



- - -
[ Top ]
-
-
- -

method checkPassword [line 1014]

-
-
-
- boolean checkPassword( -String -$password) -
-

- - Checks if the given password matches.



-

Tags:

-
- - - - - - - -
return:  true, if password matches
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
String  $password  password
-

-
[ Top ]
-
-
- -

method save [line 950]

-
-
-
- void save( -) -
-

- - Saves preferences to config file config.cfg



-

Tags:

-
- - - - -
access:  public
-
-

- - -
[ Top ]
-
-
- -

method setPassword [line 1000]

-
-
-
- void setPassword( -String -$password) -
-

- - Sets a new config password.



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
String  $password  new password
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:22 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/configuration/LAMConfig.html b/lam-web/developers/devel/phpdoc/configuration/LAMConfig.html deleted file mode 100644 index 92570fe1..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/LAMConfig.html +++ /dev/null @@ -1,1442 +0,0 @@ - - -Docs For Class LAMConfig - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Class: LAMConfig

-Source Location: /lib/config.inc

- - - - - - - - - - -
- -

Class Overview

-

-
This class manages .conf files.


- - - - - - - -
-

Constants

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 164]
-This class manages .conf files.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 234]

-
-
-
- LAMConfig __construct( -[integer -$file = 0]) -
-

- - Loads preferences from config file



- - -

Parameters:

-
- - - - - - -
integer  $file  Index number in config file array
-

-
[ Top ]
-
-
- -

method check_Passwd [line 487]

-
-
-
- boolean check_Passwd( -String -$password) -
-

- - Checks if the given password matches.



-

Tags:

-
- - - - - - - -
return:  true, if matches
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
String  $password  
-

-
[ Top ]
-
-
- -

method getAccessLevel [line 861]

-
-
-
- int getAccessLevel( -) -
-

- - Returns the access level for this profile.



-

Tags:

-
- - - - - - - -
return:  level
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getName [line 403]

-
-
-
- String getName( -) -
-

- - Returns the name of the config file



-

Tags:

-
- - - - - - - -
return:  name
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_AccountModules [line 765]

-
-
-
- array get_AccountModules( -string -$scope) -
-

- - Returns an array of all selected account modules



-

Tags:

-
- - - - - - - -
return:  user modules
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_ActiveTypes [line 821]

-
-
-
- array get_ActiveTypes( -) -
-

- - Returns a list of active account types.



-

Tags:

-
- - - - - - - -
return:  list of types
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_Admins [line 453]

-
-
-
- array get_Admins( -) -
-

- - Returns an array of string with all admin names



-

Tags:

-
- - - - - - - -
return:  the admin names
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_Adminstring [line 462]

-
-
-
- string get_Adminstring( -) -
-

- - Returns all admin users seperated by semicolons



-

Tags:

-
- - - - - - - -
return:  the admin string
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_cacheTimeout [line 731]

-
-
-
- integer get_cacheTimeout( -) -
-

- - Returns the LDAP cache timeout in minutes



-

Tags:

-
- - - - - - - -
return:  cache time
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_cacheTimeoutSec [line 741]

-
-
-
- integer get_cacheTimeoutSec( -) -
-

- - Returns the LDAP cache timeout in seconds



-

Tags:

-
- - - - - - - -
return:  cache time
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_defaultLanguage [line 600]

-
-
-
- string get_defaultLanguage( -) -
-

- - Returns the default language string



-

Tags:

-
- - - - - - - -
return:  default language
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_listAttributes [line 574]

-
-
-
- string get_listAttributes( -string -$scope) -
-

- - Returns the list of attributes to show in user list



-

Tags:

-
- - - - - - - -
return:  the attribute list
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_moduleSettings [line 812]

-
-
-
- array get_moduleSettings( -) -
-

- - Returns a list of saved module settings



-

Tags:

-
- - - - - - - -
return:  list of settings: array(name => value)
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_scriptPath [line 621]

-
-
-
- string get_scriptPath( -) -
-

- - Returns the path to the external script



-

Tags:

-
- - - - - - - -
return:  script path
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_scriptRights [line 704]

-
-
-
- string get_scriptRights( -) -
-

- - Returns the chmod value for new home directories.



-

Tags:

-
- - - - - - - -
return:  rights
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_scriptServers [line 643]

-
-
-
- string get_scriptServers( -) -
-

- - Returns the servers of the external script as a Array



-

Tags:

-
- - - - - - - -
return:  script servers
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_ServerURL [line 432]

-
-
-
- string get_ServerURL( -) -
-

- - Returns the server address as string



-

Tags:

-
- - - - - - - -
return:  server address
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_Suffix [line 538]

-
-
-
- string get_Suffix( -string -$scope) -
-

- - Returns the LDAP suffix for the given account type



-

Tags:

-
- - - - - - - -
return:  the LDAP suffix
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_typeSettings [line 852]

-
-
-
- array get_typeSettings( -) -
-

- - Returns a list of saved type settings



-

Tags:

-
- - - - - - - -
return:  list of settings: array(name => value)
access:  public
-
-

- - -
[ Top ]
-
-
- -

method isWritable [line 412]

-
-
-
- boolean isWritable( -) -
-

- - Returns if the file can be written on the filesystem.



-

Tags:

-
- - - - - - - -
return:  true if file is writable
access:  public
-
-

- - -
[ Top ]
-
-
- -

method save [line 307]

-
-
-
- void save( -) -
-

- - Saves preferences to config file



-

Tags:

-
- - - - -
access:  public
-
-

- - -
[ Top ]
-
-
- -

method setAccessLevel [line 870]

-
-
-
- void setAccessLevel( -int -$level) -
-

- - Sets the access level for this profile.



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
int  $level  level
-

-
[ Top ]
-
-
- -

method set_AccountModules [line 781]

-
-
-
- boolean set_AccountModules( -array -$modules, string -$scope) -
-

- - Sets the selected account modules



-

Tags:

-
- - - - - - - -
return:  true if $modules has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
array  $modules  array with module names (not aliases!)
string  $scope  account type
-

-
[ Top ]
-
-
- -

method set_ActiveTypes [line 831]

-
-
-
- void set_ActiveTypes( -array -$types) -
-

- - Sets the list of active types.



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
array  $types  list of types
-

-
[ Top ]
-
-
- -

method set_Adminstring [line 472]

-
-
-
- boolean set_Adminstring( -string -$value) -
-

- - Sets the admin string



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $value  new admin string that contains all admin users seperated by semicolons
-

-
[ Top ]
-
-
- -

method set_cacheTimeout [line 751]

-
-
-
- boolean set_cacheTimeout( -integer -$value) -
-

- - Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
integer  $value  new cache timeout
-

-
[ Top ]
-
-
- -

method set_defaultLanguage [line 610]

-
-
-
- boolean set_defaultLanguage( -string -$value) -
-

- - Sets the default language string



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $value  new default language
-

-
[ Top ]
-
-
- -

method set_listAttributes [line 585]

-
-
-
- boolean set_listAttributes( -string -$value, string -$scope) -
-

- - Sets the list of attributes to show in user list



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
string  $value  new attribute string
string  $scope  account type
-

-
[ Top ]
-
-
- -

method set_moduleSettings [line 801]

-
-
-
- boolean set_moduleSettings( -array -$settings) -
-

- - Sets the settings for the account modules.



-

Tags:

-
- - - - - - - -
return:  true if $settings has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
array  $settings  list of module setting array(name => value)
-

-
[ Top ]
-
-
- -

method set_Passwd [line 507]

-
-
-
- boolean set_Passwd( -string -$value) -
-

- - Sets the preferences wizard password



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $value  new password
-

-
[ Top ]
-
-
- -

method set_scriptPath [line 631]

-
-
-
- boolean set_scriptPath( -string -$value) -
-

- - Sets the path to the external script



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $value  new script path
-

-
[ Top ]
-
-
- -

method set_scriptRights [line 715]

-
-
-
- boolean set_scriptRights( -string -$chmod) -
-

- - Sets the rights for the home directory.



-

Tags:

-
- - - - - - - -
return:  true if values has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $chmod  the rights
-

-
[ Top ]
-
-
- -

method set_scriptServers [line 653]

-
-
-
- boolean set_scriptServers( -string -$value) -
-

- - Sets the servers of the external script



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $value  new script servers
-

-
[ Top ]
-
-
- -

method set_ServerURL [line 442]

-
-
-
- boolean set_ServerURL( -string -$value) -
-

- - Sets the server address



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $value  new server address
-

-
[ Top ]
-
-
- -

method set_Suffix [line 554]

-
-
-
- boolean set_Suffix( -string -$scope, string -$value) -
-

- - Sets the LDAP suffix where accounts are saved



-

Tags:

-
- - - - - - - -
return:  true if $value has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
string  $scope  account type
string  $value  new LDAP suffix
-

-
[ Top ]
-
-
- -

method set_typeSettings [line 841]

-
-
-
- boolean set_typeSettings( -array -$settings) -
-

- - Sets the settings for the account types.



-

Tags:

-
- - - - - - - -
return:  true if $settings has correct format
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
array  $settings  list of type setting array(name => value)
-

-
[ Top ]
-
-

- -
- -

Class Constants

-
- -

-

ACCESS_ALL =  100

-

[line 166]

- -
-
[ Top ]

- -

-

ACCESS_PASSWORD_CHANGE =  20

-

[line 167]

- -
-
[ Top ]

- -

-

ACCESS_READ_ONLY =  0

-

[line 168]

- -
-
[ Top ]

-

- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:22 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/configuration/_lib---config.inc.html b/lam-web/developers/devel/phpdoc/configuration/_lib---config.inc.html deleted file mode 100644 index 1bda0b41..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_lib---config.inc.html +++ /dev/null @@ -1,257 +0,0 @@ - - -Docs for page config.inc - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: config.inc

-Source Location: /lib/config.inc

- -
-
- -
-

Classes:

-
LAMConfig
-
This class manages .conf files.
-
LAMCfgMain
-
This class manages config.cfg.
-


- -

Page Details:

-This file includes functions to manage the configuration files.



-

Tags:

-
- - - - - - - -
author:  Roland Gruber
author:  Thomas Manninger
-
-

-

Includes:

-
-include_once("modules.inc") [line 36]
-Used to get module information.

include_once("status.inc") [line 34]
-Used to print messages.

include_once("types.inc") [line 38]
-Used to get type information.

-

-

-
-
- -

checkChmod [line 66]

-
-
-
- true, checkChmod( -$right $right, $target $target, $chmod $chmod) -
-

- - Checks whether a specific flag in the rights string is set.



-

Tags:

-
- - - - -
return:  if the chmod $right for $target were set
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
$right  $right  read,write or execute
$target  $target  owner,group or other
$chmod  $chmod  the chmod rights
-
[ Top ]


-
-
- -

getConfigProfiles [line 102]

-
-
-
- array getConfigProfiles( -) -
-

- - Returns an array of string with all available configuration profiles (without .conf)



-

Tags:

-
- - - - -
return:  profile names
-
-

- -
[ Top ]


-
-
- -

LAMVersion [line 126]

-
-
-
- string LAMVersion( -) -
-

- - Returns the version number of this LAM installation.

Format: <major version>.<minor version>.<patch level>
Major/minor version are always numbers, patch level may contain letters for inofficial releases only (e.g. 0.5.alpha1).




-

Tags:

-
- - - - -
return:  version number
-
-

- -
[ Top ]


-
-
- -

metaRefresh [line 144]

-
-
-
- void metaRefresh( -string $page) -
-

- - Prints a meta refresh page



- -

Parameters

- - - - - - -
string  $page  the URL of the target page
-
[ Top ]


-
-
- -

setlanguage [line 43]

-
-
-
- void setlanguage( -) -
-

- - Sets language settings for automatic translation



- -
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:22 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/configuration/_templates---config---conflogin.php.html b/lam-web/developers/devel/phpdoc/configuration/_templates---config---conflogin.php.html deleted file mode 100644 index c91667e9..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_templates---config---conflogin.php.html +++ /dev/null @@ -1,118 +0,0 @@ - - -Docs for page conflogin.php - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: conflogin.php

-Source Location: /templates/config/conflogin.php

- -
-
- - -

Page Details:

-Login page to change the preferences.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/config.inc') [line 34]
-Access to config functions

include_once('../../lib/status.inc') [line 36]
-Used to print status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/configuration/_templates---config---confmain.php.html b/lam-web/developers/devel/phpdoc/configuration/_templates---config---confmain.php.html deleted file mode 100644 index f6352b5e..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_templates---config---confmain.php.html +++ /dev/null @@ -1,138 +0,0 @@ - - -Docs for page confmain.php - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: confmain.php

-Source Location: /templates/config/confmain.php

- -
-
- - -

Page Details:

-Main page of configuration



-

Tags:

-
- - - - - - - -
author:  Roland Gruber
author:  Thomas Manninger
-
-

-

Includes:

-
-include_once("../../lib/config.inc") [line 35]
-Access to config functions

include_once("../../lib/modules.inc") [line 38]
-access to module settings

require('conflogin.php') [line 72]
-go back to login if password is invalid

require('conflogin.php') [line 54]
-go back to login if password is empty

-

-

-
-
- -

saveSettings [line 481]

-
-
-
- void saveSettings( -) -
-

- - Saves the entered settings.



- -
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/configuration/_templates---config---confmodules.php.html b/lam-web/developers/devel/phpdoc/configuration/_templates---config---confmodules.php.html deleted file mode 100644 index 62754482..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_templates---config---confmodules.php.html +++ /dev/null @@ -1,156 +0,0 @@ - - -Docs for page confmodules.php - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: confmodules.php

-Source Location: /templates/config/confmodules.php

- -
-
- - -

Page Details:

-confmodules lets the user select the account modules



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/config.inc') [line 34]
-Access to config functions

include_once('../../lib/modules.inc') [line 36]
-Access to module lists

require('conflogin.php') [line 49]
-go back to login if password is invalid

-

-

-
-
- -

config_showAccountModules [line 139]

-
-
-
- boolean config_showAccountModules( -string $scope, string $title) -
-

- - Displays the module selection boxes and checks if dependencies are fulfilled.



-

Tags:

-
- - - - -
return:  true if all dependencies are ok
-
-

- -

Parameters

- - - - - - - - - - - -
string  $scope  account type
string  $title  title for module selection (e.g. "User modules")
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/configuration/_templates---config---conftypes.php.html b/lam-web/developers/devel/phpdoc/configuration/_templates---config---conftypes.php.html deleted file mode 100644 index f9e531e2..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_templates---config---conftypes.php.html +++ /dev/null @@ -1,119 +0,0 @@ - - -Docs for page conftypes.php - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: conftypes.php

-Source Location: /templates/config/conftypes.php

- -
-
- - -

Page Details:

-Here the user can select the account types.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/config.inc') [line 34]
-Access to config functions

include_once('../../lib/types.inc') [line 36]
-Access to account types

require('conflogin.php') [line 48]
-go back to login if password is invalid

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/configuration/_templates---config---index.php.html b/lam-web/developers/devel/phpdoc/configuration/_templates---config---index.php.html deleted file mode 100644 index 6bdff4c4..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_templates---config---index.php.html +++ /dev/null @@ -1,117 +0,0 @@ - - -Docs for page index.php - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: index.php

-Source Location: /templates/config/index.php

- -
-
- - -

Page Details:

-Displays links to all configuration pages.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/config.inc') [line 34]
-Access to config functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:33 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/configuration/_templates---config---mainlogin.php.html b/lam-web/developers/devel/phpdoc/configuration/_templates---config---mainlogin.php.html deleted file mode 100644 index 67905703..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_templates---config---mainlogin.php.html +++ /dev/null @@ -1,118 +0,0 @@ - - -Docs for page mainlogin.php - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: mainlogin.php

-Source Location: /templates/config/mainlogin.php

- -
-
- - -

Page Details:

-Login page to change the main preferences.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/config.inc') [line 34]
-Access to config functions

include_once('../../lib/status.inc') [line 36]
-Used to print status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:41 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/configuration/_templates---config---mainmanage.php.html b/lam-web/developers/devel/phpdoc/configuration/_templates---config---mainmanage.php.html deleted file mode 100644 index 665a158f..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_templates---config---mainmanage.php.html +++ /dev/null @@ -1,119 +0,0 @@ - - -Docs for page mainmanage.php - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: mainmanage.php

-Source Location: /templates/config/mainmanage.php

- -
-
- - -

Page Details:

-Manages the main configuration options.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/config.inc') [line 34]
-Access to config functions

include_once('../../lib/status.inc') [line 36]
-Used to print status messages

require('mainlogin.php') [line 48]
-
-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:41 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/configuration/_templates---config---profmanage.php.html b/lam-web/developers/devel/phpdoc/configuration/_templates---config---profmanage.php.html deleted file mode 100644 index e583f4d6..00000000 --- a/lam-web/developers/devel/phpdoc/configuration/_templates---config---profmanage.php.html +++ /dev/null @@ -1,118 +0,0 @@ - - -Docs for page profmanage.php - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: profmanage.php

-Source Location: /templates/config/profmanage.php

- -
-
- - -

Page Details:

-Configuration profile management.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/config.inc') [line 34]
-Access to config functions

include_once('../../lib/status.inc') [line 36]
-Used to print status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/elementindex.html b/lam-web/developers/devel/phpdoc/elementindex.html deleted file mode 100644 index b46f1b8c..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex.html +++ /dev/null @@ -1,2585 +0,0 @@ - - -Element Index - - - - - - - - - - - - - -
- - [ all elements ] -
- - - - - - -
-
- - -

Index of all elements

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ h ] - [ i ] - [ k ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ q ] - [ r ] - [ s ] - [ t ] - [ u ] - [ v ] - [ w ] - [ x ] - [ y ] - [ z ] - [ _ ] - -
- -
-

a

-
-
$aliases
-
in file schema.inc, variable AttributeType::$aliases
    An array of alias attribute names, strings
-
$AliasNbPages
-
in file fpdf.php, variable FPDF::$AliasNbPages
-
$allowedHosts
-
in file config.inc, variable LAMCfgMain::$allowedHosts
    list of hosts which may access LAM
-
$attrArray
-
in file lists.inc, variable lamList::$attrArray
    list of LDAP attributes
-
$attributes
-
in file modules.inc, variable accountContainer::$attributes
    Array of all used attributes
-
$attributes
-
in file export.inc, variable PlaLdapExporter::$attributes
-
$attributes
-
in file baseModule.inc, variable baseModule::$attributes
    contains all ldap attributes which should be written
-
$attributes_orig
-
in file modules.inc, variable accountContainer::$attributes_orig
    original LDAP attributes when account was loaded from LDAP
-
$author
-
in file fpdf.php, variable FPDF::$author
-
$autoAddObjectClasses
-
in file baseModule.inc, variable baseModule::$autoAddObjectClasses
    if true, managed object classes are added when an account is created or loaded (default: true)
-
$AutoPageBreak
-
in file fpdf.php, variable FPDF::$AutoPageBreak
-
AcceptPageBreak
-
in file fpdf.php, method FPDF::AcceptPageBreak()
-
AcceptPageBreak
-
in file ufpdf.php, method UFPDF::AcceptPageBreak()
-
ACCESS_ALL
-
in file config.inc, class constant LAMConfig::ACCESS_ALL
-
ACCESS_PASSWORD_CHANGE
-
in file config.inc, class constant LAMConfig::ACCESS_PASSWORD_CHANGE
-
ACCESS_READ_ONLY
-
in file config.inc, class constant LAMConfig::ACCESS_READ_ONLY
-
account
-
in file account.inc, class account
    Manages the object class "account" for users and hosts.
-
accountContainer
-
in file modules.inc, class accountContainer
    This class includes all modules and attributes of an account.
-
addAlias
-
in file schema.inc, method AttributeType::addAlias()
    Adds an attribute name to the alias array.
-
addChildObjectClass
-
in file schema.inc, method ObjectClass::addChildObjectClass()
    Adds an objectClass to the list of objectClasses that inherit from this objectClass.
-
AddFont
-
in file ufpdf.php, method UFPDF::AddFont()
-
AddFont
-
in file fpdf.php, method FPDF::AddFont()
-
AddLink
-
in file fpdf.php, method FPDF::AddLink()
-
addMayAttrs
-
in file schema.inc, method ObjectClass::addMayAttrs()
    Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.
-
addMustAttrs
-
in file schema.inc, method ObjectClass::addMustAttrs()
    Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
-
AddPage
-
in file fpdf.php, method FPDF::AddPage()
-
addRequiredByObjectClass
-
in file schema.inc, method AttributeType::addRequiredByObjectClass()
    Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.
-
addUsedByAttr
-
in file schema.inc, method MatchingRule::addUsedByAttr()
    Adds an attribute name to the list of attributes who use this MatchingRule
-
addUsedInObjectClass
-
in file schema.inc, method AttributeType::addUsedInObjectClass()
    Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
-
add_aliases_to_attrs
-
in file schema.inc, function add_aliases_to_attrs()
    For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.
-
add_cache
-
in file cache.inc, method cache::add_cache()
    This function adds attributes to the cache.
-
add_sup_to_attrs
-
in file schema.inc, function add_sup_to_attrs()
    Adds inherited values to each attributeType specified by the SUP directive.
-
AliasNbPages
-
in file ufpdf.php, method UFPDF::AliasNbPages()
-
AliasNbPages
-
in file fpdf.php, method FPDF::AliasNbPages()
-
arrayLower
-
in file tree.inc, function arrayLower()
-
array_delete
-
in file account.inc, function array_delete()
    This function will return all values from $array without values of $values.
-
array_stripslashes
-
in file tree.inc, function array_stripslashes()
    Strips all slashes from the specified array in place (pass by ref).
-
AttributeType
-
in file schema.inc, method AttributeType::AttributeType()
    Creates a new AttributeType objcet from a raw LDAP AttributeType string.
-
AttributeType
-
in file schema.inc, class AttributeType
    Represents an LDAP AttributeType
-
account.inc
-
procedural page account.inc
-
account.inc
-
procedural page account.inc
-
add_attr.php
-
procedural page add_attr.php
-
add_attr_form.php
-
procedural page add_attr_form.php
-
add_oclass.php
-
procedural page add_oclass.php
-
add_oclass_form.php
-
procedural page add_oclass_form.php
-
add_value.php
-
procedural page add_value.php
-
add_value_form.php
-
procedural page add_value_form.php
-
-
- top
-
- -
-

b

-
-
$base_dn
-
in file export.inc, variable LdapExportInfo::$base_dn
-
$bMargin
-
in file fpdf.php, variable FPDF::$bMargin
-
$br
-
in file export.inc, variable PlaExporter::$br
-
$buffer
-
in file fpdf.php, variable FPDF::$buffer
-
baseModule
-
in file baseModule.inc, class baseModule
    Parent class of all account modules.
-
baseType
-
in file baseType.inc, class baseType
    This is the parent class of all account types.
-
buildUploadAccounts
-
in file modules.inc, function buildUploadAccounts()
    This function builds the LDAP accounts for the file upload.
-
build_initial_tree_icons
-
in file tree.inc, function build_initial_tree_icons()
    Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned
-
build_uploadAccounts
-
in file posixGroup.inc, method posixGroup::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file posixAccount.inc, method posixAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file sambaAccount.inc, method sambaAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file shadowAccount.inc, method shadowAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file nisMailAlias.inc, method nisMailAlias::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file sambaSamAccount.inc, method sambaSamAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file sambaGroupMapping.inc, method sambaGroupMapping::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file sambaDomain.inc, method sambaDomain::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file inetOrgPerson.inc, method inetOrgPerson::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file ieee802device.inc, method ieee802Device::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file baseModule.inc, method baseModule::build_uploadAccounts()
    In this function the LDAP accounts are built.
-
build_uploadAccounts
-
in file ldapPublicKey.inc, method ldapPublicKey::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file kolabUser.inc, method kolabUser::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file account.inc, method account::build_uploadAccounts()
    In this function the LDAP account is built up.
-
baseModule.inc
-
procedural page baseModule.inc
-
baseType.inc
-
procedural page baseType.inc
-
-
- top
-
- -
-

c

-
-
$children_objectclasses
-
in file schema.inc, variable ObjectClass::$children_objectclasses
    array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)
-
$cMargin
-
in file fpdf.php, variable FPDF::$cMargin
-
$ColorFlag
-
in file fpdf.php, variable FPDF::$ColorFlag
-
$compress
-
in file fpdf.php, variable FPDF::$compress
-
$CoreFonts
-
in file fpdf.php, variable FPDF::$CoreFonts
-
$counter
-
in file export.inc, variable PlaLdifExporter::$counter
-
$counter
-
in file export.inc, variable PlaDsmlExporter::$counter
-
$creator
-
in file fpdf.php, variable FPDF::$creator
-
$ctx
-
in file sambaMungedDial.inc, variable sambaMungedDial::$ctx
-
$ctxattributes
-
in file sambaMungedDial.inc, variable sambaMungedDial::$ctxattributes
-
$CurOrientation
-
in file fpdf.php, variable FPDF::$CurOrientation
-
$CurrentFont
-
in file fpdf.php, variable FPDF::$CurrentFont
-
cache
-
in file cache.inc, class cache
    This class contains all functions which are needed to manage the LDAP cache.
-
cached_schema_available
-
in file schema.inc, function cached_schema_available()
    Returns true if the schema for $schema_type has been cached and
-
can_manage
-
in file baseModule.inc, method baseModule::can_manage()
    Returns true if this module can manage accounts of the current type, otherwise false.
-
Cell
-
in file ufpdf.php, method UFPDF::Cell()
-
Cell
-
in file fpdf.php, method FPDF::Cell()
-
checkASCII
-
in file posixAccount.inc, method posixAccount::checkASCII()
    Checks if an attribute contains only ASCII charaters and replaces invalid characters.
-
checkChmod
-
in file config.inc, function checkChmod()
    Checks whether a specific flag in the rights string is set.
-
checkClientIP
-
in file security.inc, function checkClientIP()
    Checks if the client's IP address is on the list of allowed IPs.
-
checkConfigOptions
-
in file modules.inc, function checkConfigOptions()
    Checks if the configuration options are valid
-
checkIfPasswordChangeIsAllowed
-
in file security.inc, function checkIfPasswordChangeIsAllowed()
    Checks if passwords may be changed.
-
checkIfWriteAccessIsAllowed
-
in file security.inc, function checkIfWriteAccessIsAllowed()
    Checks if write access to LDAP is allowed.
-
checkPassword
-
in file config.inc, method LAMCfgMain::checkPassword()
    Checks if the given password matches.
-
checkProfileOptions
-
in file modules.inc, function checkProfileOptions()
    Checks if the profile options are valid
-
checkSchemaForModule
-
in file schemaTest.php, function checkSchemaForModule()
    Checks if the object classes and attributes for this module are available.
-
checkSelfServiceOptions
-
in file baseModule.inc, method baseModule::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP attributes which should be changed.
-
checkSelfServiceOptions
-
in file sambaSamAccount.inc, method sambaSamAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file selfService.inc, function checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file posixAccount.inc, method posixAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file inetOrgPerson.inc, method inetOrgPerson::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceSettings
-
in file selfService.inc, function checkSelfServiceSettings()
    Checks if the self service settings are valid
-
checkSelfServiceSettings
-
in file baseModule.inc, method baseModule::checkSelfServiceSettings()
    Checks if the self service settings are valid.
-
check_configOptions
-
in file baseModule.inc, method baseModule::check_configOptions()
    Checks input values of module settings.
-
check_configOptions
-
in file posixAccount.inc, method posixAccount::check_configOptions()
    Checks input values of module settings.
-
check_module_conflicts
-
in file modules.inc, function check_module_conflicts()
    Checks if there are conflicts between modules
-
check_module_depends
-
in file modules.inc, function check_module_depends()
    Checks if there are missing dependencies between modules.
-
check_Passwd
-
in file config.inc, method LAMConfig::check_Passwd()
    Checks if the given password matches.
-
check_profileOptions
-
in file quota.inc, method quota::check_profileOptions()
    Checks input values of account profiles.
-
check_profileOptions
-
in file baseModule.inc, method baseModule::check_profileOptions()
    Checks input values of account profiles.
-
Close
-
in file fpdf.php, method FPDF::Close()
-
close
-
in file ldap.inc, method Ldap::close()
    Closes connection to server
-
cmp_array
-
in file ldap.inc, method Ldap::cmp_array()
    Helper function to sort the unit DNs
-
cmp_array
-
in file lists.inc, method lamList::cmp_array()
    Compare function used for usort-method
-
cmp_domain
-
in file account.inc, function cmp_domain()
    Helper function to sort the domains
-
code2utf
-
in file ufpdf.php, method UFPDF::code2utf()
-
config_showAccountModules
-
in file confmodules.php, function config_showAccountModules()
    Displays the module selection boxes and checks if dependencies are fulfilled.
-
connect
-
in file ldap.inc, method Ldap::connect()
    Connects to the server using the given username and password
-
continue_main
-
in file modules.inc, method accountContainer::continue_main()
    This function is called when the user clicks on any button on the account pages.
-
createModulePDF
-
in file pdf.inc, function createModulePDF()
    This function creates the PDF output of one or more accounts. At the moment this function can create a PDF page for user, group and host accounts. But this is not limited by the function itself but by the account types that are allowed in LAM and the exsisting PDF structure definitions.
-
cache.inc
-
procedural page cache.inc
-
config.inc
-
procedural page config.inc
-
createntlm.inc
-
procedural page createntlm.inc
-
conflogin.php
-
procedural page conflogin.php
-
confmain.php
-
procedural page confmain.php
-
confmodules.php
-
procedural page confmodules.php
-
conftypes.php
-
procedural page conftypes.php
-
collapse.php
-
procedural page collapse.php
-
create.php
-
procedural page create.php
-
create_form.php
-
procedural page create_form.php
-
creation_template.php
-
procedural page creation_template.php
-
custom.php
-
procedural page custom.php
-
conf-main-test.php
-
procedural page conf-main-test.php
-
conf-test.php
-
procedural page conf-test.php
-
-
- top
-
- -
-

d

-
-
$default
-
in file config.inc, variable LAMCfgMain::$default
    Default profile
-
$DefOrientation
-
in file fpdf.php, variable FPDF::$DefOrientation
-
$deliveryAddress
-
in file export.inc, variable PlaVcardExporter::$deliveryAddress
-
$descArray
-
in file lists.inc, variable lamList::$descArray
    list of attribute descriptions
-
$description
-
in file schema.inc, variable SchemaItem::$description
    The description of this schema item.
-
$description
-
in file tools.php, variable LAMTool::$description
    description text
-
$diffs
-
in file fpdf.php, variable FPDF::$diffs
-
$dn
-
in file modules.inc, variable accountContainer::$dn
    DN suffix of the account
-
$dn
-
in file account.inc, variable samba3domain::$dn
    DN
-
$dn_orig
-
in file modules.inc, variable accountContainer::$dn_orig
    DN suffix of account when it was loaded
-
$DrawColor
-
in file fpdf.php, variable FPDF::$DrawColor
-
decode_munged
-
in file sambaMungedDial.inc, method sambaMungedDial::decode_munged()
    Takes a base64-encoded MungedDial-String and returns an array of included parameters and values
-
decrypt
-
in file ldap.inc, method Ldap::decrypt()
    Decrypts a string
-
decrypt_login
-
in file ldap.inc, method Ldap::decrypt_login()
    Decrypts username and password
-
delAccountProfile
-
in file profiles.inc, function delAccountProfile()
    Deletes an account profile
-
deleteDN
-
in file delete.php, function deleteDN()
    Deletes a DN and all child entries.
-
deletePDFStructureDefinition
-
in file pdfstruct.inc, function deletePDFStructureDefinition()
    Deletes XML file with PDF structure definitions.
-
delete_attributes
-
in file posixAccount.inc, method posixAccount::delete_attributes()
    Additional LDAP operations on delete.
-
delete_attributes
-
in file posixGroup.inc, method posixGroup::delete_attributes()
    Checks if the group which should be deleted is still used as primary group.
-
delete_attributes
-
in file baseModule.inc, method baseModule::delete_attributes()
    This function returns an array with the same syntax as save_attributes().
-
destroy
-
in file ldap.inc, method Ldap::destroy()
    Closes connection to LDAP server and deletes encrypted username/password
-
displayExportInfo
-
in file export.inc, method PlaLdifExporter::displayExportInfo()
-
displayHelp
-
in file help.php, function displayHelp()
    Print help site for a specific help number.
-
display_html_attributes
-
in file nisMailAlias.inc, method nisMailAlias::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file sambaAccount.inc, method sambaAccount::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file baseModule.inc, method baseModule::display_html_attributes()
    This function creates meta HTML code to display the module page.
-
display_html_attributes
-
in file shadowAccount.inc, method shadowAccount::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.
-
display_html_attributes
-
in file sambaGroupMapping.inc, method sambaGroupMapping::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file sambaDomain.inc, method sambaDomain::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file quota.inc, method quota::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file account.inc, method account::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file posixGroup.inc, method posixGroup::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file posixAccount.inc, method posixAccount::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file kolabUser.inc, method kolabUser::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file inetOrgPerson.inc, method inetOrgPerson::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file ldapPublicKey.inc, method ldapPublicKey::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file ieee802device.inc, method ieee802Device::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_delete
-
in file baseModule.inc, method baseModule::display_html_delete()
    This function creates meta HTML code which will be displayed when an account should be deleted.
-
display_html_delete
-
in file posixAccount.inc, method posixAccount::display_html_delete()
    Displays the delete homedir option for the delete page.
-
display_html_deleteUser
-
in file kolabUser.inc, method kolabUser::display_html_deleteUser()
    This function will create the meta HTML code to show a page to delete accounts.
-
display_html_expire
-
in file shadowAccount.inc, method shadowAccount::display_html_expire()
    This function will create the meta HTML code to show a page with the expiration date.
-
display_html_group
-
in file posixAccount.inc, method posixAccount::display_html_group()
    Displays the group selection.
-
display_html_logonHours
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_logonHours()
    This function will create the HTML page to edit logon hours.
-
display_html_password
-
in file posixGroup.inc, method posixGroup::display_html_password()
    Displays the password changing dialog.
-
display_html_password
-
in file inetOrgPerson.inc, method inetOrgPerson::display_html_password()
    Displays the password changing dialog.
-
display_html_password
-
in file posixAccount.inc, method posixAccount::display_html_password()
    Displays the password changing dialog.
-
display_html_photo
-
in file inetOrgPerson.inc, method inetOrgPerson::display_html_photo()
    Displays the photo upload page.
-
display_html_sambaUserWorkstations
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_sambaUserWorkstations()
    This function will create the HTML page to edit the allowed workstations.
-
display_html_terminalServer
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_terminalServer()
    This function will create the HTML page to edit the terminal server options.
-
display_html_time
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_time()
    This function will create the meta HTML code to show a page to change time values.
-
display_html_user
-
in file posixGroup.inc, method posixGroup::display_html_user()
    Displays selections to add or remove users from current group.
-
display_html_userWorkstations
-
in file sambaAccount.inc, method sambaAccount::display_html_userWorkstations()
    This function will create the HTML page to edit the allowed workstations.
-
display_LoginPage
-
in file login.php, function display_LoginPage()
    Displays the login window.
-
display_main
-
in file ou_edit.php, function display_main()
-
dn_exists
-
in file tree.inc, function dn_exists()
    Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.
-
doHash
-
in file createntlm.inc, method smbHash::doHash()
-
doUploadPostActions
-
in file quota.inc, method quota::doUploadPostActions()
    This function executes one post upload action.
-
doUploadPostActions
-
in file baseModule.inc, method baseModule::doUploadPostActions()
    This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
-
doUploadPostActions
-
in file modules.inc, function doUploadPostActions()
    This function executes one post upload action.
-
doUploadPostActions
-
in file posixAccount.inc, method posixAccount::doUploadPostActions()
    This function executes one post upload action.
-
draw_create_link
-
in file tree.php, function draw_create_link()
-
draw_formatted_dn
-
in file tree.inc, function draw_formatted_dn()
    Gets a DN string using the user-configured tree_display_format string to format it.
-
draw_jpeg_photos
-
in file tree.inc, function draw_jpeg_photos()
    Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.
-
draw_server_tree
-
in file tree.inc, function draw_server_tree()
    Prints the HTML of the tree view.
-
draw_tree_html
-
in file tree.php, function draw_tree_html()
    Recursively descend on the given dn and draw the tree in html
-
delete.php
-
procedural page delete.php
-
deletelink.php
-
procedural page deletelink.php
-
delete.php
-
procedural page delete.php
-
delete_attr.php
-
procedural page delete_attr.php
-
delete_form.php
-
procedural page delete_form.php
-
download_binary_attr.php
-
procedural page download_binary_attr.php
-
-
- top
-
- -
-

e

-
-
$entries
-
in file lists.inc, variable lamList::$entries
    LDAP entries
-
$entry_array
-
in file export.inc, variable PlaLdapExporter::$entry_array
-
$entry_id
-
in file export.inc, variable PlaLdapExporter::$entry_id
-
$equality
-
in file schema.inc, variable AttributeType::$equality
    The equality rule used
-
$escapeCode
-
in file export.inc, variable PlaCSVExporter::$escapeCode
-
$exporter
-
in file export.inc, variable PlaExporter::$exporter
-
echoHTMLFoot
-
in file help.php, function echoHTMLFoot()
    Print HTML footer of the help page.
-
echoHTMLHead
-
in file help.php, function echoHTMLHead()
    Print HTML header of the help page.
-
encode_munged
-
in file sambaMungedDial.inc, method sambaMungedDial::encode_munged()
    Encode full MungedDial-String
-
encrypt
-
in file ldap.inc, method Ldap::encrypt()
    Encrypts a string
-
encrypt_login
-
in file ldap.inc, method Ldap::encrypt_login()
    Encrypts username and password
-
endian
-
in file sambaMungedDial.inc, method sambaMungedDial::endian()
    endian
-
Error
-
in file fpdf.php, method FPDF::Error()
-
export
-
in file export.inc, method PlaLdifExporter::export()
    Export entries to ldif format
-
export
-
in file export.inc, method PlaCSVExporter::export()
-
export
-
in file export.inc, method MyCustomExporter::export()
    When doing an exporter, the method export need to be overriden.
-
export
-
in file export.inc, method PlaExporter::export()
    Abstract method use to export data.
-
export
-
in file export.inc, method PlaDsmlExporter::export()
    Export the entries to DSML
-
export
-
in file export.inc, method PlaVcardExporter::export()
    When doing an exporter, the method export need to be overriden.
-
export.inc
-
procedural page export.inc
-
edit.php
-
procedural page edit.php
-
edit.php
-
procedural page edit.php
-
expand.php
-
procedural page expand.php
-
export.php
-
procedural page export.php
-
export_form.php
-
procedural page export_form.php
-
-
- top
-
- -
-

f

-
-
$fh
-
in file fpdf.php, variable FPDF::$fh
-
$fhPt
-
in file fpdf.php, variable FPDF::$fhPt
-
$FillColor
-
in file fpdf.php, variable FPDF::$FillColor
-
$filterText
-
in file lists.inc, variable lamList::$filterText
    filter string to include in URL
-
$FontFamily
-
in file fpdf.php, variable FPDF::$FontFamily
-
$FontFiles
-
in file fpdf.php, variable FPDF::$FontFiles
-
$fonts
-
in file fpdf.php, variable FPDF::$fonts
-
$FontSize
-
in file fpdf.php, variable FPDF::$FontSize
-
$FontSizePt
-
in file fpdf.php, variable FPDF::$FontSizePt
-
$FontStyle
-
in file fpdf.php, variable FPDF::$FontStyle
-
$fw
-
in file fpdf.php, variable FPDF::$fw
-
$fwPt
-
in file fpdf.php, variable FPDF::$fwPt
-
fillFromPostData
-
in file lists.inc, method lamBooleanListOption::fillFromPostData()
    Fills the config option from POST data.
-
fillFromPostData
-
in file lists.inc, method lamSelectListOption::fillFromPostData()
    Fills the config option from POST data.
-
fillFromPostData
-
in file lists.inc, method lamListOption::fillFromPostData()
    Fills the config option from POST data.
-
findgroups
-
in file cache.inc, method cache::findgroups()
    This function returns an array with all group names which were found in the LDAP directory.
-
fixLDAPAttributes
-
in file modules.inc, method accountContainer::fixLDAPAttributes()
    Fixes spelling errors in the attribute names.
-
Footer
-
in file fpdf.php, method FPDF::Footer()
-
footer
-
in file lamPDF.inc, method lamPDF::footer()
-
FPDF
-
in file fpdf.php, method FPDF::FPDF()
    *****************************************************************************
-
FPDF
-
in file fpdf.php, class FPDF
    Main FPDF class for creating PDF documents
-
FPDF_VERSION
-
in file fpdf.php, constant FPDF_VERSION
    *****************************************************************************
-
fpdf.php
-
procedural page fpdf.php
-
-
- top
-
- -
-

g

-
-
generateRandomPassword
-
in file account.inc, function generateRandomPassword()
    Generates a random password with 12 digits.
-
genTime
-
in file sambaMungedDial.inc, method sambaMungedDial::genTime()
    genTime
-
getAccessLevel
-
in file config.inc, method LAMConfig::getAccessLevel()
    Returns the access level for this profile.
-
getAccountContainer
-
in file baseModule.inc, method baseModule::getAccountContainer()
    Returns the accountContainer object.
-
getAccountModule
-
in file modules.inc, method accountContainer::getAccountModule()
    Returns the account module with the given class name
-
getAccountModules
-
in file modules.inc, method accountContainer::getAccountModules()
    Returns the included account modules.
-
getAccountProfiles
-
in file profiles.inc, function getAccountProfiles()
    Returns an array of string with all available profiles for the given account type
-
getAdditionalTools
-
in file user.inc, method lamUserList::getAdditionalTools()
    Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
getAdditionalTools
-
in file lists.inc, method lamList::getAdditionalTools()
    Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
getAlias
-
in file group.inc, method group::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file host.inc, method host::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file smbDomain.inc, method smbDomain::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file user.inc, method user::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file mailAlias.inc, method mailAlias::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file baseType.inc, method baseType::getAlias()
    Returns the alias name of this account type.
-
getAliases
-
in file schema.inc, method AttributeType::getAliases()
    Gets the names of attributes that are an alias for this attribute (if any).
-
getAttributes
-
in file baseModule.inc, method baseModule::getAttributes()
    Returns the LDAP attributes which are managed in this module.
-
getAvailableLogos
-
in file pdfstruct.inc, function getAvailableLogos()
    This function returns an array with all aviliable logo images.
-
getAvailableModules
-
in file modules.inc, function getAvailableModules()
    Returns an array with all available user module names
-
getAvailablePDFFields
-
in file modules.inc, function getAvailablePDFFields()
    Returns a list of available PDF entries.
-
getBrokenConn
-
in file sambaMungedDial.inc, method sambaMungedDial::getBrokenConn()
    gets Broken-Connection value: disconnect/reset
-
getButtonStatus
-
in file baseModule.inc, method baseModule::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getButtonStatus
-
in file inetOrgPerson.inc, method inetOrgPerson::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getButtonStatus
-
in file account.inc, method account::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getButtonStatus
-
in file nisMailAlias.inc, method nisMailAlias::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getButtonStatus
-
in file posixGroup.inc, method posixGroup::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getChildCount
-
in file delete.php, function getChildCount()
    Returns the number of child entries of a DN.
-
getChildObjectClasses
-
in file schema.inc, method ObjectClass::getChildObjectClasses()
    Returns the array of objectClass names which inherit from this objectClass.
-
getClearTextPassword
-
in file posixAccount.inc, method posixAccount::getClearTextPassword()
    Returns the clear text password.
-
getConfigOptions
-
in file modules.inc, function getConfigOptions()
    Returns a hash array (module name => elements) of all module options for the configuration page.
-
getConfigProfiles
-
in file config.inc, function getConfigProfiles()
    Returns an array of string with all available configuration profiles (without .conf)
-
getConnectClientDrives
-
in file sambaMungedDial.inc, method sambaMungedDial::getConnectClientDrives()
    gets connect-client-drive-at-logon value: enabled/disabled
-
getConnectClientPrinters
-
in file sambaMungedDial.inc, method sambaMungedDial::getConnectClientPrinters()
    gets connect-client-printers-at-logon value: enabled/disabled
-
getCtxMaxConnectionTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxConnectionTimeF()
    SMARTY: gets the checkbox state of "Connection"
-
getCtxMaxDisconnectionTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxDisconnectionTimeF()
    SMARTY: gets the checkbox state of "Disconnection"
-
getCtxMaxIdleTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxIdleTimeF()
    SMARTY: gets the checkbox state of "Idle"
-
getdays
-
in file account.inc, function getdays()
    This function will return the days from 1.1.1970 until now.
-
getDefaultListAttributes
-
in file user.inc, method user::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file group.inc, method group::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file host.inc, method host::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file smbDomain.inc, method smbDomain::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file types.inc, function getDefaultListAttributes()
    Returns the default attribute list for an account type.
-
getDefaultListAttributes
-
in file mailAlias.inc, method mailAlias::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file baseType.inc, method baseType::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultPrinter
-
in file sambaMungedDial.inc, method sambaMungedDial::getDefaultPrinter()
    gets set-client-printer-to-default value: enabled/disabled
-
getDescription
-
in file user.inc, method user::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file schema.inc, method SchemaItem::getDescription()
-
getDescription
-
in file host.inc, method host::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file smbDomain.inc, method smbDomain::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file group.inc, method group::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file mailAlias.inc, method mailAlias::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file baseType.inc, method baseType::getDescription()
    Returns the description of this account type.
-
getEquality
-
in file schema.inc, method AttributeType::getEquality()
    Gets this attribute's equality string
-
getgid
-
in file cache.inc, method cache::getgid()
    This function will return the GID number to an existing group name (using the cache).
-
getgrnam
-
in file cache.inc, method cache::getgrnam()
    This function returns the group name to an existing gidNumber.
-
getHelp
-
in file modules.inc, function getHelp()
    Returns a help entry from an account module.
-
getIcon
-
in file baseModule.inc, method baseModule::getIcon()
    Returns the path to the module icon.
-
getID
-
in file lists.inc, method lamListOption::getID()
    Returns the option ID.
-
getImage
-
in file lists.inc, method lamListTool::getImage()
    Returns the name of the tool image.
-
getInheritMode
-
in file sambaMungedDial.inc, method sambaMungedDial::getInheritMode()
    gets Inherit-config-from-client value: enabled/disabled
-
getIsCollective
-
in file schema.inc, method AttributeType::getIsCollective()
    Gets whether this attribute is collective.
-
getIsNoUserModification
-
in file schema.inc, method AttributeType::getIsNoUserModification()
    Gets whether this attribute is not modifiable by users.
-
getIsObsolete
-
in file schema.inc, method ObjectClass::getIsObsolete()
    Gets whether this objectClass is flagged as obsolete by the LDAP server.
-
getIsObsolete
-
in file schema.inc, method MatchingRule::getIsObsolete()
    Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
-
getIsObsolete
-
in file schema.inc, method AttributeType::getIsObsolete()
    Gets whether this attribute has been flagged as obsolete by the LDAP server
-
getIsSingleValue
-
in file schema.inc, method AttributeType::getIsSingleValue()
    Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
-
getLDAPAliases
-
in file baseModule.inc, method baseModule::getLDAPAliases()
    Returns a list of aliases for LDAP attributes.
-
getLinkTarget
-
in file lists.inc, method lamListTool::getLinkTarget()
    Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.
-
getListAttributeDescriptions
-
in file types.inc, function getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file user.inc, method user::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file host.inc, method host::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file mailAlias.inc, method mailAlias::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file baseType.inc, method baseType::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file group.inc, method group::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file smbDomain.inc, method smbDomain::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListClassName
-
in file baseType.inc, method baseType::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file types.inc, function getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file mailAlias.inc, method mailAlias::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file smbDomain.inc, method smbDomain::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file host.inc, method host::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file user.inc, method user::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file group.inc, method group::getListClassName()
    Returns the class name for the list object.
-
getManagedAttributes
-
in file baseModule.inc, method baseModule::getManagedAttributes()
    Returns a list of LDAP attributes which are managed by this module.
-
getManagedObjectClasses
-
in file baseModule.inc, method baseModule::getManagedObjectClasses()
    Returns a list of managed object classes for this module.
-
getMaxLength
-
in file schema.inc, method AttributeType::getMaxLength()
    Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.
-
getMayAttrNames
-
in file schema.inc, method ObjectClass::getMayAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.
-
getMayAttrs
-
in file schema.inc, method ObjectClass::getMayAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass may define.
-
getMetaHTML
-
in file lists.inc, method lamSelectListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getMetaHTML
-
in file lists.inc, method lamListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getMetaHTML
-
in file lists.inc, method lamBooleanListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getModuleAlias
-
in file modules.inc, function getModuleAlias()
    Returns the alias name of a module
-
getModulesDependencies
-
in file modules.inc, function getModulesDependencies()
    Returns a hash array (module name => dependencies) of all module dependencies
-
getMunged
-
in file sambaMungedDial.inc, method sambaMungedDial::getMunged()
    Returns ready-to-run mungedDialString to be filled into ldap
-
getMustAttrNames
-
in file schema.inc, method ObjectClass::getMustAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.
-
getMustAttrs
-
in file schema.inc, method ObjectClass::getMustAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass must define.
-
getName
-
in file lists.inc, method lamListTool::getName()
    Returns the tool name.
-
getName
-
in file schema.inc, method AttributeType::getName()
    Gets this attribute's name
-
getName
-
in file schema.inc, method ObjectClassAttribute::getName()
    Gets this attribute's name
-
getName
-
in file schema.inc, method ObjectClass::getName()
    Gets the name of this objectClass (ie, "inetOrgPerson")
-
getName
-
in file schema.inc, method MatchingRule::getName()
    Gets this MatchingRule's name.
-
getName
-
in file config.inc, method LAMConfig::getName()
    Returns the name of the config file
-
getName
-
in file schema.inc, method MatchingRuleUse::getName()
    Gets this MatchingRuleUse's name
-
getNextGIDs
-
in file posixGroup.inc, method posixGroup::getNextGIDs()
    Returns one or more free GID numbers.
-
getNextUIDs
-
in file posixAccount.inc, method posixAccount::getNextUIDs()
    Returns one or more free UID numbers.
-
getOID
-
in file schema.inc, method SchemaItem::getOID()
-
getOnDemandFlags
-
in file sambaMungedDial.inc, method sambaMungedDial::getOnDemandFlags()
    Returns array of flags, which can be set on-demand with activated java-script
-
getOrdering
-
in file schema.inc, method AttributeType::getOrdering()
    Gets this attribute's ordering specification.
-
getOriginalAttributes
-
in file baseModule.inc, method baseModule::getOriginalAttributes()
    Returns the LDAP attributes which are managed in this module (with unchanged values).
-
getParentDN
-
in file modules.inc, method accountContainer::getParentDN()
    Returns the parent DN of a given DN.
-
getPDFStructureDefinitions
-
in file pdfstruct.inc, function getPDFStructureDefinitions()
    This function will return all available PDF structure definitions for the submitted account scope.
-
getProfileOptions
-
in file modules.inc, function getProfileOptions()
    Returns the elements for the profile page.
-
getRDN
-
in file modules.inc, method accountContainer::getRDN()
    Returns the RDN part of a given DN.
-
getRDNAttributes
-
in file modules.inc, function getRDNAttributes()
    Returns a list of LDAP attributes which can be used to form the RDN.
-
getReConn
-
in file sambaMungedDial.inc, method sambaMungedDial::getReConn()
    gets Reconnection value: from any client/from previous client only
-
getRecursiveAttributesFromObjectClass
-
in file schemaTest.php, function getRecursiveAttributesFromObjectClass()
    Returns the names of all attributes which are managed by the given object class and its parents.
-
getRequiredByObjectClasses
-
in file schema.inc, method AttributeType::getRequiredByObjectClasses()
    Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.
-
getRequiredExtensions
-
in file modules.inc, function getRequiredExtensions()
    Returns true if the module is a base module
-
getRequiredExtensions
-
in file baseModule.inc, method baseModule::getRequiredExtensions()
    This function returns a list of PHP extensions (e.g. mhash) which are needed by this module.
-
getSectionHeadline
-
in file pdf.inc, function getSectionHeadline()
    Creates a section headline.
-
getSelfServiceFields
-
in file baseModule.inc, method baseModule::getSelfServiceFields()
    Returns a list of possible input fields and their descriptions.
-
getSelfServiceFieldSettings
-
in file selfService.inc, function getSelfServiceFieldSettings()
    Returns the field settings for the self service.
-
getSelfServiceOptions
-
in file inetOrgPerson.inc, method inetOrgPerson::getSelfServiceOptions()
    Returns the meta HTML code for each input field.
-
getSelfServiceOptions
-
in file posixAccount.inc, method posixAccount::getSelfServiceOptions()
    Returns the meta HTML code for each input field.
-
getSelfServiceOptions
-
in file baseModule.inc, method baseModule::getSelfServiceOptions()
    Returns the meta HTML code for each input field.
-
getSelfServiceOptions
-
in file selfService.inc, function getSelfServiceOptions()
    Returns meta HTML code for each self service field.
-
getSelfServiceProfiles
-
in file selfService.inc, function getSelfServiceProfiles()
    Returns a list of all available self service profiles (without .conf)
-
getSelfServiceSearchAttributes
-
in file selfService.inc, function getSelfServiceSearchAttributes()
    Returns a list of possible search attributes for the self service.
-
getSelfServiceSearchAttributes
-
in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes()
    This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.
-
getSelfServiceSettings
-
in file selfService.inc, function getSelfServiceSettings()
    Returns a hash array (module name => elements) of all module options for the configuration page.
-
getSelfServiceSettings
-
in file baseModule.inc, method baseModule::getSelfServiceSettings()
    Returns a list of self service configuration settings.
-
getShadow
-
in file sambaMungedDial.inc, method sambaMungedDial::getShadow()
    gets shadow value (enum): 0-4
-
getshells
-
in file account.inc, function getshells()
    Returns a list of shells listed in config/shells.
-
getSource
-
in file schema.inc, method ObjectClassAttribute::getSource()
    Gets the name of the ObjectClass which originally specified this attribute.
-
GetStringWidth
-
in file ufpdf.php, method UFPDF::GetStringWidth()
-
GetStringWidth
-
in file fpdf.php, method FPDF::GetStringWidth()
-
getSubstr
-
in file schema.inc, method AttributeType::getSubstr()
    Gets this attribute's substring matching specification
-
getSupAttribute
-
in file schema.inc, method AttributeType::getSupAttribute()
    Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.
-
getSupClasses
-
in file schema.inc, method ObjectClass::getSupClasses()
    Gets the objectClass names from which this objectClass inherits.
-
getSyntaxOID
-
in file schema.inc, method AttributeType::getSyntaxOID()
    Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.
-
getSyntaxString
-
in file schema.inc, method AttributeType::getSyntaxString()
    Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").
-
getTsLogin
-
in file sambaMungedDial.inc, method sambaMungedDial::getTsLogin()
    Gets Terminal-Server-Login value: enabled/disabled
-
getType
-
in file schema.inc, method ObjectClass::getType()
    Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.
-
getType
-
in file schema.inc, method AttributeType::getType()
    Gets this attribute's type
-
getTypeAlias
-
in file types.inc, function getTypeAlias()
    Returns the alias name of an account type.
-
getTypeDescription
-
in file types.inc, function getTypeDescription()
    Returns the description of an account type.
-
getTypes
-
in file types.inc, function getTypes()
    Returns a list of available account types.
-
getUploadColumns
-
in file modules.inc, function getUploadColumns()
    Returns an array containing all input columns for the file upload.
-
getUsage
-
in file schema.inc, method AttributeType::getUsage()
    Gets this attribute's usage string as defined by the LDAP server
-
getUsedByAttrs
-
in file schema.inc, method MatchingRule::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRule
-
getUsedByAttrs
-
in file schema.inc, method MatchingRuleUse::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRuleUse object.
-
getUsedInObjectClasses
-
in file schema.inc, method AttributeType::getUsedInObjectClasses()
    Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
-
getValue
-
in file lists.inc, method lamListOption::getValue()
    Returns the option value. The value must not contain "=" and ";".
-
GetX
-
in file fpdf.php, method FPDF::GetX()
-
GetY
-
in file fpdf.php, method FPDF::GetY()
-
get_AccountModules
-
in file config.inc, method LAMConfig::get_AccountModules()
    Returns an array of all selected account modules
-
get_ActiveTypes
-
in file config.inc, method LAMConfig::get_ActiveTypes()
    Returns a list of active account types.
-
get_Admins
-
in file config.inc, method LAMConfig::get_Admins()
    Returns an array of string with all admin names
-
get_Adminstring
-
in file config.inc, method LAMConfig::get_Adminstring()
    Returns all admin users seperated by semicolons
-
get_alias
-
in file baseModule.inc, method baseModule::get_alias()
    Returns an alias name for the module.
-
get_attr_select_html
-
in file custom.php, function get_attr_select_html()
    Returns option values.
-
get_binary_attr_select_html
-
in file custom.php, function get_binary_attr_select_html()
    Returns option values.
-
get_cache
-
in file cache.inc, method cache::get_cache()
    Queries the cache for a list of LDAP entries and their attributes.
-
get_cached_schema
-
in file schema.inc, function get_cached_schema()
    Returns the cached array of schemaitem objects for the specified
-
get_cacheTimeout
-
in file config.inc, method LAMConfig::get_cacheTimeout()
    Returns the LDAP cache timeout in minutes
-
get_cacheTimeoutSec
-
in file config.inc, method LAMConfig::get_cacheTimeoutSec()
    Returns the LDAP cache timeout in seconds
-
get_configOptions
-
in file posixGroup.inc, method posixGroup::get_configOptions()
    Returns a list of elements for the configuration.
-
get_configOptions
-
in file baseModule.inc, method baseModule::get_configOptions()
    Returns a list of configuration options.
-
get_container
-
in file tree.inc, function get_container()
    Given a DN string, this returns the parent container portion of the string.
-
get_container_contents
-
in file tree.inc, function get_container_contents()
    Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of child entries one level beneath the parent. For example, for the following tree:
-
get_defaultLanguage
-
in file config.inc, method LAMConfig::get_defaultLanguage()
    Returns the default language string
-
get_dependencies
-
in file baseModule.inc, method baseModule::get_dependencies()
    This function returns a list with all depending and conflicting modules.
-
get_enc_type
-
in file tree.inc, function get_enc_type()
-
get_entry_system_attrs
-
in file tree.inc, function get_entry_system_attrs()
    Gets the operational attributes for an entry. Given a DN, this function fetches that entry's
-
get_help
-
in file baseModule.inc, method baseModule::get_help()
    This function returns the help entry array for a specific help id.
-
get_icon
-
in file tree.inc, function get_icon()
    Given a DN and server ID, this function reads the DN's objectClasses and
-
get_ldap_filter
-
in file modules.inc, function get_ldap_filter()
    Returns the LDAP filter used by the account lists
-
get_ldap_filter
-
in file baseModule.inc, method baseModule::get_ldap_filter()
    Returns an LDAP filter for the account lists
-
get_line_end_format
-
in file export_form.php, function get_line_end_format()
    Helper functoin for fetching the line end format.
-
get_listAttributes
-
in file config.inc, method LAMConfig::get_listAttributes()
    Returns the list of attributes to show in user list
-
get_metaData
-
in file kolabUser.inc, method kolabUser::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file ldapPublicKey.inc, method ldapPublicKey::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file inetOrgPerson.inc, method inetOrgPerson::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file ieee802device.inc, method ieee802Device::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file account.inc, method account::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file sambaGroupMapping.inc, method sambaGroupMapping::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file baseModule.inc, method baseModule::get_metaData()
    This function provides meta data which is interpreted by baseModule.
-
get_metaData
-
in file posixGroup.inc, method posixGroup::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file quota.inc, method quota::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file sambaAccount.inc, method sambaAccount::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file shadowAccount.inc, method shadowAccount::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file posixAccount.inc, method posixAccount::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file sambaSamAccount.inc, method sambaSamAccount::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file nisMailAlias.inc, method nisMailAlias::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file sambaDomain.inc, method sambaDomain::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_moduleSettings
-
in file config.inc, method LAMConfig::get_moduleSettings()
    Returns a list of saved module settings
-
get_object_attr
-
in file tree.inc, function get_object_attr()
    Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:
-
get_object_attrs
-
in file tree.inc, function get_object_attrs()
    Gets the attributes/values of an entry. Returns an associative array whose
-
get_pdfEntries
-
in file shadowAccount.inc, method shadowAccount::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file modules.inc, method accountContainer::get_pdfEntries()
    Returns a list of possible PDF entries for this account.
-
get_pdfEntries
-
in file account.inc, method account::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file posixAccount.inc, method posixAccount::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file posixGroup.inc, method posixGroup::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file quota.inc, method quota::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file ldapPublicKey.inc, method ldapPublicKey::get_pdfEntries()
    Returns a list of PDF entries
-
get_pdfEntries
-
in file kolabUser.inc, method kolabUser::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file ieee802device.inc, method ieee802Device::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file inetOrgPerson.inc, method inetOrgPerson::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file sambaAccount.inc, method sambaAccount::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file nisMailAlias.inc, method nisMailAlias::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file sambaGroupMapping.inc, method sambaGroupMapping::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file sambaDomain.inc, method sambaDomain::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file sambaSamAccount.inc, method sambaSamAccount::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfFields
-
in file baseModule.inc, method baseModule::get_pdfFields()
    Returns a hashtable with all entries that may be printed out in the PDF.
-
get_preg
-
in file account.inc, function get_preg()
    Checks if a given value matches the selected regular expression.
-
get_profileOptions
-
in file quota.inc, method quota::get_profileOptions()
    Returns a list of elements for the account profiles.
-
get_profileOptions
-
in file baseModule.inc, method baseModule::get_profileOptions()
    This function defines what attributes will be used in the account profiles and their appearance in the profile editor.
-
get_profileOptions
-
in file posixAccount.inc, method posixAccount::get_profileOptions()
    Returns a list of elements for the account profiles.
-
get_profileOptions
-
in file sambaSamAccount.inc, method sambaSamAccount::get_profileOptions()
    Returns a list of elements for the account profiles.
-
get_profileOptions
-
in file sambaGroupMapping.inc, method sambaGroupMapping::get_profileOptions()
    Returns a list of elements for the account profiles.
-
get_rdn
-
in file tree.inc, function get_rdn()
    Given a DN string, this returns the 'RDN' portion of the string.
-
get_RDNAttributes
-
in file baseModule.inc, method baseModule::get_RDNAttributes()
    Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).
-
get_schema_attribute
-
in file schema.inc, function get_schema_attribute()
    Gets a single AttributeType object specified by name.
-
get_schema_attributes
-
in file schema.inc, function get_schema_attributes()
    Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.
-
get_schema_matching_rules
-
in file schema.inc, function get_schema_matching_rules()
    Returns an array of MatchingRule objects for the specified server.
-
get_schema_objectclass
-
in file schema.inc, function get_schema_objectclass()
    Gets a single ObjectClass object specified by name.
-
get_schema_objectclasses
-
in file schema.inc, function get_schema_objectclasses()
    Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.
-
get_schema_syntaxes
-
in file schema.inc, function get_schema_syntaxes()
    Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.
-
get_scope
-
in file baseModule.inc, method baseModule::get_scope()
    Returns the account type of this module (user, group, host)
-
get_scriptPath
-
in file config.inc, method LAMConfig::get_scriptPath()
    Returns the path to the external script
-
get_scriptRights
-
in file config.inc, method LAMConfig::get_scriptRights()
    Returns the chmod value for new home directories.
-
get_scriptServers
-
in file config.inc, method LAMConfig::get_scriptServers()
    Returns the servers of the external script as a Array
-
get_ServerURL
-
in file config.inc, method LAMConfig::get_ServerURL()
    Returns the server address as string
-
get_Suffix
-
in file config.inc, method LAMConfig::get_Suffix()
    Returns the LDAP suffix for the given account type
-
get_type
-
in file modules.inc, method accountContainer::get_type()
    Returns the accout type of this object (e.g. user, group, host).
-
get_typeSettings
-
in file config.inc, method LAMConfig::get_typeSettings()
    Returns a list of saved type settings
-
get_uploadColumns
-
in file baseModule.inc, method baseModule::get_uploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_uploadColumns
-
in file quota.inc, method quota::get_uploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_uploadPreDepends
-
in file baseModule.inc, method baseModule::get_uploadPreDepends()
    Returns a list of module names which must be processed in building the account befor this module.
-
get_user_agent_string
-
in file export.inc, function get_user_agent_string()
    Gets the USER_AGENT string from the $_SERVER array, all in lower case in an E_NOTICE safe manner.
-
group
-
in file group.inc, class group
    The account type for group accounts (e.g. Unix and Samba).
-
groupRefreshPrimary
-
in file group.inc, method lamGroupList::groupRefreshPrimary()
    Refreshes the primary group members list.
-
group.inc
-
procedural page group.inc
-
-
- top
-
- -
-

h

-
-
$h
-
in file fpdf.php, variable FPDF::$h
-
$hasNext
-
in file export.inc, variable PlaLdapExporter::$hasNext
-
$hPt
-
in file fpdf.php, variable FPDF::$hPt
-
header
-
in file lamPDF.inc, method lamPDF::header()
-
Header
-
in file fpdf.php, method FPDF::Header()
-
help.inc
-
procedural page help.inc
-
hex2bin
-
in file ldap.inc, function hex2bin()
    Converts a HEX string to a binary value
-
hexstr
-
in file sambaMungedDial.inc, method sambaMungedDial::hexstr()
    hexstr
-
host
-
in file host.inc, class host
    The account type for host accounts (e.g. Samba).
-
host.inc
-
procedural page host.inc
-
help.php
-
procedural page help.php
-
-
- top
-
- -
-

i

-
-
$images
-
in file fpdf.php, variable FPDF::$images
-
$indent_step
-
in file export.inc, variable PlaDsmlExporter::$indent_step
-
$InFooter
-
in file fpdf.php, variable FPDF::$InFooter
-
$inputFields
-
in file selfService.inc, variable selfServiceProfile::$inputFields
    input fields
-
$isNewAccount
-
in file modules.inc, variable accountContainer::$isNewAccount
    True if this is a newly created account
-
$is_collective
-
in file schema.inc, variable AttributeType::$is_collective
    boolean: is collective?
-
$is_no_user_modification
-
in file schema.inc, variable AttributeType::$is_no_user_modification
    boolean: can use modify?
-
$is_obsolete
-
in file schema.inc, variable AttributeType::$is_obsolete
    string: the description
-
$is_obsolete
-
in file schema.inc, variable ObjectClass::$is_obsolete
    boolean value indicating whether this objectClass is obsolete
-
$is_obsolete
-
in file schema.inc, variable MatchingRule::$is_obsolete
    Boolean value indicating whether this MatchingRule is obsolete
-
$is_single_value
-
in file schema.inc, variable AttributeType::$is_single_value
    boolean: is single valued only?
-
ieee802Device
-
in file ieee802device.inc, class ieee802Device
    Provides MAC addresses for hosts.
-
Image
-
in file fpdf.php, method FPDF::Image()
-
inetLocalMailRecipient
-
in file inetLocalMailRecipient.inc, class inetLocalMailRecipient
    Provides mail routing for users.
-
inetOrgPerson
-
in file inetOrgPerson.inc, class inetOrgPerson
    This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
-
init
-
in file sambaGroupMapping.inc, method sambaGroupMapping::init()
    Initializes the module after it became part of an accountContainer
-
init
-
in file posixGroup.inc, method posixGroup::init()
    This functin will be called when the module will be loaded *
-
init
-
in file posixAccount.inc, method posixAccount::init()
    Initializes the module after it became part of an accountContainer
-
init
-
in file baseModule.inc, method baseModule::init()
    Initializes the module after it became part of an accountContainer
-
init
-
in file sambaAccount.inc, method sambaAccount::init()
    Initializes the module after it became part of an accountContainer
-
init
-
in file sambaSamAccount.inc, method sambaSamAccount::init()
    Initializes the module after it became part of an accountContainer
-
initialize_session_tree
-
in file tree.inc, function initialize_session_tree()
    Checks and fixes an initial session's tree cache if needed.
-
initQuotas
-
in file quota.inc, method quota::initQuotas()
    Initializes the quota values.
-
initVars
-
in file schema.inc, method Syntax::initVars()
    Initializes the class' member variables
-
initVars
-
in file schema.inc, method MatchingRuleUse::initVars()
    Initialize the class' member variables
-
initVars
-
in file schema.inc, method MatchingRule::initVars()
    Initialize the class' member variables
-
initVars
-
in file schema.inc, method AttributeType::initVars()
    Initialize the class' member variables
-
initVars
-
in file schema.inc, method SchemaItem::initVars()
    Initialize class members to default values.
-
initVars
-
in file schema.inc, method ObjectClass::initVars()
    Initialize the class' member variables
-
in_array_ignore_case
-
in file account.inc, function in_array_ignore_case()
    Checks if a string exists in an array, ignoring case.
-
in_cache
-
in file cache.inc, method cache::in_cache()
    This function returns the DN if an LDAP entry with $attribute=$value is found.
-
isAliasFor
-
in file schema.inc, method AttributeType::isAliasFor()
    Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).
-
isLAMProVersion
-
in file selfService.inc, function isLAMProVersion()
    Returns if this is a LAM Pro installation.
-
isSelected
-
in file lists.inc, method lamBooleanListOption::isSelected()
    Returns if this option is selected.
-
isWritable
-
in file config.inc, method LAMConfig::isWritable()
    Returns if the file can be written on the filesystem.
-
is_attr_binary
-
in file tree.inc, function is_attr_binary()
    Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.
-
is_attr_boolean
-
in file tree.inc, function is_attr_boolean()
    Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.
-
is_base_module
-
in file baseModule.inc, method baseModule::is_base_module()
    Returns true if your module is a base module and otherwise false.
-
is_base_module
-
in file modules.inc, function is_base_module()
    Returns true if the module is a base module
-
is_binary_option_required
-
in file add_attr.php, function is_binary_option_required()
-
is_browser_os_mac
-
in file export.inc, function is_browser_os_mac()
    Determines whether the browser's operating system is Macintosh.
-
is_browser_os_unix
-
in file export.inc, function is_browser_os_unix()
    Determines whether the browser's operating system is UNIX (or something like UNIX).
-
is_browser_os_windows
-
in file export.inc, function is_browser_os_windows()
    Determines whether the browser's operating system is Windows.
-
is_dn_attr
-
in file tree.inc, function is_dn_attr()
    Returns true if the attribute specified is required to take as input a DN.
-
is_jpeg_photo
-
in file tree.inc, function is_jpeg_photo()
    Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.
-
is_mail_string
-
in file tree.inc, function is_mail_string()
    Get whether a string looks like an email address (user@example.com).
-
is_multi_line_attr
-
in file tree.inc, function is_multi_line_attr()
    Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;
-
is_safe_ascii
-
in file export.inc, method PlaExporter::is_safe_ascii()
    Helper method to check if the attribute value should be base 64 encoded.
-
is_samba_path
-
in file sambaMungedDial.inc, method sambaMungedDial::is_samba_path()
    Checks if this is a valid Samba path.
-
is_url_string
-
in file tree.inc, function is_url_string()
    Get whether a string looks like a web URL (http://www.example.com/)
-
ieee802device.inc
-
procedural page ieee802device.inc
-
inetLocalMailRecipient.inc
-
procedural page inetLocalMailRecipient.inc
-
inetOrgPerson.inc
-
procedural page inetOrgPerson.inc
-
index.php
-
procedural page index.php
-
initsuff.php
-
procedural page initsuff.php
-
index.php
-
procedural page index.php
-
-
- top
-
- -
-

k

-
-
$k
-
in file fpdf.php, variable FPDF::$k
-
$keywords
-
in file fpdf.php, variable FPDF::$keywords
-
kolabUser
-
in file kolabUser.inc, class kolabUser
    Manages Kolab user accounts.
-
kolabUser.inc
-
procedural page kolabUser.inc
-
-
- top
-
- -
-

l

-
-
$labels
-
in file lists.inc, variable lamList::$labels
    list of account specific labels
-
$lasth
-
in file fpdf.php, variable FPDF::$lasth
-
$LayoutMode
-
in file fpdf.php, variable FPDF::$LayoutMode
-
$LDAPPassword
-
in file selfService.inc, variable selfServiceProfile::$LDAPPassword
    LDAP password
-
$LDAPSuffix
-
in file selfService.inc, variable selfServiceProfile::$LDAPSuffix
    LDAP suffix
-
$LDAPUser
-
in file selfService.inc, variable selfServiceProfile::$LDAPUser
    LDAP user DN
-
$ldap_info
-
in file export.inc, variable PlaLdapExporter::$ldap_info
-
$LineWidth
-
in file fpdf.php, variable FPDF::$LineWidth
-
$link
-
in file tools.php, variable LAMTool::$link
    link to tool page (relative to templates/)
-
$links
-
in file fpdf.php, variable FPDF::$links
-
$lMargin
-
in file fpdf.php, variable FPDF::$lMargin
-
$logDestination
-
in file config.inc, variable LAMCfgMain::$logDestination
    log destination ("SYSLOG":syslog, "/...":file, "NONE":none)
-
$loginAttributeText
-
in file selfService.inc, variable selfServiceProfile::$loginAttributeText
    describing text for search attribute
-
$loginCaption
-
in file selfService.inc, variable selfServiceProfile::$loginCaption
    describing text for user login
-
$logLevel
-
in file config.inc, variable LAMCfgMain::$logLevel
    log level
-
lamBooleanListOption
-
in file lists.inc, class lamBooleanListOption
    Boolean option for list configuration.
-
LAMCfgMain
-
in file config.inc, class LAMCfgMain
    This class manages config.cfg.
-
LAMConfig
-
in file config.inc, class LAMConfig
    This class manages .conf files.
-
lamdaemon
-
in file lamdaemon.inc, function lamdaemon()
    Sends commands to lamdaemon script.
-
lamdaemonSSH
-
in file lamdaemon.inc, function lamdaemonSSH()
    Sends commands to lamdaemon script via PHP SSH functions.
-
lamGroupList
-
in file group.inc, class lamGroupList
    Generates the list view.
-
lamHostList
-
in file host.inc, class lamHostList
    Generates the list view.
-
lamList
-
in file lists.inc, class lamList
    Generates the list view.
-
lamListOption
-
in file lists.inc, class lamListOption
    Represents a list configuration option.
-
lamListTool
-
in file lists.inc, class lamListTool
    Represents a tool which can be included in the account lists.
-
lamMailAliasList
-
in file mailAlias.inc, class lamMailAliasList
    Generates the list view.
-
lamPDF
-
in file lamPDF.inc, class lamPDF
    Creates a LAM information page in PDF format.
-
LAMPDF_LINEWIDTH
-
in file pdf.inc, constant LAMPDF_LINEWIDTH
    PDF line width
-
lamRunLamdaemonTestSuite
-
in file lamdaemonTest.php, function lamRunLamdaemonTestSuite()
    Runs all tests for a given server.
-
lamSelectListOption
-
in file lists.inc, class lamSelectListOption
    Boolean option for list configuration.
-
lamSmbDomainList
-
in file smbDomain.inc, class lamSmbDomainList
    Generates the list view.
-
lamTestLamdaemon
-
in file lamdaemonTest.php, function lamTestLamdaemon()
    Runs a test case of lamdaemon.
-
LAMTool
-
in file tools.php, class LAMTool
    Represents a tool.
-
lamUserList
-
in file user.inc, class lamUserList
    Generates the list view.
-
LAMVersion
-
in file config.inc, function LAMVersion()
    Returns the version number of this LAM installation.
-
Ldap
-
in file ldap.inc, class Ldap
    Ldap manages connection to LDAP and includes several helper functions.
-
LdapEscape
-
in file export.inc, method PlaCSVExporter::LdapEscape()
-
LdapExportInfo
-
in file export.inc, method LdapExportInfo::LdapExportInfo()
    Create a new LdapExportInfo object
-
LdapExportInfo
-
in file export.inc, class LdapExportInfo
    This class encapsulate informations about the ldap server from which the export is done.
-
ldapPublicKey
-
in file ldapPublicKey.inc, class ldapPublicKey
    Manages SSH public keys.
-
lamdaemon.inc
-
procedural page lamdaemon.inc
-
lamPDF.inc
-
procedural page lamPDF.inc
-
ldap.inc
-
procedural page ldap.inc
-
lists.inc
-
procedural page lists.inc
-
ldapPublicKey.inc
-
procedural page ldapPublicKey.inc
-
Line
-
in file fpdf.php, method FPDF::Line()
-
Link
-
in file fpdf.php, method FPDF::Link()
-
listBuildFilter
-
in file lists.inc, method lamList::listBuildFilter()
    Builds the regular expressions from the filter values.
-
listConfigurationChanged
-
in file lists.inc, method lamList::listConfigurationChanged()
    Called when the configuration options changed.
-
listConfigurationChanged
-
in file user.inc, method lamUserList::listConfigurationChanged()
    Called when the configuration options changed.
-
listConfigurationChanged
-
in file group.inc, method lamGroupList::listConfigurationChanged()
    Called when the configuration options changed.
-
listDoPost
-
in file lists.inc, method lamList::listDoPost()
    Manages all POST actions (e.g. button pressed) for the account lists.
-
listDrawNavigationBar
-
in file lists.inc, method lamList::listDrawNavigationBar()
    Draws a navigation bar to switch between pages
-
listFilterAccounts
-
in file lists.inc, method lamList::listFilterAccounts()
    Removes all entries which do not fit to the filter.
-
listGetAllConfigOptions
-
in file lists.inc, method lamList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetAllConfigOptions
-
in file group.inc, method lamGroupList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetAllConfigOptions
-
in file user.inc, method lamUserList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetConfigOptionByID
-
in file lists.inc, method lamList::listGetConfigOptionByID()
    Returns the configuration option with the given ID.
-
listGetParams
-
in file lists.inc, method lamList::listGetParams()
    Sets some internal parameters.
-
listGetParams
-
in file group.inc, method lamGroupList::listGetParams()
    Sets some internal parameters.
-
listGetParams
-
in file user.inc, method lamUserList::listGetParams()
    Sets some internal parameters.
-
listPrintButtons
-
in file lists.inc, method lamList::listPrintButtons()
    Prints the create and delete buttons.
-
listPrintConfigurationPage
-
in file lists.inc, method lamList::listPrintConfigurationPage()
    Prints the list configuration page.
-
listPrintFooter
-
in file lists.inc, method lamList::listPrintFooter()
    Prints the HTML footer.
-
listPrintHeader
-
in file lists.inc, method lamList::listPrintHeader()
    Prints the HTML header.
-
listPrintTableBody
-
in file lists.inc, method lamList::listPrintTableBody()
    Prints the entry list
-
listPrintTableCellContent
-
in file group.inc, method lamGroupList::listPrintTableCellContent()
    Prints the content of a cell in the account list for a given LDAP entry and attribute.
-
listPrintTableCellContent
-
in file lists.inc, method lamList::listPrintTableCellContent()
    Prints the content of a cell in the account list for a given LDAP entry and attribute.
-
listPrintTableCellContent
-
in file user.inc, method lamUserList::listPrintTableCellContent()
    Prints the content of a cell in the account list for a given LDAP entry and attribute.
-
listPrintTableHeader
-
in file lists.inc, method lamList::listPrintTableHeader()
    Prints the attribute and filter row at the account table head
-
listRefreshData
-
in file lists.inc, method lamList::listRefreshData()
    Rereads the entries from LDAP.
-
listRefreshData
-
in file user.inc, method lamUserList::listRefreshData()
    Rereads the entries from LDAP.
-
listRefreshData
-
in file group.inc, method lamGroupList::listRefreshData()
    Rereads the entries from LDAP.
-
listShowOUSelection
-
in file lists.inc, method lamList::listShowOUSelection()
    Prints a combobox with possible sub-DNs.
-
listSort
-
in file lists.inc, method lamList::listSort()
    Sorts an account list by a given attribute
-
LIST_SIZE_OPTION_NAME
-
in file lists.inc, class constant lamList::LIST_SIZE_OPTION_NAME
    ID for list size config option
-
lmhash
-
in file createntlm.inc, method smbHash::lmhash()
    Calculates the LM hash of a given password.
-
lmPassword
-
in file account.inc, function lmPassword()
    Generates the LM hash of a password.
-
Ln
-
in file fpdf.php, method FPDF::Ln()
-
load
-
in file sambaMungedDial.inc, method sambaMungedDial::load()
    function takes a base64-encoded sambaMungedDial
-
loadAccountProfile
-
in file profiles.inc, function loadAccountProfile()
    Loads an profile of the given account type
-
loadPDFStructureDefinitions
-
in file pdfstruct.inc, function loadPDFStructureDefinitions()
    This function is used to get pdf structure from xml file.
-
loadSelfServiceProfile
-
in file selfService.inc, function loadSelfServiceProfile()
    Loads all settings of a self service profile.
-
load_account
-
in file modules.inc, method accountContainer::load_account()
    Loads an LDAP account with the given DN.
-
load_attributes
-
in file sambaAccount.inc, method sambaAccount::load_attributes()
    This function loads the LDAP attributes for this module.
-
load_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()
    This function loads the LDAP attributes for this module.
-
load_attributes
-
in file posixAccount.inc, method posixAccount::load_attributes()
    This function loads all needed LDAP attributes.
-
load_attributes
-
in file baseModule.inc, method baseModule::load_attributes()
    This function loads the LDAP attributes when an account should be loaded.
-
load_Messages
-
in file sambaSamAccount.inc, method sambaSamAccount::load_Messages()
    this functin fills the error message array with messages
-
load_Messages
-
in file ieee802device.inc, method ieee802Device::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file posixAccount.inc, method posixAccount::load_Messages()
    This function fills the error message array with messages.
-
load_Messages
-
in file posixGroup.inc, method posixGroup::load_Messages()
    This function fills the $messages variable with output messages from this module.
-
load_Messages
-
in file shadowAccount.inc, method shadowAccount::load_Messages()
    This function builds up the message array.
-
load_Messages
-
in file inetOrgPerson.inc, method inetOrgPerson::load_Messages()
    This function fills the message array.
-
load_Messages
-
in file nisMailAlias.inc, method nisMailAlias::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file account.inc, method account::load_Messages()
    This function fills the message array.
-
load_Messages
-
in file quota.inc, method quota::load_Messages()
    this functin fills the error message array with messages
-
load_Messages
-
in file sambaGroupMapping.inc, method sambaGroupMapping::load_Messages()
    this functin fills the error message array with messages
-
load_Messages
-
in file sambaDomain.inc, method sambaDomain::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file baseModule.inc, method baseModule::load_Messages()
    This function fills the $messages variable with output messages from this module.
-
load_Messages
-
in file sambaAccount.inc, method sambaAccount::load_Messages()
    this functin fills the error message array with messages
-
load_Messages
-
in file kolabUser.inc, method kolabUser::load_Messages()
    This function fills the error message array with messages
-
load_profile
-
in file shadowAccount.inc, method shadowAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file baseModule.inc, method baseModule::load_profile()
    This function loads the values from an account profile to the module's internal data structures.
-
load_profile
-
in file quota.inc, method quota::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file posixAccount.inc, method posixAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file sambaGroupMapping.inc, method sambaGroupMapping::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file sambaAccount.inc, method sambaAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file sambaSamAccount.inc, method sambaSamAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
logNewMessage
-
in file security.inc, function logNewMessage()
    Puts a new message in the log file.
-
logoffAndBackToLoginPage
-
in file security.inc, function logoffAndBackToLoginPage()
    Logs off the user and displays the login page.
-
list.php
-
procedural page list.php
-
login.php
-
procedural page login.php
-
logout.php
-
procedural page logout.php
-
lamdaemonTest.php
-
procedural page lamdaemonTest.php
-
-
- top
-
- -
-

m

-
-
$mainPageText
-
in file selfService.inc, variable selfServiceProfile::$mainPageText
    describing text for self service main page
-
$maxPageEntries
-
in file lists.inc, variable lamList::$maxPageEntries
    maximum count of entries per page
-
$MAX_LDIF_LINE_LENGTH
-
in file export.inc, variable PlaLdifExporter::$MAX_LDIF_LINE_LENGTH
-
$max_length
-
in file schema.inc, variable AttributeType::$max_length
    The max number of characters this attribute can be
-
$may_attrs
-
in file schema.inc, variable ObjectClass::$may_attrs
    arrays of attribute names that this objectClass allows, but does not require
-
$messages
-
in file baseModule.inc, variable baseModule::$messages
    contains all error messages of a module
-
$meta
-
in file baseModule.inc, variable baseModule::$meta
    includes all meta data provided by the sub class
-
$moduleSettings
-
in file selfService.inc, variable selfServiceProfile::$moduleSettings
    configuration settings of modules
-
$moduleSettings
-
in file baseModule.inc, variable baseModule::$moduleSettings
    configuration settings of all modules
-
$multivalue_separator
-
in file export.inc, variable PlaCSVExporter::$multivalue_separator
-
$must_attrs
-
in file schema.inc, variable ObjectClass::$must_attrs
    arrays of attribute names that this objectClass requires
-
modules.inc
-
procedural page modules.inc
-
mailAlias.inc
-
procedural page mailAlias.inc
-
mailAlias
-
in file mailAlias.inc, class mailAlias
    The account type for mail aliases.
-
MatchingRule
-
in file schema.inc, method MatchingRule::MatchingRule()
    Creates a new MatchingRule object from a raw LDAP MatchingRule string.
-
MatchingRule
-
in file schema.inc, class MatchingRule
    Represents an LDAP MatchingRule
-
MatchingRuleUse
-
in file schema.inc, class MatchingRuleUse
    Represents an LDAP schema matchingRuleUse entry
-
MatchingRuleUse
-
in file schema.inc, method MatchingRuleUse::MatchingRuleUse()
-
metaRefresh
-
in file config.inc, function metaRefresh()
    Prints a meta refresh page
-
module_complete
-
in file posixAccount.inc, method posixAccount::module_complete()
    This functions is used to check if all settings for this module have been made.
-
module_complete
-
in file kolabUser.inc, method kolabUser::module_complete()
    This function returns true if all needed settings are done.
-
module_complete
-
in file sambaAccount.inc, method sambaAccount::module_complete()
    This functions returns true if all needed settings are done
-
module_complete
-
in file baseModule.inc, method baseModule::module_complete()
    This functions is used to check if all settings for this module have been made.
-
module_complete
-
in file posixGroup.inc, method posixGroup::module_complete()
    This functions is used to check if all settings for this module have been made.
-
module_complete
-
in file account.inc, method account::module_complete()
    This functions returns true if all needed settings are done.
-
module_complete
-
in file inetOrgPerson.inc, method inetOrgPerson::module_complete()
    This functions return true if all needed settings are done.
-
module_ready
-
in file sambaGroupMapping.inc, method sambaGroupMapping::module_ready()
    This function is used to check if this module page can be displayed.
-
module_ready
-
in file sambaSamAccount.inc, method sambaSamAccount::module_ready()
    This function is used to check if this module page can be displayed.
-
module_ready
-
in file baseModule.inc, method baseModule::module_ready()
    This function is used to check if this module page can be displayed.
-
module_ready
-
in file sambaAccount.inc, method sambaAccount::module_ready()
    This function is used to check if this module page can be displayed.
-
module_ready
-
in file quota.inc, method quota::module_ready()
    This function is used to check if this module page can be displayed.
-
MultiCell
-
in file fpdf.php, method FPDF::MultiCell()
-
MultiCell
-
in file ufpdf.php, method UFPDF::MultiCell()
-
multi_lines_display
-
in file export.inc, method PlaLdifExporter::multi_lines_display()
    Helper method to wrap ldif lines
-
munge
-
in file sambaMungedDial.inc, method sambaMungedDial::munge()
    Setup parameter given by paramName to MungedDial-Format
-
MyCustomExporter
-
in file export.inc, class MyCustomExporter
-
MyCutsomExporter
-
in file export.inc, method MyCustomExporter::MyCutsomExporter()
-
mainlogin.php
-
procedural page mainlogin.php
-
mainmanage.php
-
procedural page mainmanage.php
-
main.php
-
procedural page main.php
-
main_header.php
-
procedural page main_header.php
-
massBuildAccounts.php
-
procedural page massBuildAccounts.php
-
masscreate.php
-
procedural page masscreate.php
-
massDoUpload.php
-
procedural page massDoUpload.php
-
-
- top
-
- -
-

n

-
-
$n
-
in file fpdf.php, variable FPDF::$n
-
$name
-
in file schema.inc, variable ObjectClass::$name
    This objectClass' name, ie "inetOrgPerson"
-
$name
-
in file schema.inc, variable MatchingRuleUse::$name
    The name of the MathingRule this applies to
-
$name
-
in file schema.inc, variable MatchingRule::$name
    This rule's name
-
$name
-
in file schema.inc, variable AttributeType::$name
    The name of this attributeType
-
$name
-
in file schema.inc, variable ObjectClassAttribute::$name
    This Attribute's name
-
$name
-
in file tools.php, variable LAMTool::$name
    name of the tool
-
$name
-
in file account.inc, variable samba3domain::$name
    Domain name
-
$nextGroupRID
-
in file account.inc, variable samba3domain::$nextGroupRID
    Next group RID
-
$nextRID
-
in file account.inc, variable samba3domain::$nextRID
    Next RID
-
$nextUserRID
-
in file account.inc, variable samba3domain::$nextUserRID
    Next user RID
-
$num_entries
-
in file export.inc, variable PlaLdapExporter::$num_entries
-
nisMailAlias.inc
-
procedural page nisMailAlias.inc
-
new_account
-
in file modules.inc, method accountContainer::new_account()
    This function will prepare the object for a new account.
-
new_rand
-
in file ldap.inc, method Ldap::new_rand()
    Calculates a new value for rand
-
nisMailAlias
-
in file nisMailAlias.inc, class nisMailAlias
    Provides NIS mail alias management.
-
not_an_attr
-
in file add_attr_form.php, function not_an_attr()
    Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.
-
nthash
-
in file createntlm.inc, method smbHash::nthash()
    Calculates the NT hash of a given password.
-
ntPassword
-
in file account.inc, function ntPassword()
    Generates the NT hash of a password.
-
new_ou_template.php
-
procedural page new_ou_template.php
-
-
- top
-
- -
-

o

-
-
$offsets
-
in file fpdf.php, variable FPDF::$offsets
-
$oid
-
in file schema.inc, variable SchemaItem::$oid
    The OID of this schema item.
-
$ordering
-
in file schema.inc, variable AttributeType::$ordering
    The ordering of the attributeType
-
$OrientationChanges
-
in file fpdf.php, variable FPDF::$OrientationChanges
-
$orig
-
in file baseModule.inc, variable baseModule::$orig
    contains all ldap attributes which are loaded from ldap
-
ObjectClass
-
in file schema.inc, method ObjectClass::ObjectClass()
    Creates a new ObjectClass object given a raw LDAP objectClass string.
-
ObjectClass
-
in file schema.inc, class ObjectClass
    Represents an LDAP objectClass
-
ObjectClassAttribute
-
in file schema.inc, method ObjectClassAttribute::ObjectClassAttribute()
    Creates a new ObjectClassAttribute with specified name and source objectClass.
-
ObjectClassAttribute
-
in file schema.inc, class ObjectClassAttribute
    A simple class for representing AttributeTypes used only by the ObjectClass class.
-
Open
-
in file fpdf.php, method FPDF::Open()
-
Output
-
in file fpdf.php, method FPDF::Output()
-
ou_edit.php
-
procedural page ou_edit.php
-
-
- top
-
- -
-

p

-
-
$page
-
in file lists.inc, variable lamList::$page
    current page number
-
$page
-
in file fpdf.php, variable FPDF::$page
-
$PageBreakTrigger
-
in file fpdf.php, variable FPDF::$PageBreakTrigger
-
$PageLinks
-
in file fpdf.php, variable FPDF::$PageLinks
-
$pages
-
in file fpdf.php, variable FPDF::$pages
-
$PDFVersion
-
in file fpdf.php, variable FPDF::$PDFVersion
-
$possibleSuffixes
-
in file lists.inc, variable lamList::$possibleSuffixes
    list of possible LDAP suffixes(organizational units)
-
posixAccount.inc
-
procedural page posixAccount.inc
-
posixGroup.inc
-
procedural page posixGroup.inc
-
pdf.inc
-
procedural page pdf.inc
-
pdfstruct.inc
-
procedural page pdfstruct.inc
-
profiles.inc
-
procedural page profiles.inc
-
PageNo
-
in file fpdf.php, method FPDF::PageNo()
-
parse
-
in file xml_parser.inc, method xmlParser::parse()
-
parseHtml
-
in file modules.inc, function parseHtml()
    Takes a list of meta-HTML elements and prints the equivalent HTML output.
-
PlaAbstractExporter
-
in file export.inc, class PlaAbstractExporter
    This class represents the base class of all exporters
-
PlaCSVExporter
-
in file export.inc, class PlaCSVExporter
    Export to cvs format
-
PlaCSVExporter
-
in file export.inc, method PlaCSVExporter::PlaCSVExporter()
-
PlaDsmlExporter
-
in file export.inc, method PlaDsmlExporter::PlaDsmlExporter()
    Create a PlaDsmlExporter object
-
PlaDsmlExporter
-
in file export.inc, class PlaDsmlExporter
    Export entries to DSML v.1
-
PlaExporter
-
in file export.inc, method PlaExporter::PlaExporter()
    Constructor
-
PlaExporter
-
in file export.inc, class PlaExporter
    PlaExporter acts a wrapper around another exporter.
-
PlaLdapExporter
-
in file export.inc, class PlaLdapExporter
    Export data from a ldap server
-
PlaLdapExporter
-
in file export.inc, method PlaLdapExporter::PlaLdapExporter()
    Create a PlaLdapExporter object.
-
PlaLdifExporter
-
in file export.inc, class PlaLdifExporter
    Export entries to ldif format
-
PlaLdifExporter
-
in file export.inc, method PlaLdifExporter::PlaLdifExporter()
    Create a PlaLdifExporter object
-
PlaVcardExporter
-
in file export.inc, class PlaVcardExporter
-
PlaVcardExporter
-
in file export.inc, method PlaVcardExporter::PlaVcardExporter()
-
pla_compare_dns
-
in file tree.inc, function pla_compare_dns()
    Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.
-
pla_explode_dn
-
in file tree.inc, function pla_explode_dn()
    Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.
-
pla_fetch_entry_array
-
in file export.inc, method PlaAbstractExporter::pla_fetch_entry_array()
    Return the entry as an array
-
pla_fetch_entry_array
-
in file export.inc, method PlaLdapExporter::pla_fetch_entry_array()
    Return the entry as an array
-
pla_fetch_entry_array
-
in file export.inc, method PlaExporter::pla_fetch_entry_array()
    Return the entry as an array
-
pla_fetch_entry_object
-
in file export.inc, method PlaAbstractExporter::pla_fetch_entry_object()
    Return the entry as an Entry object
-
pla_fetch_entry_object
-
in file export.inc, method PlaLdapExporter::pla_fetch_entry_object()
    Return the entry as an Entry object
-
pla_fetch_entry_object
-
in file export.inc, method PlaExporter::pla_fetch_entry_object()
    Return the entry as an Entry object
-
pla_get_ldap_info
-
in file export.inc, method PlaAbstractExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object
-
pla_get_ldap_info
-
in file export.inc, method PlaLdapExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object
-
pla_get_ldap_info
-
in file export.inc, method PlaExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object
-
pla_has_entry
-
in file export.inc, method PlaExporter::pla_has_entry()
    Return true if there is some more entries to be processed
-
pla_has_entry
-
in file export.inc, method PlaLdapExporter::pla_has_entry()
    Return true if there is some more entries to be processed
-
pla_has_entry
-
in file export.inc, method PlaAbstractExporter::pla_has_entry()
    Return true if there is some more entries to be processed
-
pla_ldap_search
-
in file tree.inc, function pla_ldap_search()
    A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.
-
pla_num_entries
-
in file export.inc, method PlaAbstractExporter::pla_num_entries()
    Return the number of entries
-
pla_num_entries
-
in file export.inc, method PlaExporter::pla_num_entries()
    Return the number of entries
-
pla_num_entries
-
in file export.inc, method PlaLdapExporter::pla_num_entries()
    Return the number of entries
-
pla_rdelete
-
in file rdelete.php, function pla_rdelete()
-
pla_reverse_dn
-
in file tree.inc, function pla_reverse_dn()
    Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
-
posixAccount
-
in file posixAccount.inc, class posixAccount
    Manages the object class "posixAccount" for users and hosts.
-
posixGroup
-
in file posixGroup.inc, class posixGroup
    Manages the object class "posixGroup" for groups.
-
postDeleteActions
-
in file baseModule.inc, method baseModule::postDeleteActions()
    Allows the module to run commands after the LDAP entry is deleted.
-
postModifyActions
-
in file baseModule.inc, method baseModule::postModifyActions()
    Allows the module to run commands after the LDAP entry is changed or created.
-
postModifyActions
-
in file posixAccount.inc, method posixAccount::postModifyActions()
    Allows the module to run commands after the LDAP entry was changed or created.
-
postModifyActions
-
in file quota.inc, method quota::postModifyActions()
    Allows the module to run commands after the LDAP entry is changed or created.
-
preDeleteActions
-
in file posixAccount.inc, method posixAccount::preDeleteActions()
    Allows the module to run commands before the LDAP entry is deleted.
-
preDeleteActions
-
in file quota.inc, method quota::preDeleteActions()
    Allows the module to run commands before the LDAP entry is deleted.
-
preDeleteActions
-
in file baseModule.inc, method baseModule::preDeleteActions()
    Allows the module to run commands before the LDAP entry is deleted.
-
preModifyActions
-
in file baseModule.inc, method baseModule::preModifyActions()
    Allows the module to run commands before the LDAP entry is changed or created.
-
pretty_print_dn
-
in file tree.inc, function pretty_print_dn()
    Returns an HTML-beautified version of a DN.
-
processAttributes
-
in file pdf.inc, function processAttributes()
    Processes width, height and alignment attributes.
-
processFormatTags
-
in file pdf.inc, function processFormatTags()
    Formats the XML code.
-
processLine
-
in file pdf.inc, function processLine()
    Creates the XML code for an PDF entry.
-
process_attributes
-
in file quota.inc, method quota::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file posixGroup.inc, method posixGroup::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file sambaDomain.inc, method sambaDomain::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file sambaAccount.inc, method sambaAccount::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file posixAccount.inc, method posixAccount::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file sambaGroupMapping.inc, method sambaGroupMapping::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file ldapPublicKey.inc, method ldapPublicKey::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file account.inc, method account::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file kolabUser.inc, method kolabUser::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file ieee802device.inc, method ieee802Device::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file nisMailAlias.inc, method nisMailAlias::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file shadowAccount.inc, method shadowAccount::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file baseModule.inc, method baseModule::process_attributes()
    This function processes user input.
-
process_attributes
-
in file inetOrgPerson.inc, method inetOrgPerson::process_attributes()
    Processes user input of the primary module page.
-
process_deleteUser
-
in file kolabUser.inc, method kolabUser::process_deleteUser()
    Write variables into object and do some regex checks
-
process_expire
-
in file shadowAccount.inc, method shadowAccount::process_expire()
    Processes user input of the expiration page.
-
process_group
-
in file posixAccount.inc, method posixAccount::process_group()
    Processes user input of the group selection page.
-
process_logonHours
-
in file sambaSamAccount.inc, method sambaSamAccount::process_logonHours()
    Processes user input of the logon hours page.
-
process_password
-
in file posixAccount.inc, method posixAccount::process_password()
    Processes user input of the password page.
-
process_password
-
in file posixGroup.inc, method posixGroup::process_password()
    Processes user input of the password page.
-
process_password
-
in file inetOrgPerson.inc, method inetOrgPerson::process_password()
    Sets a new password.
-
process_photo
-
in file inetOrgPerson.inc, method inetOrgPerson::process_photo()
    Sets a new photo.
-
process_sambaUserWorkstations
-
in file sambaSamAccount.inc, method sambaSamAccount::process_sambaUserWorkstations()
    Processes user input of the primary module page.
-
process_terminalServer
-
in file sambaSamAccount.inc, method sambaSamAccount::process_terminalServer()
    Processes user input of the terminal server page.
-
process_time
-
in file sambaSamAccount.inc, method sambaSamAccount::process_time()
    Processes user input of the time selection page.
-
process_user
-
in file posixGroup.inc, method posixGroup::process_user()
    Processes user input of the user selection page.
-
process_userWorkstations
-
in file sambaAccount.inc, method sambaAccount::process_userWorkstations()
    Processes user input of the workstation selection page.
-
pwd_disable
-
in file account.inc, function pwd_disable()
    Marks an password hash as disabled and returns the new hash string
-
pwd_enable
-
in file account.inc, function pwd_enable()
    Marks an password hash as enabled and returns the new hash string
-
pwd_hash
-
in file account.inc, function pwd_hash()
    Returns the hash value of a plain text password the hash algorithm depends on the configuration file
-
pwd_is_enabled
-
in file account.inc, function pwd_is_enabled()
    Checks if a password hash is enabled/disabled
-
profmanage.php
-
procedural page profmanage.php
-
pdfdelete.php
-
procedural page pdfdelete.php
-
pdfmain.php
-
procedural page pdfmain.php
-
pdfpage.php
-
procedural page pdfpage.php
-
profiledelete.php
-
procedural page profiledelete.php
-
profilemain.php
-
procedural page profilemain.php
-
profilepage.php
-
procedural page profilepage.php
-
-
- top
-
- -
-

q

-
-
$qualifier
-
in file export.inc, variable PlaCSVExporter::$qualifier
-
$queryFilter
-
in file export.inc, variable PlaLdapExporter::$queryFilter
-
$query_filter
-
in file export.inc, variable LdapExportInfo::$query_filter
-
quota.inc
-
procedural page quota.inc
-
quota
-
in file quota.inc, class quota
    Manages quotas for users and groups.
-
-
- top
-
- -
-

r

-
-
$rdn
-
in file modules.inc, variable accountContainer::$rdn
    RDN attribute of this account
-
$refresh
-
in file lists.inc, variable lamList::$refresh
    refresh page switch
-
$required_by_object_classes
-
in file schema.inc, variable AttributeType::$required_by_object_classes
    A list of object class names that require this attribute type.
-
$requiresPasswordChanges
-
in file tools.php, variable LAMTool::$requiresPasswordChanges
    tool requires password change rights
-
$requiresWriteAccess
-
in file tools.php, variable LAMTool::$requiresWriteAccess
    tool requires write access to LDAP
-
$results
-
in file export.inc, variable PlaLdapExporter::$results
-
$RIDbase
-
in file account.inc, variable samba3domain::$RIDbase
    RID base to calculate RIDs, default 1000
-
$rMargin
-
in file fpdf.php, variable FPDF::$rMargin
-
readTime
-
in file sambaMungedDial.inc, method sambaMungedDial::readTime()
    readTime
-
real_attr_name
-
in file tree.inc, function real_attr_name()
    Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.
-
Rect
-
in file fpdf.php, method FPDF::Rect()
-
refreshPrimaryGroupTranslation
-
in file user.inc, method lamUserList::refreshPrimaryGroupTranslation()
    Refreshes the GID to group name cache.
-
refresh_cache
-
in file cache.inc, method cache::refresh_cache()
    This function refreshes the cache.
-
removeAlias
-
in file schema.inc, method AttributeType::removeAlias()
    Removes an attribute name from this attribute's alias array.
-
remove_aliases
-
in file custom.php, function remove_aliases()
    Removes attributes from the array that are aliases for eachother
-
replaceSpecialChars
-
in file quota.inc, method quota::replaceSpecialChars()
    Replaces special characters in HTML name values.
-
rdelete.php
-
procedural page rdelete.php
-
refresh.php
-
procedural page refresh.php
-
-
- top
-
- -
-

s

-
-
$scope
-
in file export.inc, variable PlaLdapExporter::$scope
-
$scope
-
in file export.inc, variable LdapExportInfo::$scope
-
$searchAttribute
-
in file selfService.inc, variable selfServiceProfile::$searchAttribute
    LDAP search attribute
-
$selfServiceSettings
-
in file baseModule.inc, variable baseModule::$selfServiceSettings
    self service settings of all modules
-
$separator
-
in file export.inc, variable PlaCSVExporter::$separator
    When doing an exporter, the method export need to be overriden.
-
$serverURL
-
in file selfService.inc, variable selfServiceProfile::$serverURL
    server address
-
$sessionTimeout
-
in file config.inc, variable LAMCfgMain::$sessionTimeout
    Time of inactivity before session times out (minutes)
-
$SID
-
in file account.inc, variable samba3domain::$SID
    Domain SID
-
$sortColumn
-
in file lists.inc, variable lamList::$sortColumn
    sort column name
-
$sortDirection
-
in file lists.inc, variable lamList::$sortDirection
    sort direction: 1 for ascending, -1 for descending
-
$source
-
in file schema.inc, variable ObjectClassAttribute::$source
    This Attribute's root
-
$state
-
in file fpdf.php, variable FPDF::$state
-
$subject
-
in file fpdf.php, variable FPDF::$subject
-
$sub_str
-
in file schema.inc, variable AttributeType::$sub_str
    Boolean: supports substring matching?
-
$suffix
-
in file lists.inc, variable lamList::$suffix
    LDAP suffix
-
$sup_attribute
-
in file schema.inc, variable AttributeType::$sup_attribute
    The attribute from which this attribute inherits (if any)
-
$sup_classes
-
in file schema.inc, variable ObjectClass::$sup_classes
    array of objectClass names from which this objectClass inherits
-
$syntax
-
in file schema.inc, variable MatchingRule::$syntax
    This rule's syntax OID
-
$syntax
-
in file schema.inc, variable AttributeType::$syntax
    The full syntax string, ie 1.2.3.4{16}
-
sambaAccount.inc
-
procedural page sambaAccount.inc
-
sambaDomain.inc
-
procedural page sambaDomain.inc
-
sambaGroupMapping.inc
-
procedural page sambaGroupMapping.inc
-
sambaMungedDial.inc
-
procedural page sambaMungedDial.inc
-
sambaSamAccount.inc
-
procedural page sambaSamAccount.inc
-
shadowAccount.inc
-
procedural page shadowAccount.inc
-
schema.inc
-
procedural page schema.inc
-
security.inc
-
procedural page security.inc
-
selfService.inc
-
procedural page selfService.inc
-
status.inc
-
procedural page status.inc
-
smbDomain.inc
-
procedural page smbDomain.inc
-
samba3domain
-
in file account.inc, class samba3domain
    Represents a Samba 3 domain entry
-
sambaAccount
-
in file sambaAccount.inc, class sambaAccount
    Manages the object class "sambaAccount" for users and hosts.
-
sambaDomain
-
in file sambaDomain.inc, class sambaDomain
    Manages Samba 3 domain entries.
-
sambaGroupMapping
-
in file sambaGroupMapping.inc, class sambaGroupMapping
    Manages the object class "sambaGroupMapping" for groups.
-
sambaMungedDial
-
in file sambaMungedDial.inc, class sambaMungedDial
    Manages terminal server settings for Samba 3.
-
sambaSamAccount
-
in file sambaSamAccount.inc, class sambaSamAccount
    Manages the object class "sambaSamAccount" for users and hosts.
-
SAMBA_MUNGEDDIAL_FILEHEADER
-
in file sambaMungedDial.inc, constant SAMBA_MUNGEDDIAL_FILEHEADER
    File header
-
SAMBA_MUNGEDDIAL_FILEHEADER_OLD
-
in file sambaMungedDial.inc, constant SAMBA_MUNGEDDIAL_FILEHEADER_OLD
    File header for old format.
-
save
-
in file config.inc, method LAMCfgMain::save()
    Saves preferences to config file config.cfg
-
save
-
in file config.inc, method LAMConfig::save()
    Saves preferences to config file
-
saveAccountProfile
-
in file profiles.inc, function saveAccountProfile()
    Saves an hash array (attribute => value) to an account profile
-
savePDFStructureDefinitions
-
in file pdfstruct.inc, function savePDFStructureDefinitions()
    Saves PDF structure definitions to XML file in format: <name>.<scope>.xml
-
saveSelfServiceProfile
-
in file selfService.inc, function saveSelfServiceProfile()
    Saves a self service profile.
-
saveSettings
-
in file confmain.php, function saveSettings()
    Saves the entered settings.
-
save_account
-
in file modules.inc, method accountContainer::save_account()
    This function will save an account to the LDAP database.
-
save_attributes
-
in file sambaGroupMapping.inc, method sambaGroupMapping::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file kolabUser.inc, method kolabUser::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file shadowAccount.inc, method shadowAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file sambaAccount.inc, method sambaAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file inetOrgPerson.inc, method inetOrgPerson::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file posixGroup.inc, method posixGroup::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file posixAccount.inc, method posixAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file account.inc, method account::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file nisMailAlias.inc, method nisMailAlias::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file baseModule.inc, method baseModule::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_module_attributes
-
in file modules.inc, method accountContainer::save_module_attributes()
    This function checks which LDAP attributes have changed while the account was edited.
-
SchemaItem
-
in file schema.inc, method SchemaItem::SchemaItem()
    Default constructor.
-
SchemaItem
-
in file schema.inc, class SchemaItem
    Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
-
SCHEMA_SESSION_CACHE_ENABLED
-
in file schema.inc, constant SCHEMA_SESSION_CACHE_ENABLED
    To enable/disable session-based schema caching (1: enabled, 0: disabled).
-
search_domains
-
in file account.inc, function search_domains()
    Returns an array with all Samba 3 domain entries under the given suffix
-
search_units
-
in file ldap.inc, method Ldap::search_units()
    Returns an array with all organizational units under the given suffix
-
search_username
-
in file userlink.php, function search_username()
    Searches LDAP for a specific user name (uid attribute) and returns its DN entry
-
selfServiceProfile
-
in file selfService.inc, class selfServiceProfile
    Includes all settings of a self service profile.
-
server
-
in file ldap.inc, method Ldap::server()
    Returns the LDAP connection handle
-
setAccessLevel
-
in file config.inc, method LAMConfig::setAccessLevel()
    Sets the access level for this profile.
-
setAliases
-
in file schema.inc, method AttributeType::setAliases()
    Sets this attribute's list of aliases.
-
SetAuthor
-
in file fpdf.php, method FPDF::SetAuthor()
-
SetAutoPageBreak
-
in file fpdf.php, method FPDF::SetAutoPageBreak()
-
setBrokenConn
-
in file sambaMungedDial.inc, method sambaMungedDial::setBrokenConn()
    sets Broken-Connection value: disconnect/reset
-
SetCompression
-
in file fpdf.php, method FPDF::SetCompression()
-
setConnectClientDrives
-
in file sambaMungedDial.inc, method sambaMungedDial::setConnectClientDrives()
    sets connect-client-drive-at-logon value: enabled/disabled
-
setConnectClientPrinters
-
in file sambaMungedDial.inc, method sambaMungedDial::setConnectClientPrinters()
    sets connect-client-printers-at-logon value: enabled/disabled
-
SetCreator
-
in file fpdf.php, method FPDF::SetCreator()
-
setCtxMaxConnectionTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxConnectionTimeF()
    SMARTY: sets the checkbox "Connection" to unchecked
-
setCtxMaxDisconnectionTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxDisconnectionTimeF()
    SMARTY: sets the checkbox "Disconnection" to unchecked
-
setCtxMaxIdleTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxIdleTimeF()
    SMARTY: sets the checkbox "Idle" to unchecked
-
setDefaultPrinter
-
in file sambaMungedDial.inc, method sambaMungedDial::setDefaultPrinter()
    sets set-client-printer-to-default value: enabled/disabled
-
setDescription
-
in file schema.inc, method SchemaItem::setDescription()
-
SetDisplayMode
-
in file fpdf.php, method FPDF::SetDisplayMode()
-
SetDrawColor
-
in file fpdf.php, method FPDF::SetDrawColor()
-
SetFillColor
-
in file fpdf.php, method FPDF::SetFillColor()
-
SetFont
-
in file fpdf.php, method FPDF::SetFont()
-
SetFontSize
-
in file fpdf.php, method FPDF::SetFontSize()
-
setHelpID
-
in file lists.inc, method lamSelectListOption::setHelpID()
    Sets the help ID.
-
setInheritMode
-
in file sambaMungedDial.inc, method sambaMungedDial::setInheritMode()
    sets Inherit-config-from-client value: enabled/disabled
-
setIsSingleValue
-
in file schema.inc, method AttributeType::setIsSingleValue()
    Sets whether this attribute is single-valued.
-
SetKeywords
-
in file fpdf.php, method FPDF::SetKeywords()
-
setlanguage
-
in file config.inc, function setlanguage()
    Sets language settings for automatic translation
-
SetLeftMargin
-
in file fpdf.php, method FPDF::SetLeftMargin()
-
SetLineWidth
-
in file fpdf.php, method FPDF::SetLineWidth()
-
SetLink
-
in file fpdf.php, method FPDF::SetLink()
-
SetMargins
-
in file fpdf.php, method FPDF::SetMargins()
-
setName
-
in file schema.inc, method AttributeType::setName()
    Sets this attriute's name.
-
setOID
-
in file schema.inc, method SchemaItem::setOID()
-
setOutputFormat
-
in file export.inc, method PlaExporter::setOutputFormat()
    Set the carriage return /linefeed for the export
-
setPassword
-
in file config.inc, method LAMCfgMain::setPassword()
    Sets a new config password.
-
setReConn
-
in file sambaMungedDial.inc, method sambaMungedDial::setReConn()
    sets Reconnection value: from any client/from previous client only
-
SetRightMargin
-
in file fpdf.php, method FPDF::SetRightMargin()
-
setShadow
-
in file sambaMungedDial.inc, method sambaMungedDial::setShadow()
    sets shadow value
-
SetSubject
-
in file fpdf.php, method FPDF::SetSubject()
-
setSupAttribute
-
in file schema.inc, method AttributeType::setSupAttribute()
    Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).
-
SetTextColor
-
in file fpdf.php, method FPDF::SetTextColor()
-
SetTitle
-
in file fpdf.php, method FPDF::SetTitle()
-
SetTopMargin
-
in file fpdf.php, method FPDF::SetTopMargin()
-
setTsLogin
-
in file sambaMungedDial.inc, method sambaMungedDial::setTsLogin()
    Sets Terminal-Server-Login value: enabled/disabled
-
setType
-
in file schema.inc, method AttributeType::setType()
    Sets this attribute's type.
-
setUsedByAttrs
-
in file schema.inc, method MatchingRule::setUsedByAttrs()
    Sets the list of used_by_attrs to the array specified by $attrs;
-
setValue
-
in file lists.inc, method lamListOption::setValue()
    Sets the config option value. The value must not contain "=" and ";".
-
SetX
-
in file fpdf.php, method FPDF::SetX()
-
SetXY
-
in file fpdf.php, method FPDF::SetXY()
-
SetY
-
in file fpdf.php, method FPDF::SetY()
-
set_AccountModules
-
in file config.inc, method LAMConfig::set_AccountModules()
    Sets the selected account modules
-
set_ActiveTypes
-
in file config.inc, method LAMConfig::set_ActiveTypes()
    Sets the list of active types.
-
set_Adminstring
-
in file config.inc, method LAMConfig::set_Adminstring()
    Sets the admin string
-
set_cached_schema
-
in file schema.inc, function set_cached_schema()
    Caches the specified $schema_type.
-
set_cacheTimeout
-
in file config.inc, method LAMConfig::set_cacheTimeout()
    Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)
-
set_defaultLanguage
-
in file config.inc, method LAMConfig::set_defaultLanguage()
    Sets the default language string
-
set_listAttributes
-
in file config.inc, method LAMConfig::set_listAttributes()
    Sets the list of attributes to show in user list
-
set_moduleSettings
-
in file config.inc, method LAMConfig::set_moduleSettings()
    Sets the settings for the account modules.
-
set_Passwd
-
in file config.inc, method LAMConfig::set_Passwd()
    Sets the preferences wizard password
-
set_schema_cache_unavailable
-
in file schema.inc, function set_schema_cache_unavailable()
    Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.
-
set_scriptPath
-
in file config.inc, method LAMConfig::set_scriptPath()
    Sets the path to the external script
-
set_scriptRights
-
in file config.inc, method LAMConfig::set_scriptRights()
    Sets the rights for the home directory.
-
set_scriptServers
-
in file config.inc, method LAMConfig::set_scriptServers()
    Sets the servers of the external script
-
set_ServerURL
-
in file config.inc, method LAMConfig::set_ServerURL()
    Sets the server address
-
set_Suffix
-
in file config.inc, method LAMConfig::set_Suffix()
    Sets the LDAP suffix where accounts are saved
-
set_typeSettings
-
in file config.inc, method LAMConfig::set_typeSettings()
    Sets the settings for the account types.
-
shadowAccount
-
in file shadowAccount.inc, class shadowAccount
    Manages the object class "shadowAccount" for users.
-
showColumnData
-
in file masscreate.php, function showColumnData()
    Prints the properties of one input field.
-
showMainPage
-
in file masscreate.php, function showMainPage()
    Displays the acount type specific main page of the upload.
-
showPage
-
in file lists.inc, method lamList::showPage()
    Prints the HTML code to display the list view.
-
smbDomain
-
in file smbDomain.inc, class smbDomain
    The account type for Samba domains.
-
smbflag
-
in file account.inc, function smbflag()
    Takes a list of Samba flags and creates the corresponding flag string.
-
smbHash
-
in file createntlm.inc, class smbHash
    Calculates NT and LM hashes.
-
sortAttrs
-
in file tree.inc, function sortAttrs()
-
sortModules
-
in file modules.inc, method accountContainer::sortModules()
    Sorts the module buttons for the account page.
-
startSecureSession
-
in file security.inc, function startSecureSession()
    Starts a session and checks the environment.
-
StatusMessage
-
in file status.inc, function StatusMessage()
    This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.
-
strhex
-
in file sambaMungedDial.inc, method sambaMungedDial::strhex()
    strhex
-
strlen
-
in file ufpdf.php, method UFPDF::strlen()
-
Syntax
-
in file schema.inc, class Syntax
    Represents an LDAP Syntax
-
Syntax
-
in file schema.inc, method Syntax::Syntax()
    Creates a new Syntax object from a raw LDAP syntax string.
-
schema.php
-
procedural page schema.php
-
schemaTest.php
-
procedural page schemaTest.php
-
status-test.php
-
procedural page status-test.php
-
-
- top
-
- -
-

t

-
-
$TextColor
-
in file fpdf.php, variable FPDF::$TextColor
-
$title
-
in file fpdf.php, variable FPDF::$title
-
$tMargin
-
in file fpdf.php, variable FPDF::$tMargin
-
$type
-
in file schema.inc, variable AttributeType::$type
    A string description of the syntax type (taken from the LDAPSyntaxes)
-
$type
-
in file lists.inc, variable lamList::$type
    Account type
-
$type
-
in file schema.inc, variable ObjectClass::$type
    one of STRUCTURAL, ABSTRACT, or AUXILIARY
-
tree.inc
-
procedural page tree.inc
-
types.inc
-
procedural page types.inc
-
tools.php
-
procedural page tools.php
-
templates.inc
-
procedural page templates.inc
-
tree.php
-
procedural page tree.php
-
tree_view.php
-
procedural page tree_view.php
-
Text
-
in file ufpdf.php, method UFPDF::Text()
-
Text
-
in file fpdf.php, method FPDF::Text()
-
to8bit
-
in file sambaMungedDial.inc, method sambaMungedDial::to8bit()
    to8bit
-
TRANS_PRIMARY_OPTION_NAME
-
in file user.inc, class constant lamUserList::TRANS_PRIMARY_OPTION_NAME
    ID for config option
-
TRANS_PRIMARY_OPTION_NAME
-
in file group.inc, class constant lamGroupList::TRANS_PRIMARY_OPTION_NAME
    ID for config option
-
-
- top
-
- -
-

u

-
-
$underline
-
in file fpdf.php, variable FPDF::$underline
-
$usage
-
in file schema.inc, variable AttributeType::$usage
    The usage string set by the LDAP schema
-
$used_by_attrs
-
in file schema.inc, variable MatchingRule::$used_by_attrs
    An array of attribute names who use this MatchingRule
-
$used_by_attrs
-
in file schema.inc, variable MatchingRuleUse::$used_by_attrs
    An array of attributeType names who make use of the mathingRule
-
$used_in_object_classes
-
in file schema.inc, variable AttributeType::$used_in_object_classes
    An array of objectClasses which use this attributeType (must be set by caller)
-
user.inc
-
procedural page user.inc
-
ufpdf.php
-
procedural page ufpdf.php
-
userlink.php
-
procedural page userlink.php
-
update.php
-
procedural page update.php
-
update_confirm.php
-
procedural page update_confirm.php
-
UFPDF
-
in file ufpdf.php, method UFPDF::UFPDF()
    *****************************************************************************
-
UFPDF
-
in file ufpdf.php, class UFPDF
    Main UFPDF class for creating Unicode PDF documents
-
UFPDF_VERSION
-
in file ufpdf.php, constant UFPDF_VERSION
    *****************************************************************************
-
user
-
in file user.inc, class user
    The account type for user accounts (e.g. Unix, Samba and Kolab).
-
utf8_substr
-
in file ufpdf.php, method UFPDF::utf8_substr()
-
utf8_to_codepoints
-
in file ufpdf.php, method UFPDF::utf8_to_codepoints()
-
utf8_to_utf16be
-
in file ufpdf.php, method UFPDF::utf8_to_utf16be()
-
-
- top
-
- -
-

v

-
-
$vcardMapping
-
in file export.inc, variable PlaVcardExporter::$vcardMapping
-
vera.php
-
procedural page vera.php
-
verab.php
-
procedural page verab.php
-
verabi.php
-
procedural page verabi.php
-
verai.php
-
procedural page verai.php
-
-
- top
-
- -
-

w

-
-
$w
-
in file fpdf.php, variable FPDF::$w
-
$wPt
-
in file fpdf.php, variable FPDF::$wPt
-
$ws
-
in file fpdf.php, variable FPDF::$ws
-
Write
-
in file ufpdf.php, method UFPDF::Write()
-
Write
-
in file fpdf.php, method FPDF::Write()
-
-
- top
-
- -
-

x

-
-
$x
-
in file fpdf.php, variable FPDF::$x
-
xml_parser.inc
-
procedural page xml_parser.inc
-
xmlParser
-
in file xml_parser.inc, class xmlParser
-
-
- top
-
- -
-

y

-
-
$y
-
in file fpdf.php, variable FPDF::$y
-
-
- top
-
- -
-

z

-
-
$ZoomMode
-
in file fpdf.php, variable FPDF::$ZoomMode
-
-
- top
-
- -
-

_

-
-
_beginpage
-
in file fpdf.php, method FPDF::_beginpage()
-
_dochecks
-
in file fpdf.php, method FPDF::_dochecks()
    *****************************************************************************
-
_dounderline
-
in file ufpdf.php, method UFPDF::_dounderline()
-
_dounderline
-
in file fpdf.php, method FPDF::_dounderline()
-
_enddoc
-
in file fpdf.php, method FPDF::_enddoc()
-
_endpage
-
in file fpdf.php, method FPDF::_endpage()
-
_escape
-
in file fpdf.php, method FPDF::_escape()
-
_escapetext
-
in file ufpdf.php, method UFPDF::_escapetext()
-
_freadint
-
in file fpdf.php, method FPDF::_freadint()
-
_getfontpath
-
in file fpdf.php, method FPDF::_getfontpath()
-
_get_raw_schema
-
in file schema.inc, function _get_raw_schema()
    Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".
-
_get_schema_dn
-
in file schema.inc, function _get_schema_dn()
    Helper for _get_raw_schema() which fetches the DN of the schema object
-
_newobj
-
in file fpdf.php, method FPDF::_newobj()
-
_out
-
in file fpdf.php, method FPDF::_out()
-
_parsejpg
-
in file fpdf.php, method FPDF::_parsejpg()
-
_parsepng
-
in file fpdf.php, method FPDF::_parsepng()
-
_putcatalog
-
in file fpdf.php, method FPDF::_putcatalog()
-
_putfonts
-
in file fpdf.php, method FPDF::_putfonts()
-
_putheader
-
in file fpdf.php, method FPDF::_putheader()
-
_putimages
-
in file fpdf.php, method FPDF::_putimages()
-
_putinfo
-
in file fpdf.php, method FPDF::_putinfo()
-
_putinfo
-
in file ufpdf.php, method UFPDF::_putinfo()
-
_putpages
-
in file fpdf.php, method FPDF::_putpages()
-
_putpages
-
in file ufpdf.php, method UFPDF::_putpages()
-
_putresourcedict
-
in file fpdf.php, method FPDF::_putresourcedict()
-
_putresources
-
in file fpdf.php, method FPDF::_putresources()
-
_putstream
-
in file fpdf.php, method FPDF::_putstream()
-
_puttrailer
-
in file fpdf.php, method FPDF::_puttrailer()
-
_puttruetypeunicode
-
in file ufpdf.php, method UFPDF::_puttruetypeunicode()
    *****************************************************************************
-
_putxobjectdict
-
in file fpdf.php, method FPDF::_putxobjectdict()
-
_textstring
-
in file ufpdf.php, method UFPDF::_textstring()
-
_textstring
-
in file fpdf.php, method FPDF::_textstring()
-
__construct
-
in file sambaGroupMapping.inc, method sambaGroupMapping::__construct()
    Creates a new module for Samba 3 groups.
-
__construct
-
in file sambaAccount.inc, method sambaAccount::__construct()
    Creates a new sambaAccount object.
-
__construct
-
in file modules.inc, method accountContainer::__construct()
    Constructor
-
__construct
-
in file sambaSamAccount.inc, method sambaSamAccount::__construct()
    Creates a new sambaSamAccount object.
-
__construct
-
in file xml_parser.inc, method xmlParser::__construct()
    Constructor
-
__construct
-
in file smbDomain.inc, method lamSmbDomainList::__construct()
    Constructor
-
__construct
-
in file selfService.inc, method selfServiceProfile::__construct()
    Constructor
-
__construct
-
in file user.inc, method lamUserList::__construct()
    Constructor
-
__construct
-
in file mailAlias.inc, method lamMailAliasList::__construct()
    Constructor
-
__construct
-
in file group.inc, method lamGroupList::__construct()
    Constructor
-
__construct
-
in file host.inc, method lamHostList::__construct()
    Constructor
-
__construct
-
in file kolabUser.inc, method kolabUser::__construct()
    Creates a new kolabUser object.
-
__construct
-
in file lamPDF.inc, method lamPDF::__construct()
-
__construct
-
in file baseModule.inc, method baseModule::__construct()
    Creates a new base module class
-
__construct
-
in file config.inc, method LAMConfig::__construct()
    Loads preferences from config file
-
__construct
-
in file cache.inc, method cache::__construct()
    Constructor.
-
__construct
-
in file config.inc, method LAMCfgMain::__construct()
    Loads preferences from config file
-
__construct
-
in file lists.inc, method lamSelectListOption::__construct()
    Creates a new selection list option.
-
__construct
-
in file ldap.inc, method Ldap::__construct()
-
__construct
-
in file lists.inc, method lamListTool::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamList::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamListOption::__construct()
    Creates a new config option.
-
__construct
-
in file lists.inc, method lamBooleanListOption::__construct()
    Creates a new boolean option.
-
__sleep
-
in file cache.inc, method cache::__sleep()
    Encrypts LDAP cache before saving to session file.
-
__sleep
-
in file modules.inc, method accountContainer::__sleep()
    Encrypts sensitive data before storing in session.
-
__sleep
-
in file ldap.inc, method Ldap::__sleep()
    Closes connection to LDAP server before serialization
-
__wakeup
-
in file ldap.inc, method Ldap::__wakeup()
    Reconnects to LDAP server when deserialized
-
__wakeup
-
in file cache.inc, method cache::__wakeup()
    Decrypts LDAP cache after loading from session file.
-
__wakeup
-
in file modules.inc, method accountContainer::__wakeup()
    Decrypts sensitive data after accountContainer was loaded from session.
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_Help.html b/lam-web/developers/devel/phpdoc/elementindex_Help.html deleted file mode 100644 index 04ff5782..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_Help.html +++ /dev/null @@ -1,111 +0,0 @@ - - -Package Help Element Index - - - - - - - - - - - - - -
Help
- - - [ class tree: Help ] - [ index: Help ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package Help

- [ d ] - [ e ] - [ h ] - -
- -
-

d

-
-
displayHelp
-
in file help.php, function displayHelp()
    Print help site for a specific help number.
-
-
- top
-
- -
-

e

-
-
echoHTMLFoot
-
in file help.php, function echoHTMLFoot()
    Print HTML footer of the help page.
-
echoHTMLHead
-
in file help.php, function echoHTMLHead()
    Print HTML header of the help page.
-
-
- top
-
- -
-

h

-
-
help.inc
-
procedural page help.inc
-
help.php
-
procedural page help.php
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_LDAP.html b/lam-web/developers/devel/phpdoc/elementindex_LDAP.html deleted file mode 100644 index 08932b84..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_LDAP.html +++ /dev/null @@ -1,183 +0,0 @@ - - -Package LDAP Element Index - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package LDAP

- [ c ] - [ d ] - [ e ] - [ h ] - [ l ] - [ n ] - [ s ] - [ _ ] - -
- -
-

_

-
-
__construct
-
in file ldap.inc, method Ldap::__construct()
-
__sleep
-
in file ldap.inc, method Ldap::__sleep()
    Closes connection to LDAP server before serialization
-
__wakeup
-
in file ldap.inc, method Ldap::__wakeup()
    Reconnects to LDAP server when deserialized
-
-
- top
-
- -
-

c

-
-
close
-
in file ldap.inc, method Ldap::close()
    Closes connection to server
-
cmp_array
-
in file ldap.inc, method Ldap::cmp_array()
    Helper function to sort the unit DNs
-
connect
-
in file ldap.inc, method Ldap::connect()
    Connects to the server using the given username and password
-
-
- top
-
- -
-

d

-
-
decrypt
-
in file ldap.inc, method Ldap::decrypt()
    Decrypts a string
-
decrypt_login
-
in file ldap.inc, method Ldap::decrypt_login()
    Decrypts username and password
-
destroy
-
in file ldap.inc, method Ldap::destroy()
    Closes connection to LDAP server and deletes encrypted username/password
-
-
- top
-
- -
-

e

-
-
encrypt
-
in file ldap.inc, method Ldap::encrypt()
    Encrypts a string
-
encrypt_login
-
in file ldap.inc, method Ldap::encrypt_login()
    Encrypts username and password
-
-
- top
-
- -
-

h

-
-
hex2bin
-
in file ldap.inc, function hex2bin()
    Converts a HEX string to a binary value
-
-
- top
-
- -
-

l

-
-
Ldap
-
in file ldap.inc, class Ldap
    Ldap manages connection to LDAP and includes several helper functions.
-
ldap.inc
-
procedural page ldap.inc
-
-
- top
-
- -
-

n

-
-
new_rand
-
in file ldap.inc, method Ldap::new_rand()
    Calculates a new value for rand
-
-
- top
-
- -
-

s

-
-
search_units
-
in file ldap.inc, method Ldap::search_units()
    Returns an array with all organizational units under the given suffix
-
server
-
in file ldap.inc, method Ldap::server()
    Returns the LDAP connection handle
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_PDF.html b/lam-web/developers/devel/phpdoc/elementindex_PDF.html deleted file mode 100644 index 68a35f40..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_PDF.html +++ /dev/null @@ -1,697 +0,0 @@ - - -Package PDF Element Index - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package PDF

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ h ] - [ i ] - [ k ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ r ] - [ s ] - [ t ] - [ u ] - [ v ] - [ w ] - [ x ] - [ y ] - [ z ] - [ _ ] - -
- -
-

_

-
-
_beginpage
-
in file fpdf.php, method FPDF::_beginpage()
-
_dochecks
-
in file fpdf.php, method FPDF::_dochecks()
    *****************************************************************************
-
_dounderline
-
in file fpdf.php, method FPDF::_dounderline()
-
_dounderline
-
in file ufpdf.php, method UFPDF::_dounderline()
-
_enddoc
-
in file fpdf.php, method FPDF::_enddoc()
-
_endpage
-
in file fpdf.php, method FPDF::_endpage()
-
_escape
-
in file fpdf.php, method FPDF::_escape()
-
_escapetext
-
in file ufpdf.php, method UFPDF::_escapetext()
-
_freadint
-
in file fpdf.php, method FPDF::_freadint()
-
_getfontpath
-
in file fpdf.php, method FPDF::_getfontpath()
-
_newobj
-
in file fpdf.php, method FPDF::_newobj()
-
_out
-
in file fpdf.php, method FPDF::_out()
-
_parsejpg
-
in file fpdf.php, method FPDF::_parsejpg()
-
_parsepng
-
in file fpdf.php, method FPDF::_parsepng()
-
_putcatalog
-
in file fpdf.php, method FPDF::_putcatalog()
-
_putfonts
-
in file fpdf.php, method FPDF::_putfonts()
-
_putheader
-
in file fpdf.php, method FPDF::_putheader()
-
_putimages
-
in file fpdf.php, method FPDF::_putimages()
-
_putinfo
-
in file fpdf.php, method FPDF::_putinfo()
-
_putinfo
-
in file ufpdf.php, method UFPDF::_putinfo()
-
_putpages
-
in file ufpdf.php, method UFPDF::_putpages()
-
_putpages
-
in file fpdf.php, method FPDF::_putpages()
-
_putresourcedict
-
in file fpdf.php, method FPDF::_putresourcedict()
-
_putresources
-
in file fpdf.php, method FPDF::_putresources()
-
_putstream
-
in file fpdf.php, method FPDF::_putstream()
-
_puttrailer
-
in file fpdf.php, method FPDF::_puttrailer()
-
_puttruetypeunicode
-
in file ufpdf.php, method UFPDF::_puttruetypeunicode()
    *****************************************************************************
-
_putxobjectdict
-
in file fpdf.php, method FPDF::_putxobjectdict()
-
_textstring
-
in file ufpdf.php, method UFPDF::_textstring()
-
_textstring
-
in file fpdf.php, method FPDF::_textstring()
-
__construct
-
in file xml_parser.inc, method xmlParser::__construct()
    Constructor
-
__construct
-
in file lamPDF.inc, method lamPDF::__construct()
-
-
- top
-
- -
-

a

-
-
$AliasNbPages
-
in file fpdf.php, variable FPDF::$AliasNbPages
-
$author
-
in file fpdf.php, variable FPDF::$author
-
$AutoPageBreak
-
in file fpdf.php, variable FPDF::$AutoPageBreak
-
AcceptPageBreak
-
in file fpdf.php, method FPDF::AcceptPageBreak()
-
AcceptPageBreak
-
in file ufpdf.php, method UFPDF::AcceptPageBreak()
-
AddFont
-
in file ufpdf.php, method UFPDF::AddFont()
-
AddFont
-
in file fpdf.php, method FPDF::AddFont()
-
AddLink
-
in file fpdf.php, method FPDF::AddLink()
-
AddPage
-
in file fpdf.php, method FPDF::AddPage()
-
AliasNbPages
-
in file ufpdf.php, method UFPDF::AliasNbPages()
-
AliasNbPages
-
in file fpdf.php, method FPDF::AliasNbPages()
-
-
- top
-
- -
-

b

-
-
$bMargin
-
in file fpdf.php, variable FPDF::$bMargin
-
$buffer
-
in file fpdf.php, variable FPDF::$buffer
-
-
- top
-
- -
-

c

-
-
$cMargin
-
in file fpdf.php, variable FPDF::$cMargin
-
$ColorFlag
-
in file fpdf.php, variable FPDF::$ColorFlag
-
$compress
-
in file fpdf.php, variable FPDF::$compress
-
$CoreFonts
-
in file fpdf.php, variable FPDF::$CoreFonts
-
$creator
-
in file fpdf.php, variable FPDF::$creator
-
$CurOrientation
-
in file fpdf.php, variable FPDF::$CurOrientation
-
$CurrentFont
-
in file fpdf.php, variable FPDF::$CurrentFont
-
Cell
-
in file fpdf.php, method FPDF::Cell()
-
Cell
-
in file ufpdf.php, method UFPDF::Cell()
-
Close
-
in file fpdf.php, method FPDF::Close()
-
code2utf
-
in file ufpdf.php, method UFPDF::code2utf()
-
createModulePDF
-
in file pdf.inc, function createModulePDF()
    This function creates the PDF output of one or more accounts. At the moment this function can create a PDF page for user, group and host accounts. But this is not limited by the function itself but by the account types that are allowed in LAM and the exsisting PDF structure definitions.
-
-
- top
-
- -
-

d

-
-
$DefOrientation
-
in file fpdf.php, variable FPDF::$DefOrientation
-
$diffs
-
in file fpdf.php, variable FPDF::$diffs
-
$DrawColor
-
in file fpdf.php, variable FPDF::$DrawColor
-
deletePDFStructureDefinition
-
in file pdfstruct.inc, function deletePDFStructureDefinition()
    Deletes XML file with PDF structure definitions.
-
-
- top
-
- -
-

e

-
-
Error
-
in file fpdf.php, method FPDF::Error()
-
-
- top
-
- -
-

f

-
-
$fh
-
in file fpdf.php, variable FPDF::$fh
-
$fhPt
-
in file fpdf.php, variable FPDF::$fhPt
-
$FillColor
-
in file fpdf.php, variable FPDF::$FillColor
-
$FontFamily
-
in file fpdf.php, variable FPDF::$FontFamily
-
$FontFiles
-
in file fpdf.php, variable FPDF::$FontFiles
-
$fonts
-
in file fpdf.php, variable FPDF::$fonts
-
$FontSize
-
in file fpdf.php, variable FPDF::$FontSize
-
$FontSizePt
-
in file fpdf.php, variable FPDF::$FontSizePt
-
$FontStyle
-
in file fpdf.php, variable FPDF::$FontStyle
-
$fw
-
in file fpdf.php, variable FPDF::$fw
-
$fwPt
-
in file fpdf.php, variable FPDF::$fwPt
-
Footer
-
in file fpdf.php, method FPDF::Footer()
-
footer
-
in file lamPDF.inc, method lamPDF::footer()
-
FPDF
-
in file fpdf.php, method FPDF::FPDF()
    *****************************************************************************
-
FPDF
-
in file fpdf.php, class FPDF
    Main FPDF class for creating PDF documents
-
FPDF_VERSION
-
in file fpdf.php, constant FPDF_VERSION
    *****************************************************************************
-
fpdf.php
-
procedural page fpdf.php
-
-
- top
-
- -
-

g

-
-
getAvailableLogos
-
in file pdfstruct.inc, function getAvailableLogos()
    This function returns an array with all aviliable logo images.
-
getPDFStructureDefinitions
-
in file pdfstruct.inc, function getPDFStructureDefinitions()
    This function will return all available PDF structure definitions for the submitted account scope.
-
getSectionHeadline
-
in file pdf.inc, function getSectionHeadline()
    Creates a section headline.
-
GetStringWidth
-
in file ufpdf.php, method UFPDF::GetStringWidth()
-
GetStringWidth
-
in file fpdf.php, method FPDF::GetStringWidth()
-
GetX
-
in file fpdf.php, method FPDF::GetX()
-
GetY
-
in file fpdf.php, method FPDF::GetY()
-
-
- top
-
- -
-

h

-
-
$h
-
in file fpdf.php, variable FPDF::$h
-
$hPt
-
in file fpdf.php, variable FPDF::$hPt
-
header
-
in file lamPDF.inc, method lamPDF::header()
-
Header
-
in file fpdf.php, method FPDF::Header()
-
-
- top
-
- -
-

i

-
-
$images
-
in file fpdf.php, variable FPDF::$images
-
$InFooter
-
in file fpdf.php, variable FPDF::$InFooter
-
Image
-
in file fpdf.php, method FPDF::Image()
-
-
- top
-
- -
-

k

-
-
$k
-
in file fpdf.php, variable FPDF::$k
-
$keywords
-
in file fpdf.php, variable FPDF::$keywords
-
-
- top
-
- -
-

l

-
-
$lasth
-
in file fpdf.php, variable FPDF::$lasth
-
$LayoutMode
-
in file fpdf.php, variable FPDF::$LayoutMode
-
$LineWidth
-
in file fpdf.php, variable FPDF::$LineWidth
-
$links
-
in file fpdf.php, variable FPDF::$links
-
$lMargin
-
in file fpdf.php, variable FPDF::$lMargin
-
lamPDF
-
in file lamPDF.inc, class lamPDF
    Creates a LAM information page in PDF format.
-
LAMPDF_LINEWIDTH
-
in file pdf.inc, constant LAMPDF_LINEWIDTH
    PDF line width
-
lamPDF.inc
-
procedural page lamPDF.inc
-
Line
-
in file fpdf.php, method FPDF::Line()
-
Link
-
in file fpdf.php, method FPDF::Link()
-
Ln
-
in file fpdf.php, method FPDF::Ln()
-
loadPDFStructureDefinitions
-
in file pdfstruct.inc, function loadPDFStructureDefinitions()
    This function is used to get pdf structure from xml file.
-
-
- top
-
- -
-

m

-
-
MultiCell
-
in file ufpdf.php, method UFPDF::MultiCell()
-
MultiCell
-
in file fpdf.php, method FPDF::MultiCell()
-
-
- top
-
- -
-

n

-
-
$n
-
in file fpdf.php, variable FPDF::$n
-
-
- top
-
- -
-

o

-
-
$offsets
-
in file fpdf.php, variable FPDF::$offsets
-
$OrientationChanges
-
in file fpdf.php, variable FPDF::$OrientationChanges
-
Open
-
in file fpdf.php, method FPDF::Open()
-
Output
-
in file fpdf.php, method FPDF::Output()
-
-
- top
-
- -
-

p

-
-
$page
-
in file fpdf.php, variable FPDF::$page
-
$PageBreakTrigger
-
in file fpdf.php, variable FPDF::$PageBreakTrigger
-
$PageLinks
-
in file fpdf.php, variable FPDF::$PageLinks
-
$pages
-
in file fpdf.php, variable FPDF::$pages
-
$PDFVersion
-
in file fpdf.php, variable FPDF::$PDFVersion
-
pdf.inc
-
procedural page pdf.inc
-
pdfstruct.inc
-
procedural page pdfstruct.inc
-
PageNo
-
in file fpdf.php, method FPDF::PageNo()
-
parse
-
in file xml_parser.inc, method xmlParser::parse()
-
processAttributes
-
in file pdf.inc, function processAttributes()
    Processes width, height and alignment attributes.
-
processFormatTags
-
in file pdf.inc, function processFormatTags()
    Formats the XML code.
-
processLine
-
in file pdf.inc, function processLine()
    Creates the XML code for an PDF entry.
-
pdfdelete.php
-
procedural page pdfdelete.php
-
pdfmain.php
-
procedural page pdfmain.php
-
pdfpage.php
-
procedural page pdfpage.php
-
-
- top
-
- -
-

r

-
-
$rMargin
-
in file fpdf.php, variable FPDF::$rMargin
-
Rect
-
in file fpdf.php, method FPDF::Rect()
-
-
- top
-
- -
-

s

-
-
$state
-
in file fpdf.php, variable FPDF::$state
-
$subject
-
in file fpdf.php, variable FPDF::$subject
-
savePDFStructureDefinitions
-
in file pdfstruct.inc, function savePDFStructureDefinitions()
    Saves PDF structure definitions to XML file in format: <name>.<scope>.xml
-
SetAuthor
-
in file fpdf.php, method FPDF::SetAuthor()
-
SetAutoPageBreak
-
in file fpdf.php, method FPDF::SetAutoPageBreak()
-
SetCompression
-
in file fpdf.php, method FPDF::SetCompression()
-
SetCreator
-
in file fpdf.php, method FPDF::SetCreator()
-
SetDisplayMode
-
in file fpdf.php, method FPDF::SetDisplayMode()
-
SetDrawColor
-
in file fpdf.php, method FPDF::SetDrawColor()
-
SetFillColor
-
in file fpdf.php, method FPDF::SetFillColor()
-
SetFont
-
in file fpdf.php, method FPDF::SetFont()
-
SetFontSize
-
in file fpdf.php, method FPDF::SetFontSize()
-
SetKeywords
-
in file fpdf.php, method FPDF::SetKeywords()
-
SetLeftMargin
-
in file fpdf.php, method FPDF::SetLeftMargin()
-
SetLineWidth
-
in file fpdf.php, method FPDF::SetLineWidth()
-
SetLink
-
in file fpdf.php, method FPDF::SetLink()
-
SetMargins
-
in file fpdf.php, method FPDF::SetMargins()
-
SetRightMargin
-
in file fpdf.php, method FPDF::SetRightMargin()
-
SetSubject
-
in file fpdf.php, method FPDF::SetSubject()
-
SetTextColor
-
in file fpdf.php, method FPDF::SetTextColor()
-
SetTitle
-
in file fpdf.php, method FPDF::SetTitle()
-
SetTopMargin
-
in file fpdf.php, method FPDF::SetTopMargin()
-
SetX
-
in file fpdf.php, method FPDF::SetX()
-
SetXY
-
in file fpdf.php, method FPDF::SetXY()
-
SetY
-
in file fpdf.php, method FPDF::SetY()
-
strlen
-
in file ufpdf.php, method UFPDF::strlen()
-
-
- top
-
- -
-

t

-
-
$TextColor
-
in file fpdf.php, variable FPDF::$TextColor
-
$title
-
in file fpdf.php, variable FPDF::$title
-
$tMargin
-
in file fpdf.php, variable FPDF::$tMargin
-
Text
-
in file ufpdf.php, method UFPDF::Text()
-
Text
-
in file fpdf.php, method FPDF::Text()
-
-
- top
-
- -
-

u

-
-
$underline
-
in file fpdf.php, variable FPDF::$underline
-
ufpdf.php
-
procedural page ufpdf.php
-
UFPDF
-
in file ufpdf.php, method UFPDF::UFPDF()
    *****************************************************************************
-
UFPDF
-
in file ufpdf.php, class UFPDF
    Main UFPDF class for creating Unicode PDF documents
-
UFPDF_VERSION
-
in file ufpdf.php, constant UFPDF_VERSION
    *****************************************************************************
-
utf8_substr
-
in file ufpdf.php, method UFPDF::utf8_substr()
-
utf8_to_codepoints
-
in file ufpdf.php, method UFPDF::utf8_to_codepoints()
-
utf8_to_utf16be
-
in file ufpdf.php, method UFPDF::utf8_to_utf16be()
-
-
- top
-
- -
-

v

-
-
vera.php
-
procedural page vera.php
-
verab.php
-
procedural page verab.php
-
verabi.php
-
procedural page verabi.php
-
verai.php
-
procedural page verai.php
-
-
- top
-
- -
-

w

-
-
$w
-
in file fpdf.php, variable FPDF::$w
-
$wPt
-
in file fpdf.php, variable FPDF::$wPt
-
$ws
-
in file fpdf.php, variable FPDF::$ws
-
Write
-
in file ufpdf.php, method UFPDF::Write()
-
Write
-
in file fpdf.php, method FPDF::Write()
-
-
- top
-
- -
-

x

-
-
$x
-
in file fpdf.php, variable FPDF::$x
-
xml_parser.inc
-
procedural page xml_parser.inc
-
xmlParser
-
in file xml_parser.inc, class xmlParser
-
-
- top
-
- -
-

y

-
-
$y
-
in file fpdf.php, variable FPDF::$y
-
-
- top
-
- -
-

z

-
-
$ZoomMode
-
in file fpdf.php, variable FPDF::$ZoomMode
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_configuration.html b/lam-web/developers/devel/phpdoc/elementindex_configuration.html deleted file mode 100644 index f7c0f3b2..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_configuration.html +++ /dev/null @@ -1,316 +0,0 @@ - - -Package configuration Element Index - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package configuration

- [ a ] - [ c ] - [ d ] - [ g ] - [ i ] - [ l ] - [ m ] - [ p ] - [ s ] - [ _ ] - -
- -
-

_

-
-
__construct
-
in file config.inc, method LAMConfig::__construct()
    Loads preferences from config file
-
__construct
-
in file config.inc, method LAMCfgMain::__construct()
    Loads preferences from config file
-
-
- top
-
- -
-

a

-
-
$allowedHosts
-
in file config.inc, variable LAMCfgMain::$allowedHosts
    list of hosts which may access LAM
-
ACCESS_ALL
-
in file config.inc, class constant LAMConfig::ACCESS_ALL
-
ACCESS_PASSWORD_CHANGE
-
in file config.inc, class constant LAMConfig::ACCESS_PASSWORD_CHANGE
-
ACCESS_READ_ONLY
-
in file config.inc, class constant LAMConfig::ACCESS_READ_ONLY
-
-
- top
-
- -
-

c

-
-
checkChmod
-
in file config.inc, function checkChmod()
    Checks whether a specific flag in the rights string is set.
-
checkPassword
-
in file config.inc, method LAMCfgMain::checkPassword()
    Checks if the given password matches.
-
check_Passwd
-
in file config.inc, method LAMConfig::check_Passwd()
    Checks if the given password matches.
-
config_showAccountModules
-
in file confmodules.php, function config_showAccountModules()
    Displays the module selection boxes and checks if dependencies are fulfilled.
-
config.inc
-
procedural page config.inc
-
conflogin.php
-
procedural page conflogin.php
-
confmain.php
-
procedural page confmain.php
-
confmodules.php
-
procedural page confmodules.php
-
conftypes.php
-
procedural page conftypes.php
-
-
- top
-
- -
-

d

-
-
$default
-
in file config.inc, variable LAMCfgMain::$default
    Default profile
-
-
- top
-
- -
-

g

-
-
getAccessLevel
-
in file config.inc, method LAMConfig::getAccessLevel()
    Returns the access level for this profile.
-
getConfigProfiles
-
in file config.inc, function getConfigProfiles()
    Returns an array of string with all available configuration profiles (without .conf)
-
getName
-
in file config.inc, method LAMConfig::getName()
    Returns the name of the config file
-
get_AccountModules
-
in file config.inc, method LAMConfig::get_AccountModules()
    Returns an array of all selected account modules
-
get_ActiveTypes
-
in file config.inc, method LAMConfig::get_ActiveTypes()
    Returns a list of active account types.
-
get_Admins
-
in file config.inc, method LAMConfig::get_Admins()
    Returns an array of string with all admin names
-
get_Adminstring
-
in file config.inc, method LAMConfig::get_Adminstring()
    Returns all admin users seperated by semicolons
-
get_cacheTimeout
-
in file config.inc, method LAMConfig::get_cacheTimeout()
    Returns the LDAP cache timeout in minutes
-
get_cacheTimeoutSec
-
in file config.inc, method LAMConfig::get_cacheTimeoutSec()
    Returns the LDAP cache timeout in seconds
-
get_defaultLanguage
-
in file config.inc, method LAMConfig::get_defaultLanguage()
    Returns the default language string
-
get_listAttributes
-
in file config.inc, method LAMConfig::get_listAttributes()
    Returns the list of attributes to show in user list
-
get_moduleSettings
-
in file config.inc, method LAMConfig::get_moduleSettings()
    Returns a list of saved module settings
-
get_scriptPath
-
in file config.inc, method LAMConfig::get_scriptPath()
    Returns the path to the external script
-
get_scriptRights
-
in file config.inc, method LAMConfig::get_scriptRights()
    Returns the chmod value for new home directories.
-
get_scriptServers
-
in file config.inc, method LAMConfig::get_scriptServers()
    Returns the servers of the external script as a Array
-
get_ServerURL
-
in file config.inc, method LAMConfig::get_ServerURL()
    Returns the server address as string
-
get_Suffix
-
in file config.inc, method LAMConfig::get_Suffix()
    Returns the LDAP suffix for the given account type
-
get_typeSettings
-
in file config.inc, method LAMConfig::get_typeSettings()
    Returns a list of saved type settings
-
-
- top
-
- -
-

i

-
-
isWritable
-
in file config.inc, method LAMConfig::isWritable()
    Returns if the file can be written on the filesystem.
-
index.php
-
procedural page index.php
-
-
- top
-
- -
-

l

-
-
$logDestination
-
in file config.inc, variable LAMCfgMain::$logDestination
    log destination ("SYSLOG":syslog, "/...":file, "NONE":none)
-
$logLevel
-
in file config.inc, variable LAMCfgMain::$logLevel
    log level
-
LAMCfgMain
-
in file config.inc, class LAMCfgMain
    This class manages config.cfg.
-
LAMConfig
-
in file config.inc, class LAMConfig
    This class manages .conf files.
-
LAMVersion
-
in file config.inc, function LAMVersion()
    Returns the version number of this LAM installation.
-
-
- top
-
- -
-

m

-
-
metaRefresh
-
in file config.inc, function metaRefresh()
    Prints a meta refresh page
-
mainlogin.php
-
procedural page mainlogin.php
-
mainmanage.php
-
procedural page mainmanage.php
-
-
- top
-
- -
-

p

-
-
profmanage.php
-
procedural page profmanage.php
-
-
- top
-
- -
-

s

-
-
$sessionTimeout
-
in file config.inc, variable LAMCfgMain::$sessionTimeout
    Time of inactivity before session times out (minutes)
-
save
-
in file config.inc, method LAMConfig::save()
    Saves preferences to config file
-
save
-
in file config.inc, method LAMCfgMain::save()
    Saves preferences to config file config.cfg
-
saveSettings
-
in file confmain.php, function saveSettings()
    Saves the entered settings.
-
setAccessLevel
-
in file config.inc, method LAMConfig::setAccessLevel()
    Sets the access level for this profile.
-
setlanguage
-
in file config.inc, function setlanguage()
    Sets language settings for automatic translation
-
setPassword
-
in file config.inc, method LAMCfgMain::setPassword()
    Sets a new config password.
-
set_AccountModules
-
in file config.inc, method LAMConfig::set_AccountModules()
    Sets the selected account modules
-
set_ActiveTypes
-
in file config.inc, method LAMConfig::set_ActiveTypes()
    Sets the list of active types.
-
set_Adminstring
-
in file config.inc, method LAMConfig::set_Adminstring()
    Sets the admin string
-
set_cacheTimeout
-
in file config.inc, method LAMConfig::set_cacheTimeout()
    Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)
-
set_defaultLanguage
-
in file config.inc, method LAMConfig::set_defaultLanguage()
    Sets the default language string
-
set_listAttributes
-
in file config.inc, method LAMConfig::set_listAttributes()
    Sets the list of attributes to show in user list
-
set_moduleSettings
-
in file config.inc, method LAMConfig::set_moduleSettings()
    Sets the settings for the account modules.
-
set_Passwd
-
in file config.inc, method LAMConfig::set_Passwd()
    Sets the preferences wizard password
-
set_scriptPath
-
in file config.inc, method LAMConfig::set_scriptPath()
    Sets the path to the external script
-
set_scriptRights
-
in file config.inc, method LAMConfig::set_scriptRights()
    Sets the rights for the home directory.
-
set_scriptServers
-
in file config.inc, method LAMConfig::set_scriptServers()
    Sets the servers of the external script
-
set_ServerURL
-
in file config.inc, method LAMConfig::set_ServerURL()
    Sets the server address
-
set_Suffix
-
in file config.inc, method LAMConfig::set_Suffix()
    Sets the LDAP suffix where accounts are saved
-
set_typeSettings
-
in file config.inc, method LAMConfig::set_typeSettings()
    Sets the settings for the account types.
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_lib.html b/lam-web/developers/devel/phpdoc/elementindex_lib.html deleted file mode 100644 index e7b49d11..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_lib.html +++ /dev/null @@ -1,561 +0,0 @@ - - -Package lib Element Index - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package lib

- [ a ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ i ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ r ] - [ s ] - [ t ] - [ u ] - [ _ ] - -
- -
-

_

-
-
_get_raw_schema
-
in file schema.inc, function _get_raw_schema()
    Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".
-
_get_schema_dn
-
in file schema.inc, function _get_schema_dn()
    Helper for _get_raw_schema() which fetches the DN of the schema object
-
__construct
-
in file cache.inc, method cache::__construct()
    Constructor.
-
__sleep
-
in file cache.inc, method cache::__sleep()
    Encrypts LDAP cache before saving to session file.
-
__wakeup
-
in file cache.inc, method cache::__wakeup()
    Decrypts LDAP cache after loading from session file.
-
-
- top
-
- -
-

a

-
-
$aliases
-
in file schema.inc, variable AttributeType::$aliases
    An array of alias attribute names, strings
-
addAlias
-
in file schema.inc, method AttributeType::addAlias()
    Adds an attribute name to the alias array.
-
addChildObjectClass
-
in file schema.inc, method ObjectClass::addChildObjectClass()
    Adds an objectClass to the list of objectClasses that inherit from this objectClass.
-
addMayAttrs
-
in file schema.inc, method ObjectClass::addMayAttrs()
    Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.
-
addMustAttrs
-
in file schema.inc, method ObjectClass::addMustAttrs()
    Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
-
addRequiredByObjectClass
-
in file schema.inc, method AttributeType::addRequiredByObjectClass()
    Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.
-
addUsedByAttr
-
in file schema.inc, method MatchingRule::addUsedByAttr()
    Adds an attribute name to the list of attributes who use this MatchingRule
-
addUsedInObjectClass
-
in file schema.inc, method AttributeType::addUsedInObjectClass()
    Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
-
add_aliases_to_attrs
-
in file schema.inc, function add_aliases_to_attrs()
    For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.
-
add_cache
-
in file cache.inc, method cache::add_cache()
    This function adds attributes to the cache.
-
add_sup_to_attrs
-
in file schema.inc, function add_sup_to_attrs()
    Adds inherited values to each attributeType specified by the SUP directive.
-
array_delete
-
in file account.inc, function array_delete()
    This function will return all values from $array without values of $values.
-
AttributeType
-
in file schema.inc, method AttributeType::AttributeType()
    Creates a new AttributeType objcet from a raw LDAP AttributeType string.
-
AttributeType
-
in file schema.inc, class AttributeType
    Represents an LDAP AttributeType
-
account.inc
-
procedural page account.inc
-
-
- top
-
- -
-

c

-
-
$children_objectclasses
-
in file schema.inc, variable ObjectClass::$children_objectclasses
    array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)
-
cache
-
in file cache.inc, class cache
    This class contains all functions which are needed to manage the LDAP cache.
-
cached_schema_available
-
in file schema.inc, function cached_schema_available()
    Returns true if the schema for $schema_type has been cached and
-
checkClientIP
-
in file security.inc, function checkClientIP()
    Checks if the client's IP address is on the list of allowed IPs.
-
checkIfPasswordChangeIsAllowed
-
in file security.inc, function checkIfPasswordChangeIsAllowed()
    Checks if passwords may be changed.
-
checkIfWriteAccessIsAllowed
-
in file security.inc, function checkIfWriteAccessIsAllowed()
    Checks if write access to LDAP is allowed.
-
cmp_domain
-
in file account.inc, function cmp_domain()
    Helper function to sort the domains
-
cache.inc
-
procedural page cache.inc
-
-
- top
-
- -
-

d

-
-
$description
-
in file schema.inc, variable SchemaItem::$description
    The description of this schema item.
-
-
- top
-
- -
-

e

-
-
$equality
-
in file schema.inc, variable AttributeType::$equality
    The equality rule used
-
-
- top
-
- -
-

f

-
-
findgroups
-
in file cache.inc, method cache::findgroups()
    This function returns an array with all group names which were found in the LDAP directory.
-
-
- top
-
- -
-

g

-
-
generateRandomPassword
-
in file account.inc, function generateRandomPassword()
    Generates a random password with 12 digits.
-
getAliases
-
in file schema.inc, method AttributeType::getAliases()
    Gets the names of attributes that are an alias for this attribute (if any).
-
getChildObjectClasses
-
in file schema.inc, method ObjectClass::getChildObjectClasses()
    Returns the array of objectClass names which inherit from this objectClass.
-
getdays
-
in file account.inc, function getdays()
    This function will return the days from 1.1.1970 until now.
-
getDescription
-
in file schema.inc, method SchemaItem::getDescription()
-
getEquality
-
in file schema.inc, method AttributeType::getEquality()
    Gets this attribute's equality string
-
getgid
-
in file cache.inc, method cache::getgid()
    This function will return the GID number to an existing group name (using the cache).
-
getgrnam
-
in file cache.inc, method cache::getgrnam()
    This function returns the group name to an existing gidNumber.
-
getIsCollective
-
in file schema.inc, method AttributeType::getIsCollective()
    Gets whether this attribute is collective.
-
getIsNoUserModification
-
in file schema.inc, method AttributeType::getIsNoUserModification()
    Gets whether this attribute is not modifiable by users.
-
getIsObsolete
-
in file schema.inc, method AttributeType::getIsObsolete()
    Gets whether this attribute has been flagged as obsolete by the LDAP server
-
getIsObsolete
-
in file schema.inc, method ObjectClass::getIsObsolete()
    Gets whether this objectClass is flagged as obsolete by the LDAP server.
-
getIsObsolete
-
in file schema.inc, method MatchingRule::getIsObsolete()
    Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
-
getIsSingleValue
-
in file schema.inc, method AttributeType::getIsSingleValue()
    Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
-
getMaxLength
-
in file schema.inc, method AttributeType::getMaxLength()
    Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.
-
getMayAttrNames
-
in file schema.inc, method ObjectClass::getMayAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.
-
getMayAttrs
-
in file schema.inc, method ObjectClass::getMayAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass may define.
-
getMustAttrNames
-
in file schema.inc, method ObjectClass::getMustAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.
-
getMustAttrs
-
in file schema.inc, method ObjectClass::getMustAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass must define.
-
getName
-
in file schema.inc, method MatchingRule::getName()
    Gets this MatchingRule's name.
-
getName
-
in file schema.inc, method MatchingRuleUse::getName()
    Gets this MatchingRuleUse's name
-
getName
-
in file schema.inc, method AttributeType::getName()
    Gets this attribute's name
-
getName
-
in file schema.inc, method ObjectClass::getName()
    Gets the name of this objectClass (ie, "inetOrgPerson")
-
getName
-
in file schema.inc, method ObjectClassAttribute::getName()
    Gets this attribute's name
-
getOID
-
in file schema.inc, method SchemaItem::getOID()
-
getOrdering
-
in file schema.inc, method AttributeType::getOrdering()
    Gets this attribute's ordering specification.
-
getRequiredByObjectClasses
-
in file schema.inc, method AttributeType::getRequiredByObjectClasses()
    Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.
-
getshells
-
in file account.inc, function getshells()
    Returns a list of shells listed in config/shells.
-
getSource
-
in file schema.inc, method ObjectClassAttribute::getSource()
    Gets the name of the ObjectClass which originally specified this attribute.
-
getSubstr
-
in file schema.inc, method AttributeType::getSubstr()
    Gets this attribute's substring matching specification
-
getSupAttribute
-
in file schema.inc, method AttributeType::getSupAttribute()
    Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.
-
getSupClasses
-
in file schema.inc, method ObjectClass::getSupClasses()
    Gets the objectClass names from which this objectClass inherits.
-
getSyntaxOID
-
in file schema.inc, method AttributeType::getSyntaxOID()
    Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.
-
getSyntaxString
-
in file schema.inc, method AttributeType::getSyntaxString()
    Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").
-
getType
-
in file schema.inc, method ObjectClass::getType()
    Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.
-
getType
-
in file schema.inc, method AttributeType::getType()
    Gets this attribute's type
-
getUsage
-
in file schema.inc, method AttributeType::getUsage()
    Gets this attribute's usage string as defined by the LDAP server
-
getUsedByAttrs
-
in file schema.inc, method MatchingRuleUse::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRuleUse object.
-
getUsedByAttrs
-
in file schema.inc, method MatchingRule::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRule
-
getUsedInObjectClasses
-
in file schema.inc, method AttributeType::getUsedInObjectClasses()
    Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
-
get_cache
-
in file cache.inc, method cache::get_cache()
    Queries the cache for a list of LDAP entries and their attributes.
-
get_cached_schema
-
in file schema.inc, function get_cached_schema()
    Returns the cached array of schemaitem objects for the specified
-
get_preg
-
in file account.inc, function get_preg()
    Checks if a given value matches the selected regular expression.
-
get_schema_attribute
-
in file schema.inc, function get_schema_attribute()
    Gets a single AttributeType object specified by name.
-
get_schema_attributes
-
in file schema.inc, function get_schema_attributes()
    Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.
-
get_schema_matching_rules
-
in file schema.inc, function get_schema_matching_rules()
    Returns an array of MatchingRule objects for the specified server.
-
get_schema_objectclass
-
in file schema.inc, function get_schema_objectclass()
    Gets a single ObjectClass object specified by name.
-
get_schema_objectclasses
-
in file schema.inc, function get_schema_objectclasses()
    Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.
-
get_schema_syntaxes
-
in file schema.inc, function get_schema_syntaxes()
    Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.
-
-
- top
-
- -
-

i

-
-
$is_collective
-
in file schema.inc, variable AttributeType::$is_collective
    boolean: is collective?
-
$is_no_user_modification
-
in file schema.inc, variable AttributeType::$is_no_user_modification
    boolean: can use modify?
-
$is_obsolete
-
in file schema.inc, variable MatchingRule::$is_obsolete
    Boolean value indicating whether this MatchingRule is obsolete
-
$is_obsolete
-
in file schema.inc, variable ObjectClass::$is_obsolete
    boolean value indicating whether this objectClass is obsolete
-
$is_obsolete
-
in file schema.inc, variable AttributeType::$is_obsolete
    string: the description
-
$is_single_value
-
in file schema.inc, variable AttributeType::$is_single_value
    boolean: is single valued only?
-
initVars
-
in file schema.inc, method ObjectClass::initVars()
    Initialize the class' member variables
-
initVars
-
in file schema.inc, method SchemaItem::initVars()
    Initialize class members to default values.
-
initVars
-
in file schema.inc, method AttributeType::initVars()
    Initialize the class' member variables
-
initVars
-
in file schema.inc, method Syntax::initVars()
    Initializes the class' member variables
-
initVars
-
in file schema.inc, method MatchingRule::initVars()
    Initialize the class' member variables
-
initVars
-
in file schema.inc, method MatchingRuleUse::initVars()
    Initialize the class' member variables
-
in_array_ignore_case
-
in file account.inc, function in_array_ignore_case()
    Checks if a string exists in an array, ignoring case.
-
in_cache
-
in file cache.inc, method cache::in_cache()
    This function returns the DN if an LDAP entry with $attribute=$value is found.
-
isAliasFor
-
in file schema.inc, method AttributeType::isAliasFor()
    Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).
-
-
- top
-
- -
-

l

-
-
lmPassword
-
in file account.inc, function lmPassword()
    Generates the LM hash of a password.
-
logNewMessage
-
in file security.inc, function logNewMessage()
    Puts a new message in the log file.
-
logoffAndBackToLoginPage
-
in file security.inc, function logoffAndBackToLoginPage()
    Logs off the user and displays the login page.
-
-
- top
-
- -
-

m

-
-
$max_length
-
in file schema.inc, variable AttributeType::$max_length
    The max number of characters this attribute can be
-
$may_attrs
-
in file schema.inc, variable ObjectClass::$may_attrs
    arrays of attribute names that this objectClass allows, but does not require
-
$must_attrs
-
in file schema.inc, variable ObjectClass::$must_attrs
    arrays of attribute names that this objectClass requires
-
MatchingRule
-
in file schema.inc, method MatchingRule::MatchingRule()
    Creates a new MatchingRule object from a raw LDAP MatchingRule string.
-
MatchingRule
-
in file schema.inc, class MatchingRule
    Represents an LDAP MatchingRule
-
MatchingRuleUse
-
in file schema.inc, class MatchingRuleUse
    Represents an LDAP schema matchingRuleUse entry
-
MatchingRuleUse
-
in file schema.inc, method MatchingRuleUse::MatchingRuleUse()
-
-
- top
-
- -
-

n

-
-
$name
-
in file schema.inc, variable ObjectClass::$name
    This objectClass' name, ie "inetOrgPerson"
-
$name
-
in file schema.inc, variable ObjectClassAttribute::$name
    This Attribute's name
-
$name
-
in file schema.inc, variable MatchingRuleUse::$name
    The name of the MathingRule this applies to
-
$name
-
in file schema.inc, variable MatchingRule::$name
    This rule's name
-
$name
-
in file schema.inc, variable AttributeType::$name
    The name of this attributeType
-
ntPassword
-
in file account.inc, function ntPassword()
    Generates the NT hash of a password.
-
-
- top
-
- -
-

o

-
-
$oid
-
in file schema.inc, variable SchemaItem::$oid
    The OID of this schema item.
-
$ordering
-
in file schema.inc, variable AttributeType::$ordering
    The ordering of the attributeType
-
ObjectClass
-
in file schema.inc, method ObjectClass::ObjectClass()
    Creates a new ObjectClass object given a raw LDAP objectClass string.
-
ObjectClass
-
in file schema.inc, class ObjectClass
    Represents an LDAP objectClass
-
ObjectClassAttribute
-
in file schema.inc, method ObjectClassAttribute::ObjectClassAttribute()
    Creates a new ObjectClassAttribute with specified name and source objectClass.
-
ObjectClassAttribute
-
in file schema.inc, class ObjectClassAttribute
    A simple class for representing AttributeTypes used only by the ObjectClass class.
-
-
- top
-
- -
-

p

-
-
pwd_disable
-
in file account.inc, function pwd_disable()
    Marks an password hash as disabled and returns the new hash string
-
pwd_enable
-
in file account.inc, function pwd_enable()
    Marks an password hash as enabled and returns the new hash string
-
pwd_hash
-
in file account.inc, function pwd_hash()
    Returns the hash value of a plain text password the hash algorithm depends on the configuration file
-
pwd_is_enabled
-
in file account.inc, function pwd_is_enabled()
    Checks if a password hash is enabled/disabled
-
-
- top
-
- -
-

r

-
-
$required_by_object_classes
-
in file schema.inc, variable AttributeType::$required_by_object_classes
    A list of object class names that require this attribute type.
-
refresh_cache
-
in file cache.inc, method cache::refresh_cache()
    This function refreshes the cache.
-
removeAlias
-
in file schema.inc, method AttributeType::removeAlias()
    Removes an attribute name from this attribute's alias array.
-
-
- top
-
- -
-

s

-
-
$source
-
in file schema.inc, variable ObjectClassAttribute::$source
    This Attribute's root
-
$sub_str
-
in file schema.inc, variable AttributeType::$sub_str
    Boolean: supports substring matching?
-
$sup_attribute
-
in file schema.inc, variable AttributeType::$sup_attribute
    The attribute from which this attribute inherits (if any)
-
$sup_classes
-
in file schema.inc, variable ObjectClass::$sup_classes
    array of objectClass names from which this objectClass inherits
-
$syntax
-
in file schema.inc, variable MatchingRule::$syntax
    This rule's syntax OID
-
$syntax
-
in file schema.inc, variable AttributeType::$syntax
    The full syntax string, ie 1.2.3.4{16}
-
schema.inc
-
procedural page schema.inc
-
security.inc
-
procedural page security.inc
-
status.inc
-
procedural page status.inc
-
SchemaItem
-
in file schema.inc, class SchemaItem
    Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
-
SchemaItem
-
in file schema.inc, method SchemaItem::SchemaItem()
    Default constructor.
-
SCHEMA_SESSION_CACHE_ENABLED
-
in file schema.inc, constant SCHEMA_SESSION_CACHE_ENABLED
    To enable/disable session-based schema caching (1: enabled, 0: disabled).
-
search_domains
-
in file account.inc, function search_domains()
    Returns an array with all Samba 3 domain entries under the given suffix
-
setAliases
-
in file schema.inc, method AttributeType::setAliases()
    Sets this attribute's list of aliases.
-
setDescription
-
in file schema.inc, method SchemaItem::setDescription()
-
setIsSingleValue
-
in file schema.inc, method AttributeType::setIsSingleValue()
    Sets whether this attribute is single-valued.
-
setName
-
in file schema.inc, method AttributeType::setName()
    Sets this attriute's name.
-
setOID
-
in file schema.inc, method SchemaItem::setOID()
-
setSupAttribute
-
in file schema.inc, method AttributeType::setSupAttribute()
    Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).
-
setType
-
in file schema.inc, method AttributeType::setType()
    Sets this attribute's type.
-
setUsedByAttrs
-
in file schema.inc, method MatchingRule::setUsedByAttrs()
    Sets the list of used_by_attrs to the array specified by $attrs;
-
set_cached_schema
-
in file schema.inc, function set_cached_schema()
    Caches the specified $schema_type.
-
set_schema_cache_unavailable
-
in file schema.inc, function set_schema_cache_unavailable()
    Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.
-
smbflag
-
in file account.inc, function smbflag()
    Takes a list of Samba flags and creates the corresponding flag string.
-
startSecureSession
-
in file security.inc, function startSecureSession()
    Starts a session and checks the environment.
-
StatusMessage
-
in file status.inc, function StatusMessage()
    This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.
-
Syntax
-
in file schema.inc, method Syntax::Syntax()
    Creates a new Syntax object from a raw LDAP syntax string.
-
Syntax
-
in file schema.inc, class Syntax
    Represents an LDAP Syntax
-
-
- top
-
- -
-

t

-
-
$type
-
in file schema.inc, variable ObjectClass::$type
    one of STRUCTURAL, ABSTRACT, or AUXILIARY
-
$type
-
in file schema.inc, variable AttributeType::$type
    A string description of the syntax type (taken from the LDAPSyntaxes)
-
-
- top
-
- -
-

u

-
-
$usage
-
in file schema.inc, variable AttributeType::$usage
    The usage string set by the LDAP schema
-
$used_by_attrs
-
in file schema.inc, variable MatchingRule::$used_by_attrs
    An array of attribute names who use this MatchingRule
-
$used_by_attrs
-
in file schema.inc, variable MatchingRuleUse::$used_by_attrs
    An array of attributeType names who make use of the mathingRule
-
$used_in_object_classes
-
in file schema.inc, variable AttributeType::$used_in_object_classes
    An array of objectClasses which use this attributeType (must be set by caller)
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_lists.html b/lam-web/developers/devel/phpdoc/elementindex_lists.html deleted file mode 100644 index 212806c6..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_lists.html +++ /dev/null @@ -1,615 +0,0 @@ - - -Package lists Element Index - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package lists

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ i ] - [ l ] - [ m ] - [ n ] - [ p ] - [ r ] - [ s ] - [ t ] - [ u ] - [ _ ] - -
- -
-

_

-
-
__construct
-
in file lists.inc, method lamSelectListOption::__construct()
    Creates a new selection list option.
-
__construct
-
in file mailAlias.inc, method lamMailAliasList::__construct()
    Constructor
-
__construct
-
in file smbDomain.inc, method lamSmbDomainList::__construct()
    Constructor
-
__construct
-
in file user.inc, method lamUserList::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamListTool::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamListOption::__construct()
    Creates a new config option.
-
__construct
-
in file host.inc, method lamHostList::__construct()
    Constructor
-
__construct
-
in file lists.inc, method lamBooleanListOption::__construct()
    Creates a new boolean option.
-
__construct
-
in file lists.inc, method lamList::__construct()
    Constructor
-
__construct
-
in file group.inc, method lamGroupList::__construct()
    Constructor
-
-
- top
-
- -
-

a

-
-
$attrArray
-
in file lists.inc, variable lamList::$attrArray
    list of LDAP attributes
-
arrayLower
-
in file tree.inc, function arrayLower()
-
array_stripslashes
-
in file tree.inc, function array_stripslashes()
    Strips all slashes from the specified array in place (pass by ref).
-
add_attr.php
-
procedural page add_attr.php
-
add_attr_form.php
-
procedural page add_attr_form.php
-
add_oclass.php
-
procedural page add_oclass.php
-
add_oclass_form.php
-
procedural page add_oclass_form.php
-
add_value.php
-
procedural page add_value.php
-
add_value_form.php
-
procedural page add_value_form.php
-
-
- top
-
- -
-

b

-
-
build_initial_tree_icons
-
in file tree.inc, function build_initial_tree_icons()
    Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned
-
-
- top
-
- -
-

c

-
-
cmp_array
-
in file lists.inc, method lamList::cmp_array()
    Compare function used for usort-method
-
collapse.php
-
procedural page collapse.php
-
create.php
-
procedural page create.php
-
create_form.php
-
procedural page create_form.php
-
creation_template.php
-
procedural page creation_template.php
-
custom.php
-
procedural page custom.php
-
-
- top
-
- -
-

d

-
-
$descArray
-
in file lists.inc, variable lamList::$descArray
    list of attribute descriptions
-
deletelink.php
-
procedural page deletelink.php
-
dn_exists
-
in file tree.inc, function dn_exists()
    Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.
-
draw_create_link
-
in file tree.php, function draw_create_link()
-
draw_formatted_dn
-
in file tree.inc, function draw_formatted_dn()
    Gets a DN string using the user-configured tree_display_format string to format it.
-
draw_jpeg_photos
-
in file tree.inc, function draw_jpeg_photos()
    Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.
-
draw_server_tree
-
in file tree.inc, function draw_server_tree()
    Prints the HTML of the tree view.
-
draw_tree_html
-
in file tree.php, function draw_tree_html()
    Recursively descend on the given dn and draw the tree in html
-
delete.php
-
procedural page delete.php
-
delete_attr.php
-
procedural page delete_attr.php
-
delete_form.php
-
procedural page delete_form.php
-
download_binary_attr.php
-
procedural page download_binary_attr.php
-
-
- top
-
- -
-

e

-
-
$entries
-
in file lists.inc, variable lamList::$entries
    LDAP entries
-
edit.php
-
procedural page edit.php
-
expand.php
-
procedural page expand.php
-
export.php
-
procedural page export.php
-
export_form.php
-
procedural page export_form.php
-
-
- top
-
- -
-

f

-
-
$filterText
-
in file lists.inc, variable lamList::$filterText
    filter string to include in URL
-
fillFromPostData
-
in file lists.inc, method lamSelectListOption::fillFromPostData()
    Fills the config option from POST data.
-
fillFromPostData
-
in file lists.inc, method lamListOption::fillFromPostData()
    Fills the config option from POST data.
-
fillFromPostData
-
in file lists.inc, method lamBooleanListOption::fillFromPostData()
    Fills the config option from POST data.
-
-
- top
-
- -
-

g

-
-
getAdditionalTools
-
in file user.inc, method lamUserList::getAdditionalTools()
    Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
getAdditionalTools
-
in file lists.inc, method lamList::getAdditionalTools()
    Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
getID
-
in file lists.inc, method lamListOption::getID()
    Returns the option ID.
-
getImage
-
in file lists.inc, method lamListTool::getImage()
    Returns the name of the tool image.
-
getLinkTarget
-
in file lists.inc, method lamListTool::getLinkTarget()
    Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.
-
getMetaHTML
-
in file lists.inc, method lamListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getMetaHTML
-
in file lists.inc, method lamSelectListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getMetaHTML
-
in file lists.inc, method lamBooleanListOption::getMetaHTML()
    Returns the meta HTML data to display this option.
-
getName
-
in file lists.inc, method lamListTool::getName()
    Returns the tool name.
-
getValue
-
in file lists.inc, method lamListOption::getValue()
    Returns the option value. The value must not contain "=" and ";".
-
groupRefreshPrimary
-
in file group.inc, method lamGroupList::groupRefreshPrimary()
    Refreshes the primary group members list.
-
get_attr_select_html
-
in file custom.php, function get_attr_select_html()
    Returns option values.
-
get_binary_attr_select_html
-
in file custom.php, function get_binary_attr_select_html()
    Returns option values.
-
get_container
-
in file tree.inc, function get_container()
    Given a DN string, this returns the parent container portion of the string.
-
get_container_contents
-
in file tree.inc, function get_container_contents()
    Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of child entries one level beneath the parent. For example, for the following tree:
-
get_enc_type
-
in file tree.inc, function get_enc_type()
-
get_entry_system_attrs
-
in file tree.inc, function get_entry_system_attrs()
    Gets the operational attributes for an entry. Given a DN, this function fetches that entry's
-
get_icon
-
in file tree.inc, function get_icon()
    Given a DN and server ID, this function reads the DN's objectClasses and
-
get_line_end_format
-
in file export_form.php, function get_line_end_format()
    Helper functoin for fetching the line end format.
-
get_object_attr
-
in file tree.inc, function get_object_attr()
    Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:
-
get_object_attrs
-
in file tree.inc, function get_object_attrs()
    Gets the attributes/values of an entry. Returns an associative array whose
-
get_rdn
-
in file tree.inc, function get_rdn()
    Given a DN string, this returns the 'RDN' portion of the string.
-
-
- top
-
- -
-

i

-
-
isSelected
-
in file lists.inc, method lamBooleanListOption::isSelected()
    Returns if this option is selected.
-
initialize_session_tree
-
in file tree.inc, function initialize_session_tree()
    Checks and fixes an initial session's tree cache if needed.
-
is_attr_binary
-
in file tree.inc, function is_attr_binary()
    Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.
-
is_attr_boolean
-
in file tree.inc, function is_attr_boolean()
    Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.
-
is_binary_option_required
-
in file add_attr.php, function is_binary_option_required()
-
is_dn_attr
-
in file tree.inc, function is_dn_attr()
    Returns true if the attribute specified is required to take as input a DN.
-
is_jpeg_photo
-
in file tree.inc, function is_jpeg_photo()
    Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.
-
is_mail_string
-
in file tree.inc, function is_mail_string()
    Get whether a string looks like an email address (user@example.com).
-
is_multi_line_attr
-
in file tree.inc, function is_multi_line_attr()
    Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;
-
is_url_string
-
in file tree.inc, function is_url_string()
    Get whether a string looks like a web URL (http://www.example.com/)
-
-
- top
-
- -
-

l

-
-
$labels
-
in file lists.inc, variable lamList::$labels
    list of account specific labels
-
lamBooleanListOption
-
in file lists.inc, class lamBooleanListOption
    Boolean option for list configuration.
-
lamGroupList
-
in file group.inc, class lamGroupList
    Generates the list view.
-
lamHostList
-
in file host.inc, class lamHostList
    Generates the list view.
-
lamList
-
in file lists.inc, class lamList
    Generates the list view.
-
lamListOption
-
in file lists.inc, class lamListOption
    Represents a list configuration option.
-
lamListTool
-
in file lists.inc, class lamListTool
    Represents a tool which can be included in the account lists.
-
lamMailAliasList
-
in file mailAlias.inc, class lamMailAliasList
    Generates the list view.
-
lamSelectListOption
-
in file lists.inc, class lamSelectListOption
    Boolean option for list configuration.
-
lamSmbDomainList
-
in file smbDomain.inc, class lamSmbDomainList
    Generates the list view.
-
lamUserList
-
in file user.inc, class lamUserList
    Generates the list view.
-
lists.inc
-
procedural page lists.inc
-
listBuildFilter
-
in file lists.inc, method lamList::listBuildFilter()
    Builds the regular expressions from the filter values.
-
listConfigurationChanged
-
in file lists.inc, method lamList::listConfigurationChanged()
    Called when the configuration options changed.
-
listConfigurationChanged
-
in file group.inc, method lamGroupList::listConfigurationChanged()
    Called when the configuration options changed.
-
listConfigurationChanged
-
in file user.inc, method lamUserList::listConfigurationChanged()
    Called when the configuration options changed.
-
listDoPost
-
in file lists.inc, method lamList::listDoPost()
    Manages all POST actions (e.g. button pressed) for the account lists.
-
listDrawNavigationBar
-
in file lists.inc, method lamList::listDrawNavigationBar()
    Draws a navigation bar to switch between pages
-
listFilterAccounts
-
in file lists.inc, method lamList::listFilterAccounts()
    Removes all entries which do not fit to the filter.
-
listGetAllConfigOptions
-
in file user.inc, method lamUserList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetAllConfigOptions
-
in file lists.inc, method lamList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetAllConfigOptions
-
in file group.inc, method lamGroupList::listGetAllConfigOptions()
    Returns a list of possible configuration options.
-
listGetConfigOptionByID
-
in file lists.inc, method lamList::listGetConfigOptionByID()
    Returns the configuration option with the given ID.
-
listGetParams
-
in file lists.inc, method lamList::listGetParams()
    Sets some internal parameters.
-
listGetParams
-
in file user.inc, method lamUserList::listGetParams()
    Sets some internal parameters.
-
listGetParams
-
in file group.inc, method lamGroupList::listGetParams()
    Sets some internal parameters.
-
listPrintButtons
-
in file lists.inc, method lamList::listPrintButtons()
    Prints the create and delete buttons.
-
listPrintConfigurationPage
-
in file lists.inc, method lamList::listPrintConfigurationPage()
    Prints the list configuration page.
-
listPrintFooter
-
in file lists.inc, method lamList::listPrintFooter()
    Prints the HTML footer.
-
listPrintHeader
-
in file lists.inc, method lamList::listPrintHeader()
    Prints the HTML header.
-
listPrintTableBody
-
in file lists.inc, method lamList::listPrintTableBody()
    Prints the entry list
-
listPrintTableCellContent
-
in file group.inc, method lamGroupList::listPrintTableCellContent()
    Prints the content of a cell in the account list for a given LDAP entry and attribute.
-
listPrintTableCellContent
-
in file lists.inc, method lamList::listPrintTableCellContent()
    Prints the content of a cell in the account list for a given LDAP entry and attribute.
-
listPrintTableCellContent
-
in file user.inc, method lamUserList::listPrintTableCellContent()
    Prints the content of a cell in the account list for a given LDAP entry and attribute.
-
listPrintTableHeader
-
in file lists.inc, method lamList::listPrintTableHeader()
    Prints the attribute and filter row at the account table head
-
listRefreshData
-
in file group.inc, method lamGroupList::listRefreshData()
    Rereads the entries from LDAP.
-
listRefreshData
-
in file lists.inc, method lamList::listRefreshData()
    Rereads the entries from LDAP.
-
listRefreshData
-
in file user.inc, method lamUserList::listRefreshData()
    Rereads the entries from LDAP.
-
listShowOUSelection
-
in file lists.inc, method lamList::listShowOUSelection()
    Prints a combobox with possible sub-DNs.
-
listSort
-
in file lists.inc, method lamList::listSort()
    Sorts an account list by a given attribute
-
LIST_SIZE_OPTION_NAME
-
in file lists.inc, class constant lamList::LIST_SIZE_OPTION_NAME
    ID for list size config option
-
list.php
-
procedural page list.php
-
-
- top
-
- -
-

m

-
-
$maxPageEntries
-
in file lists.inc, variable lamList::$maxPageEntries
    maximum count of entries per page
-
-
- top
-
- -
-

n

-
-
not_an_attr
-
in file add_attr_form.php, function not_an_attr()
    Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.
-
new_ou_template.php
-
procedural page new_ou_template.php
-
-
- top
-
- -
-

p

-
-
$page
-
in file lists.inc, variable lamList::$page
    current page number
-
$possibleSuffixes
-
in file lists.inc, variable lamList::$possibleSuffixes
    list of possible LDAP suffixes(organizational units)
-
pla_compare_dns
-
in file tree.inc, function pla_compare_dns()
    Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.
-
pla_explode_dn
-
in file tree.inc, function pla_explode_dn()
    Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.
-
pla_ldap_search
-
in file tree.inc, function pla_ldap_search()
    A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.
-
pla_rdelete
-
in file rdelete.php, function pla_rdelete()
-
pla_reverse_dn
-
in file tree.inc, function pla_reverse_dn()
    Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last
-
pretty_print_dn
-
in file tree.inc, function pretty_print_dn()
    Returns an HTML-beautified version of a DN.
-
-
- top
-
- -
-

r

-
-
$refresh
-
in file lists.inc, variable lamList::$refresh
    refresh page switch
-
refreshPrimaryGroupTranslation
-
in file user.inc, method lamUserList::refreshPrimaryGroupTranslation()
    Refreshes the GID to group name cache.
-
real_attr_name
-
in file tree.inc, function real_attr_name()
    Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.
-
remove_aliases
-
in file custom.php, function remove_aliases()
    Removes attributes from the array that are aliases for eachother
-
rdelete.php
-
procedural page rdelete.php
-
refresh.php
-
procedural page refresh.php
-
-
- top
-
- -
-

s

-
-
$sortColumn
-
in file lists.inc, variable lamList::$sortColumn
    sort column name
-
$sortDirection
-
in file lists.inc, variable lamList::$sortDirection
    sort direction: 1 for ascending, -1 for descending
-
$suffix
-
in file lists.inc, variable lamList::$suffix
    LDAP suffix
-
search_username
-
in file userlink.php, function search_username()
    Searches LDAP for a specific user name (uid attribute) and returns its DN entry
-
setHelpID
-
in file lists.inc, method lamSelectListOption::setHelpID()
    Sets the help ID.
-
setValue
-
in file lists.inc, method lamListOption::setValue()
    Sets the config option value. The value must not contain "=" and ";".
-
showPage
-
in file lists.inc, method lamList::showPage()
    Prints the HTML code to display the list view.
-
sortAttrs
-
in file tree.inc, function sortAttrs()
-
-
- top
-
- -
-

t

-
-
$type
-
in file lists.inc, variable lamList::$type
    Account type
-
TRANS_PRIMARY_OPTION_NAME
-
in file user.inc, class constant lamUserList::TRANS_PRIMARY_OPTION_NAME
    ID for config option
-
TRANS_PRIMARY_OPTION_NAME
-
in file group.inc, class constant lamGroupList::TRANS_PRIMARY_OPTION_NAME
    ID for config option
-
tree.inc
-
procedural page tree.inc
-
templates.inc
-
procedural page templates.inc
-
tree.php
-
procedural page tree.php
-
tree_view.php
-
procedural page tree_view.php
-
-
- top
-
- -
-

u

-
-
userlink.php
-
procedural page userlink.php
-
update.php
-
procedural page update.php
-
update_confirm.php
-
procedural page update_confirm.php
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_main.html b/lam-web/developers/devel/phpdoc/elementindex_main.html deleted file mode 100644 index 2ebebb9d..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_main.html +++ /dev/null @@ -1,145 +0,0 @@ - - -Package main Element Index - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package main

- [ d ] - [ g ] - [ i ] - [ l ] - [ m ] - -
- -
-

d

-
-
deleteDN
-
in file delete.php, function deleteDN()
    Deletes a DN and all child entries.
-
display_LoginPage
-
in file login.php, function display_LoginPage()
    Displays the login window.
-
delete.php
-
procedural page delete.php
-
-
- top
-
- -
-

g

-
-
getChildCount
-
in file delete.php, function getChildCount()
    Returns the number of child entries of a DN.
-
-
- top
-
- -
-

i

-
-
initsuff.php
-
procedural page initsuff.php
-
-
- top
-
- -
-

l

-
-
login.php
-
procedural page login.php
-
logout.php
-
procedural page logout.php
-
-
- top
-
- -
-

m

-
-
main.php
-
procedural page main.php
-
main_header.php
-
procedural page main_header.php
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_modules.html b/lam-web/developers/devel/phpdoc/elementindex_modules.html deleted file mode 100644 index 4701e964..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_modules.html +++ /dev/null @@ -1,1062 +0,0 @@ - - -Package modules Element Index - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package modules

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ f ] - [ g ] - [ h ] - [ i ] - [ k ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ q ] - [ r ] - [ s ] - [ t ] - [ _ ] - -
- -
-

_

-
-
__construct
-
in file sambaSamAccount.inc, method sambaSamAccount::__construct()
    Creates a new sambaSamAccount object.
-
__construct
-
in file sambaAccount.inc, method sambaAccount::__construct()
    Creates a new sambaAccount object.
-
__construct
-
in file baseModule.inc, method baseModule::__construct()
    Creates a new base module class
-
__construct
-
in file modules.inc, method accountContainer::__construct()
    Constructor
-
__construct
-
in file kolabUser.inc, method kolabUser::__construct()
    Creates a new kolabUser object.
-
__construct
-
in file sambaGroupMapping.inc, method sambaGroupMapping::__construct()
    Creates a new module for Samba 3 groups.
-
__sleep
-
in file modules.inc, method accountContainer::__sleep()
    Encrypts sensitive data before storing in session.
-
__wakeup
-
in file modules.inc, method accountContainer::__wakeup()
    Decrypts sensitive data after accountContainer was loaded from session.
-
-
- top
-
- -
-

a

-
-
$attributes
-
in file modules.inc, variable accountContainer::$attributes
    Array of all used attributes
-
$attributes
-
in file baseModule.inc, variable baseModule::$attributes
    contains all ldap attributes which should be written
-
$attributes_orig
-
in file modules.inc, variable accountContainer::$attributes_orig
    original LDAP attributes when account was loaded from LDAP
-
$autoAddObjectClasses
-
in file baseModule.inc, variable baseModule::$autoAddObjectClasses
    if true, managed object classes are added when an account is created or loaded (default: true)
-
account
-
in file account.inc, class account
    Manages the object class "account" for users and hosts.
-
accountContainer
-
in file modules.inc, class accountContainer
    This class includes all modules and attributes of an account.
-
account.inc
-
procedural page account.inc
-
-
- top
-
- -
-

b

-
-
baseModule
-
in file baseModule.inc, class baseModule
    Parent class of all account modules.
-
buildUploadAccounts
-
in file modules.inc, function buildUploadAccounts()
    This function builds the LDAP accounts for the file upload.
-
build_uploadAccounts
-
in file posixGroup.inc, method posixGroup::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file sambaAccount.inc, method sambaAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file posixAccount.inc, method posixAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file sambaGroupMapping.inc, method sambaGroupMapping::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file shadowAccount.inc, method shadowAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file sambaSamAccount.inc, method sambaSamAccount::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file nisMailAlias.inc, method nisMailAlias::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file sambaDomain.inc, method sambaDomain::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file ldapPublicKey.inc, method ldapPublicKey::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file ieee802device.inc, method ieee802Device::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file baseModule.inc, method baseModule::build_uploadAccounts()
    In this function the LDAP accounts are built.
-
build_uploadAccounts
-
in file account.inc, method account::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file inetOrgPerson.inc, method inetOrgPerson::build_uploadAccounts()
    In this function the LDAP account is built up.
-
build_uploadAccounts
-
in file kolabUser.inc, method kolabUser::build_uploadAccounts()
    In this function the LDAP account is built up.
-
baseModule.inc
-
procedural page baseModule.inc
-
-
- top
-
- -
-

c

-
-
$ctx
-
in file sambaMungedDial.inc, variable sambaMungedDial::$ctx
-
$ctxattributes
-
in file sambaMungedDial.inc, variable sambaMungedDial::$ctxattributes
-
can_manage
-
in file baseModule.inc, method baseModule::can_manage()
    Returns true if this module can manage accounts of the current type, otherwise false.
-
checkASCII
-
in file posixAccount.inc, method posixAccount::checkASCII()
    Checks if an attribute contains only ASCII charaters and replaces invalid characters.
-
checkConfigOptions
-
in file modules.inc, function checkConfigOptions()
    Checks if the configuration options are valid
-
checkProfileOptions
-
in file modules.inc, function checkProfileOptions()
    Checks if the profile options are valid
-
checkSelfServiceOptions
-
in file inetOrgPerson.inc, method inetOrgPerson::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file posixAccount.inc, method posixAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file sambaSamAccount.inc, method sambaSamAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceOptions
-
in file baseModule.inc, method baseModule::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP attributes which should be changed.
-
checkSelfServiceSettings
-
in file baseModule.inc, method baseModule::checkSelfServiceSettings()
    Checks if the self service settings are valid.
-
check_configOptions
-
in file baseModule.inc, method baseModule::check_configOptions()
    Checks input values of module settings.
-
check_configOptions
-
in file posixAccount.inc, method posixAccount::check_configOptions()
    Checks input values of module settings.
-
check_module_conflicts
-
in file modules.inc, function check_module_conflicts()
    Checks if there are conflicts between modules
-
check_module_depends
-
in file modules.inc, function check_module_depends()
    Checks if there are missing dependencies between modules.
-
check_profileOptions
-
in file quota.inc, method quota::check_profileOptions()
    Checks input values of account profiles.
-
check_profileOptions
-
in file baseModule.inc, method baseModule::check_profileOptions()
    Checks input values of account profiles.
-
continue_main
-
in file modules.inc, method accountContainer::continue_main()
    This function is called when the user clicks on any button on the account pages.
-
createntlm.inc
-
procedural page createntlm.inc
-
-
- top
-
- -
-

d

-
-
$dn
-
in file modules.inc, variable accountContainer::$dn
    DN suffix of the account
-
$dn
-
in file account.inc, variable samba3domain::$dn
    DN
-
$dn_orig
-
in file modules.inc, variable accountContainer::$dn_orig
    DN suffix of account when it was loaded
-
decode_munged
-
in file sambaMungedDial.inc, method sambaMungedDial::decode_munged()
    Takes a base64-encoded MungedDial-String and returns an array of included parameters and values
-
delete_attributes
-
in file baseModule.inc, method baseModule::delete_attributes()
    This function returns an array with the same syntax as save_attributes().
-
delete_attributes
-
in file posixAccount.inc, method posixAccount::delete_attributes()
    Additional LDAP operations on delete.
-
delete_attributes
-
in file posixGroup.inc, method posixGroup::delete_attributes()
    Checks if the group which should be deleted is still used as primary group.
-
display_html_attributes
-
in file quota.inc, method quota::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file posixGroup.inc, method posixGroup::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file nisMailAlias.inc, method nisMailAlias::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file posixAccount.inc, method posixAccount::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file ldapPublicKey.inc, method ldapPublicKey::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file account.inc, method account::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file sambaDomain.inc, method sambaDomain::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file shadowAccount.inc, method shadowAccount::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.
-
display_html_attributes
-
in file baseModule.inc, method baseModule::display_html_attributes()
    This function creates meta HTML code to display the module page.
-
display_html_attributes
-
in file ieee802device.inc, method ieee802Device::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file kolabUser.inc, method kolabUser::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file sambaGroupMapping.inc, method sambaGroupMapping::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file inetOrgPerson.inc, method inetOrgPerson::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_attributes
-
in file sambaAccount.inc, method sambaAccount::display_html_attributes()
    Returns the HTML meta data for the main account page.
-
display_html_delete
-
in file posixAccount.inc, method posixAccount::display_html_delete()
    Displays the delete homedir option for the delete page.
-
display_html_delete
-
in file baseModule.inc, method baseModule::display_html_delete()
    This function creates meta HTML code which will be displayed when an account should be deleted.
-
display_html_deleteUser
-
in file kolabUser.inc, method kolabUser::display_html_deleteUser()
    This function will create the meta HTML code to show a page to delete accounts.
-
display_html_expire
-
in file shadowAccount.inc, method shadowAccount::display_html_expire()
    This function will create the meta HTML code to show a page with the expiration date.
-
display_html_group
-
in file posixAccount.inc, method posixAccount::display_html_group()
    Displays the group selection.
-
display_html_logonHours
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_logonHours()
    This function will create the HTML page to edit logon hours.
-
display_html_password
-
in file posixGroup.inc, method posixGroup::display_html_password()
    Displays the password changing dialog.
-
display_html_password
-
in file posixAccount.inc, method posixAccount::display_html_password()
    Displays the password changing dialog.
-
display_html_password
-
in file inetOrgPerson.inc, method inetOrgPerson::display_html_password()
    Displays the password changing dialog.
-
display_html_photo
-
in file inetOrgPerson.inc, method inetOrgPerson::display_html_photo()
    Displays the photo upload page.
-
display_html_sambaUserWorkstations
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_sambaUserWorkstations()
    This function will create the HTML page to edit the allowed workstations.
-
display_html_terminalServer
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_terminalServer()
    This function will create the HTML page to edit the terminal server options.
-
display_html_time
-
in file sambaSamAccount.inc, method sambaSamAccount::display_html_time()
    This function will create the meta HTML code to show a page to change time values.
-
display_html_user
-
in file posixGroup.inc, method posixGroup::display_html_user()
    Displays selections to add or remove users from current group.
-
display_html_userWorkstations
-
in file sambaAccount.inc, method sambaAccount::display_html_userWorkstations()
    This function will create the HTML page to edit the allowed workstations.
-
doHash
-
in file createntlm.inc, method smbHash::doHash()
-
doUploadPostActions
-
in file modules.inc, function doUploadPostActions()
    This function executes one post upload action.
-
doUploadPostActions
-
in file quota.inc, method quota::doUploadPostActions()
    This function executes one post upload action.
-
doUploadPostActions
-
in file baseModule.inc, method baseModule::doUploadPostActions()
    This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
-
doUploadPostActions
-
in file posixAccount.inc, method posixAccount::doUploadPostActions()
    This function executes one post upload action.
-
-
- top
-
- -
-

e

-
-
encode_munged
-
in file sambaMungedDial.inc, method sambaMungedDial::encode_munged()
    Encode full MungedDial-String
-
endian
-
in file sambaMungedDial.inc, method sambaMungedDial::endian()
    endian
-
edit.php
-
procedural page edit.php
-
-
- top
-
- -
-

f

-
-
fixLDAPAttributes
-
in file modules.inc, method accountContainer::fixLDAPAttributes()
    Fixes spelling errors in the attribute names.
-
-
- top
-
- -
-

g

-
-
genTime
-
in file sambaMungedDial.inc, method sambaMungedDial::genTime()
    genTime
-
getAccountContainer
-
in file baseModule.inc, method baseModule::getAccountContainer()
    Returns the accountContainer object.
-
getAccountModule
-
in file modules.inc, method accountContainer::getAccountModule()
    Returns the account module with the given class name
-
getAccountModules
-
in file modules.inc, method accountContainer::getAccountModules()
    Returns the included account modules.
-
getAttributes
-
in file baseModule.inc, method baseModule::getAttributes()
    Returns the LDAP attributes which are managed in this module.
-
getAvailableModules
-
in file modules.inc, function getAvailableModules()
    Returns an array with all available user module names
-
getAvailablePDFFields
-
in file modules.inc, function getAvailablePDFFields()
    Returns a list of available PDF entries.
-
getBrokenConn
-
in file sambaMungedDial.inc, method sambaMungedDial::getBrokenConn()
    gets Broken-Connection value: disconnect/reset
-
getButtonStatus
-
in file baseModule.inc, method baseModule::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getButtonStatus
-
in file inetOrgPerson.inc, method inetOrgPerson::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getButtonStatus
-
in file posixGroup.inc, method posixGroup::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getButtonStatus
-
in file nisMailAlias.inc, method nisMailAlias::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getButtonStatus
-
in file account.inc, method account::getButtonStatus()
    Controls if the module button the account page is visible and activated.
-
getClearTextPassword
-
in file posixAccount.inc, method posixAccount::getClearTextPassword()
    Returns the clear text password.
-
getConfigOptions
-
in file modules.inc, function getConfigOptions()
    Returns a hash array (module name => elements) of all module options for the configuration page.
-
getConnectClientDrives
-
in file sambaMungedDial.inc, method sambaMungedDial::getConnectClientDrives()
    gets connect-client-drive-at-logon value: enabled/disabled
-
getConnectClientPrinters
-
in file sambaMungedDial.inc, method sambaMungedDial::getConnectClientPrinters()
    gets connect-client-printers-at-logon value: enabled/disabled
-
getCtxMaxConnectionTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxConnectionTimeF()
    SMARTY: gets the checkbox state of "Connection"
-
getCtxMaxDisconnectionTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxDisconnectionTimeF()
    SMARTY: gets the checkbox state of "Disconnection"
-
getCtxMaxIdleTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::getCtxMaxIdleTimeF()
    SMARTY: gets the checkbox state of "Idle"
-
getDefaultPrinter
-
in file sambaMungedDial.inc, method sambaMungedDial::getDefaultPrinter()
    gets set-client-printer-to-default value: enabled/disabled
-
getHelp
-
in file modules.inc, function getHelp()
    Returns a help entry from an account module.
-
getIcon
-
in file baseModule.inc, method baseModule::getIcon()
    Returns the path to the module icon.
-
getInheritMode
-
in file sambaMungedDial.inc, method sambaMungedDial::getInheritMode()
    gets Inherit-config-from-client value: enabled/disabled
-
getLDAPAliases
-
in file baseModule.inc, method baseModule::getLDAPAliases()
    Returns a list of aliases for LDAP attributes.
-
getManagedAttributes
-
in file baseModule.inc, method baseModule::getManagedAttributes()
    Returns a list of LDAP attributes which are managed by this module.
-
getManagedObjectClasses
-
in file baseModule.inc, method baseModule::getManagedObjectClasses()
    Returns a list of managed object classes for this module.
-
getModuleAlias
-
in file modules.inc, function getModuleAlias()
    Returns the alias name of a module
-
getModulesDependencies
-
in file modules.inc, function getModulesDependencies()
    Returns a hash array (module name => dependencies) of all module dependencies
-
getMunged
-
in file sambaMungedDial.inc, method sambaMungedDial::getMunged()
    Returns ready-to-run mungedDialString to be filled into ldap
-
getNextGIDs
-
in file posixGroup.inc, method posixGroup::getNextGIDs()
    Returns one or more free GID numbers.
-
getNextUIDs
-
in file posixAccount.inc, method posixAccount::getNextUIDs()
    Returns one or more free UID numbers.
-
getOnDemandFlags
-
in file sambaMungedDial.inc, method sambaMungedDial::getOnDemandFlags()
    Returns array of flags, which can be set on-demand with activated java-script
-
getOriginalAttributes
-
in file baseModule.inc, method baseModule::getOriginalAttributes()
    Returns the LDAP attributes which are managed in this module (with unchanged values).
-
getParentDN
-
in file modules.inc, method accountContainer::getParentDN()
    Returns the parent DN of a given DN.
-
getProfileOptions
-
in file modules.inc, function getProfileOptions()
    Returns the elements for the profile page.
-
getRDN
-
in file modules.inc, method accountContainer::getRDN()
    Returns the RDN part of a given DN.
-
getRDNAttributes
-
in file modules.inc, function getRDNAttributes()
    Returns a list of LDAP attributes which can be used to form the RDN.
-
getReConn
-
in file sambaMungedDial.inc, method sambaMungedDial::getReConn()
    gets Reconnection value: from any client/from previous client only
-
getRequiredExtensions
-
in file modules.inc, function getRequiredExtensions()
    Returns true if the module is a base module
-
getRequiredExtensions
-
in file baseModule.inc, method baseModule::getRequiredExtensions()
    This function returns a list of PHP extensions (e.g. mhash) which are needed by this module.
-
getSelfServiceFields
-
in file baseModule.inc, method baseModule::getSelfServiceFields()
    Returns a list of possible input fields and their descriptions.
-
getSelfServiceOptions
-
in file inetOrgPerson.inc, method inetOrgPerson::getSelfServiceOptions()
    Returns the meta HTML code for each input field.
-
getSelfServiceOptions
-
in file posixAccount.inc, method posixAccount::getSelfServiceOptions()
    Returns the meta HTML code for each input field.
-
getSelfServiceOptions
-
in file baseModule.inc, method baseModule::getSelfServiceOptions()
    Returns the meta HTML code for each input field.
-
getSelfServiceSearchAttributes
-
in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes()
    This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.
-
getSelfServiceSettings
-
in file baseModule.inc, method baseModule::getSelfServiceSettings()
    Returns a list of self service configuration settings.
-
getShadow
-
in file sambaMungedDial.inc, method sambaMungedDial::getShadow()
    gets shadow value (enum): 0-4
-
getTsLogin
-
in file sambaMungedDial.inc, method sambaMungedDial::getTsLogin()
    Gets Terminal-Server-Login value: enabled/disabled
-
getUploadColumns
-
in file modules.inc, function getUploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_alias
-
in file baseModule.inc, method baseModule::get_alias()
    Returns an alias name for the module.
-
get_configOptions
-
in file posixGroup.inc, method posixGroup::get_configOptions()
    Returns a list of elements for the configuration.
-
get_configOptions
-
in file baseModule.inc, method baseModule::get_configOptions()
    Returns a list of configuration options.
-
get_dependencies
-
in file baseModule.inc, method baseModule::get_dependencies()
    This function returns a list with all depending and conflicting modules.
-
get_help
-
in file baseModule.inc, method baseModule::get_help()
    This function returns the help entry array for a specific help id.
-
get_ldap_filter
-
in file modules.inc, function get_ldap_filter()
    Returns the LDAP filter used by the account lists
-
get_ldap_filter
-
in file baseModule.inc, method baseModule::get_ldap_filter()
    Returns an LDAP filter for the account lists
-
get_metaData
-
in file baseModule.inc, method baseModule::get_metaData()
    This function provides meta data which is interpreted by baseModule.
-
get_metaData
-
in file posixGroup.inc, method posixGroup::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file inetOrgPerson.inc, method inetOrgPerson::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file quota.inc, method quota::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file ieee802device.inc, method ieee802Device::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file sambaDomain.inc, method sambaDomain::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file sambaAccount.inc, method sambaAccount::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file kolabUser.inc, method kolabUser::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file sambaGroupMapping.inc, method sambaGroupMapping::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file shadowAccount.inc, method shadowAccount::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file nisMailAlias.inc, method nisMailAlias::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file sambaSamAccount.inc, method sambaSamAccount::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file ldapPublicKey.inc, method ldapPublicKey::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file account.inc, method account::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_metaData
-
in file posixAccount.inc, method posixAccount::get_metaData()
    Returns meta data that is interpreted by parent class
-
get_pdfEntries
-
in file account.inc, method account::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file sambaGroupMapping.inc, method sambaGroupMapping::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file sambaSamAccount.inc, method sambaSamAccount::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file shadowAccount.inc, method shadowAccount::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file ieee802device.inc, method ieee802Device::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file sambaDomain.inc, method sambaDomain::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file ldapPublicKey.inc, method ldapPublicKey::get_pdfEntries()
    Returns a list of PDF entries
-
get_pdfEntries
-
in file kolabUser.inc, method kolabUser::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file posixAccount.inc, method posixAccount::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file inetOrgPerson.inc, method inetOrgPerson::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file posixGroup.inc, method posixGroup::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file quota.inc, method quota::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file modules.inc, method accountContainer::get_pdfEntries()
    Returns a list of possible PDF entries for this account.
-
get_pdfEntries
-
in file sambaAccount.inc, method sambaAccount::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfEntries
-
in file nisMailAlias.inc, method nisMailAlias::get_pdfEntries()
    Returns the PDF entries for this module.
-
get_pdfFields
-
in file baseModule.inc, method baseModule::get_pdfFields()
    Returns a hashtable with all entries that may be printed out in the PDF.
-
get_profileOptions
-
in file posixAccount.inc, method posixAccount::get_profileOptions()
    Returns a list of elements for the account profiles.
-
get_profileOptions
-
in file sambaSamAccount.inc, method sambaSamAccount::get_profileOptions()
    Returns a list of elements for the account profiles.
-
get_profileOptions
-
in file baseModule.inc, method baseModule::get_profileOptions()
    This function defines what attributes will be used in the account profiles and their appearance in the profile editor.
-
get_profileOptions
-
in file sambaGroupMapping.inc, method sambaGroupMapping::get_profileOptions()
    Returns a list of elements for the account profiles.
-
get_profileOptions
-
in file quota.inc, method quota::get_profileOptions()
    Returns a list of elements for the account profiles.
-
get_RDNAttributes
-
in file baseModule.inc, method baseModule::get_RDNAttributes()
    Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).
-
get_scope
-
in file baseModule.inc, method baseModule::get_scope()
    Returns the account type of this module (user, group, host)
-
get_type
-
in file modules.inc, method accountContainer::get_type()
    Returns the accout type of this object (e.g. user, group, host).
-
get_uploadColumns
-
in file quota.inc, method quota::get_uploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_uploadColumns
-
in file baseModule.inc, method baseModule::get_uploadColumns()
    Returns an array containing all input columns for the file upload.
-
get_uploadPreDepends
-
in file baseModule.inc, method baseModule::get_uploadPreDepends()
    Returns a list of module names which must be processed in building the account befor this module.
-
-
- top
-
- -
-

h

-
-
hexstr
-
in file sambaMungedDial.inc, method sambaMungedDial::hexstr()
    hexstr
-
-
- top
-
- -
-

i

-
-
$isNewAccount
-
in file modules.inc, variable accountContainer::$isNewAccount
    True if this is a newly created account
-
ieee802Device
-
in file ieee802device.inc, class ieee802Device
    Provides MAC addresses for hosts.
-
inetLocalMailRecipient
-
in file inetLocalMailRecipient.inc, class inetLocalMailRecipient
    Provides mail routing for users.
-
inetOrgPerson
-
in file inetOrgPerson.inc, class inetOrgPerson
    This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
-
init
-
in file posixGroup.inc, method posixGroup::init()
    This functin will be called when the module will be loaded *
-
init
-
in file sambaAccount.inc, method sambaAccount::init()
    Initializes the module after it became part of an accountContainer
-
init
-
in file sambaGroupMapping.inc, method sambaGroupMapping::init()
    Initializes the module after it became part of an accountContainer
-
init
-
in file sambaSamAccount.inc, method sambaSamAccount::init()
    Initializes the module after it became part of an accountContainer
-
init
-
in file baseModule.inc, method baseModule::init()
    Initializes the module after it became part of an accountContainer
-
init
-
in file posixAccount.inc, method posixAccount::init()
    Initializes the module after it became part of an accountContainer
-
initQuotas
-
in file quota.inc, method quota::initQuotas()
    Initializes the quota values.
-
is_base_module
-
in file modules.inc, function is_base_module()
    Returns true if the module is a base module
-
is_base_module
-
in file baseModule.inc, method baseModule::is_base_module()
    Returns true if your module is a base module and otherwise false.
-
is_samba_path
-
in file sambaMungedDial.inc, method sambaMungedDial::is_samba_path()
    Checks if this is a valid Samba path.
-
ieee802device.inc
-
procedural page ieee802device.inc
-
inetLocalMailRecipient.inc
-
procedural page inetLocalMailRecipient.inc
-
inetOrgPerson.inc
-
procedural page inetOrgPerson.inc
-
-
- top
-
- -
-

k

-
-
kolabUser
-
in file kolabUser.inc, class kolabUser
    Manages Kolab user accounts.
-
kolabUser.inc
-
procedural page kolabUser.inc
-
-
- top
-
- -
-

l

-
-
lamdaemon
-
in file lamdaemon.inc, function lamdaemon()
    Sends commands to lamdaemon script.
-
lamdaemonSSH
-
in file lamdaemon.inc, function lamdaemonSSH()
    Sends commands to lamdaemon script via PHP SSH functions.
-
ldapPublicKey
-
in file ldapPublicKey.inc, class ldapPublicKey
    Manages SSH public keys.
-
lamdaemon.inc
-
procedural page lamdaemon.inc
-
ldapPublicKey.inc
-
procedural page ldapPublicKey.inc
-
lmhash
-
in file createntlm.inc, method smbHash::lmhash()
    Calculates the LM hash of a given password.
-
load
-
in file sambaMungedDial.inc, method sambaMungedDial::load()
    function takes a base64-encoded sambaMungedDial
-
load_account
-
in file modules.inc, method accountContainer::load_account()
    Loads an LDAP account with the given DN.
-
load_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()
    This function loads the LDAP attributes for this module.
-
load_attributes
-
in file sambaAccount.inc, method sambaAccount::load_attributes()
    This function loads the LDAP attributes for this module.
-
load_attributes
-
in file posixAccount.inc, method posixAccount::load_attributes()
    This function loads all needed LDAP attributes.
-
load_attributes
-
in file baseModule.inc, method baseModule::load_attributes()
    This function loads the LDAP attributes when an account should be loaded.
-
load_Messages
-
in file kolabUser.inc, method kolabUser::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file shadowAccount.inc, method shadowAccount::load_Messages()
    This function builds up the message array.
-
load_Messages
-
in file sambaAccount.inc, method sambaAccount::load_Messages()
    this functin fills the error message array with messages
-
load_Messages
-
in file sambaDomain.inc, method sambaDomain::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file baseModule.inc, method baseModule::load_Messages()
    This function fills the $messages variable with output messages from this module.
-
load_Messages
-
in file sambaSamAccount.inc, method sambaSamAccount::load_Messages()
    this functin fills the error message array with messages
-
load_Messages
-
in file sambaGroupMapping.inc, method sambaGroupMapping::load_Messages()
    this functin fills the error message array with messages
-
load_Messages
-
in file quota.inc, method quota::load_Messages()
    this functin fills the error message array with messages
-
load_Messages
-
in file posixGroup.inc, method posixGroup::load_Messages()
    This function fills the $messages variable with output messages from this module.
-
load_Messages
-
in file nisMailAlias.inc, method nisMailAlias::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file ieee802device.inc, method ieee802Device::load_Messages()
    This function fills the error message array with messages
-
load_Messages
-
in file inetOrgPerson.inc, method inetOrgPerson::load_Messages()
    This function fills the message array.
-
load_Messages
-
in file account.inc, method account::load_Messages()
    This function fills the message array.
-
load_Messages
-
in file posixAccount.inc, method posixAccount::load_Messages()
    This function fills the error message array with messages.
-
load_Messages
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::load_Messages()
    This function fills the error message array with messages
-
load_profile
-
in file sambaSamAccount.inc, method sambaSamAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file shadowAccount.inc, method shadowAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file baseModule.inc, method baseModule::load_profile()
    This function loads the values from an account profile to the module's internal data structures.
-
load_profile
-
in file posixAccount.inc, method posixAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file quota.inc, method quota::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file sambaAccount.inc, method sambaAccount::load_profile()
    Loads the values of an account profile into internal variables.
-
load_profile
-
in file sambaGroupMapping.inc, method sambaGroupMapping::load_profile()
    Loads the values of an account profile into internal variables.
-
-
- top
-
- -
-

m

-
-
$messages
-
in file baseModule.inc, variable baseModule::$messages
    contains all error messages of a module
-
$meta
-
in file baseModule.inc, variable baseModule::$meta
    includes all meta data provided by the sub class
-
$moduleSettings
-
in file baseModule.inc, variable baseModule::$moduleSettings
    configuration settings of all modules
-
modules.inc
-
procedural page modules.inc
-
module_complete
-
in file posixAccount.inc, method posixAccount::module_complete()
    This functions is used to check if all settings for this module have been made.
-
module_complete
-
in file baseModule.inc, method baseModule::module_complete()
    This functions is used to check if all settings for this module have been made.
-
module_complete
-
in file sambaAccount.inc, method sambaAccount::module_complete()
    This functions returns true if all needed settings are done
-
module_complete
-
in file account.inc, method account::module_complete()
    This functions returns true if all needed settings are done.
-
module_complete
-
in file posixGroup.inc, method posixGroup::module_complete()
    This functions is used to check if all settings for this module have been made.
-
module_complete
-
in file kolabUser.inc, method kolabUser::module_complete()
    This function returns true if all needed settings are done.
-
module_complete
-
in file inetOrgPerson.inc, method inetOrgPerson::module_complete()
    This functions return true if all needed settings are done.
-
module_ready
-
in file sambaGroupMapping.inc, method sambaGroupMapping::module_ready()
    This function is used to check if this module page can be displayed.
-
module_ready
-
in file sambaSamAccount.inc, method sambaSamAccount::module_ready()
    This function is used to check if this module page can be displayed.
-
module_ready
-
in file baseModule.inc, method baseModule::module_ready()
    This function is used to check if this module page can be displayed.
-
module_ready
-
in file sambaAccount.inc, method sambaAccount::module_ready()
    This function is used to check if this module page can be displayed.
-
module_ready
-
in file quota.inc, method quota::module_ready()
    This function is used to check if this module page can be displayed.
-
munge
-
in file sambaMungedDial.inc, method sambaMungedDial::munge()
    Setup parameter given by paramName to MungedDial-Format
-
-
- top
-
- -
-

n

-
-
$name
-
in file account.inc, variable samba3domain::$name
    Domain name
-
$nextGroupRID
-
in file account.inc, variable samba3domain::$nextGroupRID
    Next group RID
-
$nextRID
-
in file account.inc, variable samba3domain::$nextRID
    Next RID
-
$nextUserRID
-
in file account.inc, variable samba3domain::$nextUserRID
    Next user RID
-
nisMailAlias.inc
-
procedural page nisMailAlias.inc
-
new_account
-
in file modules.inc, method accountContainer::new_account()
    This function will prepare the object for a new account.
-
nisMailAlias
-
in file nisMailAlias.inc, class nisMailAlias
    Provides NIS mail alias management.
-
nthash
-
in file createntlm.inc, method smbHash::nthash()
    Calculates the NT hash of a given password.
-
-
- top
-
- -
-

o

-
-
$orig
-
in file baseModule.inc, variable baseModule::$orig
    contains all ldap attributes which are loaded from ldap
-
-
- top
-
- -
-

p

-
-
posixAccount.inc
-
procedural page posixAccount.inc
-
posixGroup.inc
-
procedural page posixGroup.inc
-
parseHtml
-
in file modules.inc, function parseHtml()
    Takes a list of meta-HTML elements and prints the equivalent HTML output.
-
posixAccount
-
in file posixAccount.inc, class posixAccount
    Manages the object class "posixAccount" for users and hosts.
-
posixGroup
-
in file posixGroup.inc, class posixGroup
    Manages the object class "posixGroup" for groups.
-
postDeleteActions
-
in file baseModule.inc, method baseModule::postDeleteActions()
    Allows the module to run commands after the LDAP entry is deleted.
-
postModifyActions
-
in file quota.inc, method quota::postModifyActions()
    Allows the module to run commands after the LDAP entry is changed or created.
-
postModifyActions
-
in file posixAccount.inc, method posixAccount::postModifyActions()
    Allows the module to run commands after the LDAP entry was changed or created.
-
postModifyActions
-
in file baseModule.inc, method baseModule::postModifyActions()
    Allows the module to run commands after the LDAP entry is changed or created.
-
preDeleteActions
-
in file quota.inc, method quota::preDeleteActions()
    Allows the module to run commands before the LDAP entry is deleted.
-
preDeleteActions
-
in file baseModule.inc, method baseModule::preDeleteActions()
    Allows the module to run commands before the LDAP entry is deleted.
-
preDeleteActions
-
in file posixAccount.inc, method posixAccount::preDeleteActions()
    Allows the module to run commands before the LDAP entry is deleted.
-
preModifyActions
-
in file baseModule.inc, method baseModule::preModifyActions()
    Allows the module to run commands before the LDAP entry is changed or created.
-
process_attributes
-
in file sambaAccount.inc, method sambaAccount::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file shadowAccount.inc, method shadowAccount::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file sambaGroupMapping.inc, method sambaGroupMapping::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file sambaDomain.inc, method sambaDomain::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file quota.inc, method quota::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file posixGroup.inc, method posixGroup::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file posixAccount.inc, method posixAccount::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file kolabUser.inc, method kolabUser::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file ieee802device.inc, method ieee802Device::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file inetOrgPerson.inc, method inetOrgPerson::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file baseModule.inc, method baseModule::process_attributes()
    This function processes user input.
-
process_attributes
-
in file account.inc, method account::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file ldapPublicKey.inc, method ldapPublicKey::process_attributes()
    Processes user input of the primary module page.
-
process_attributes
-
in file nisMailAlias.inc, method nisMailAlias::process_attributes()
    Processes user input of the primary module page.
-
process_deleteUser
-
in file kolabUser.inc, method kolabUser::process_deleteUser()
    Write variables into object and do some regex checks
-
process_expire
-
in file shadowAccount.inc, method shadowAccount::process_expire()
    Processes user input of the expiration page.
-
process_group
-
in file posixAccount.inc, method posixAccount::process_group()
    Processes user input of the group selection page.
-
process_logonHours
-
in file sambaSamAccount.inc, method sambaSamAccount::process_logonHours()
    Processes user input of the logon hours page.
-
process_password
-
in file inetOrgPerson.inc, method inetOrgPerson::process_password()
    Sets a new password.
-
process_password
-
in file posixGroup.inc, method posixGroup::process_password()
    Processes user input of the password page.
-
process_password
-
in file posixAccount.inc, method posixAccount::process_password()
    Processes user input of the password page.
-
process_photo
-
in file inetOrgPerson.inc, method inetOrgPerson::process_photo()
    Sets a new photo.
-
process_sambaUserWorkstations
-
in file sambaSamAccount.inc, method sambaSamAccount::process_sambaUserWorkstations()
    Processes user input of the primary module page.
-
process_terminalServer
-
in file sambaSamAccount.inc, method sambaSamAccount::process_terminalServer()
    Processes user input of the terminal server page.
-
process_time
-
in file sambaSamAccount.inc, method sambaSamAccount::process_time()
    Processes user input of the time selection page.
-
process_user
-
in file posixGroup.inc, method posixGroup::process_user()
    Processes user input of the user selection page.
-
process_userWorkstations
-
in file sambaAccount.inc, method sambaAccount::process_userWorkstations()
    Processes user input of the workstation selection page.
-
-
- top
-
- -
-

q

-
-
quota.inc
-
procedural page quota.inc
-
quota
-
in file quota.inc, class quota
    Manages quotas for users and groups.
-
-
- top
-
- -
-

r

-
-
$rdn
-
in file modules.inc, variable accountContainer::$rdn
    RDN attribute of this account
-
$RIDbase
-
in file account.inc, variable samba3domain::$RIDbase
    RID base to calculate RIDs, default 1000
-
readTime
-
in file sambaMungedDial.inc, method sambaMungedDial::readTime()
    readTime
-
replaceSpecialChars
-
in file quota.inc, method quota::replaceSpecialChars()
    Replaces special characters in HTML name values.
-
-
- top
-
- -
-

s

-
-
$selfServiceSettings
-
in file baseModule.inc, variable baseModule::$selfServiceSettings
    self service settings of all modules
-
$SID
-
in file account.inc, variable samba3domain::$SID
    Domain SID
-
sambaAccount.inc
-
procedural page sambaAccount.inc
-
sambaDomain.inc
-
procedural page sambaDomain.inc
-
sambaGroupMapping.inc
-
procedural page sambaGroupMapping.inc
-
sambaMungedDial.inc
-
procedural page sambaMungedDial.inc
-
sambaSamAccount.inc
-
procedural page sambaSamAccount.inc
-
shadowAccount.inc
-
procedural page shadowAccount.inc
-
samba3domain
-
in file account.inc, class samba3domain
    Represents a Samba 3 domain entry
-
sambaAccount
-
in file sambaAccount.inc, class sambaAccount
    Manages the object class "sambaAccount" for users and hosts.
-
sambaDomain
-
in file sambaDomain.inc, class sambaDomain
    Manages Samba 3 domain entries.
-
sambaGroupMapping
-
in file sambaGroupMapping.inc, class sambaGroupMapping
    Manages the object class "sambaGroupMapping" for groups.
-
sambaMungedDial
-
in file sambaMungedDial.inc, class sambaMungedDial
    Manages terminal server settings for Samba 3.
-
sambaSamAccount
-
in file sambaSamAccount.inc, class sambaSamAccount
    Manages the object class "sambaSamAccount" for users and hosts.
-
SAMBA_MUNGEDDIAL_FILEHEADER
-
in file sambaMungedDial.inc, constant SAMBA_MUNGEDDIAL_FILEHEADER
    File header
-
SAMBA_MUNGEDDIAL_FILEHEADER_OLD
-
in file sambaMungedDial.inc, constant SAMBA_MUNGEDDIAL_FILEHEADER_OLD
    File header for old format.
-
save_account
-
in file modules.inc, method accountContainer::save_account()
    This function will save an account to the LDAP database.
-
save_attributes
-
in file sambaSamAccount.inc, method sambaSamAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file account.inc, method account::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file shadowAccount.inc, method shadowAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file sambaGroupMapping.inc, method sambaGroupMapping::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file kolabUser.inc, method kolabUser::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file inetOrgPerson.inc, method inetOrgPerson::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file sambaAccount.inc, method sambaAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file baseModule.inc, method baseModule::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file nisMailAlias.inc, method nisMailAlias::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file posixGroup.inc, method posixGroup::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_attributes
-
in file posixAccount.inc, method posixAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.
-
save_module_attributes
-
in file modules.inc, method accountContainer::save_module_attributes()
    This function checks which LDAP attributes have changed while the account was edited.
-
setBrokenConn
-
in file sambaMungedDial.inc, method sambaMungedDial::setBrokenConn()
    sets Broken-Connection value: disconnect/reset
-
setConnectClientDrives
-
in file sambaMungedDial.inc, method sambaMungedDial::setConnectClientDrives()
    sets connect-client-drive-at-logon value: enabled/disabled
-
setConnectClientPrinters
-
in file sambaMungedDial.inc, method sambaMungedDial::setConnectClientPrinters()
    sets connect-client-printers-at-logon value: enabled/disabled
-
setCtxMaxConnectionTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxConnectionTimeF()
    SMARTY: sets the checkbox "Connection" to unchecked
-
setCtxMaxDisconnectionTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxDisconnectionTimeF()
    SMARTY: sets the checkbox "Disconnection" to unchecked
-
setCtxMaxIdleTimeF
-
in file sambaMungedDial.inc, method sambaMungedDial::setCtxMaxIdleTimeF()
    SMARTY: sets the checkbox "Idle" to unchecked
-
setDefaultPrinter
-
in file sambaMungedDial.inc, method sambaMungedDial::setDefaultPrinter()
    sets set-client-printer-to-default value: enabled/disabled
-
setInheritMode
-
in file sambaMungedDial.inc, method sambaMungedDial::setInheritMode()
    sets Inherit-config-from-client value: enabled/disabled
-
setReConn
-
in file sambaMungedDial.inc, method sambaMungedDial::setReConn()
    sets Reconnection value: from any client/from previous client only
-
setShadow
-
in file sambaMungedDial.inc, method sambaMungedDial::setShadow()
    sets shadow value
-
setTsLogin
-
in file sambaMungedDial.inc, method sambaMungedDial::setTsLogin()
    Sets Terminal-Server-Login value: enabled/disabled
-
shadowAccount
-
in file shadowAccount.inc, class shadowAccount
    Manages the object class "shadowAccount" for users.
-
smbHash
-
in file createntlm.inc, class smbHash
    Calculates NT and LM hashes.
-
sortModules
-
in file modules.inc, method accountContainer::sortModules()
    Sorts the module buttons for the account page.
-
strhex
-
in file sambaMungedDial.inc, method sambaMungedDial::strhex()
    strhex
-
-
- top
-
- -
-

t

-
-
to8bit
-
in file sambaMungedDial.inc, method sambaMungedDial::to8bit()
    to8bit
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_profiles.html b/lam-web/developers/devel/phpdoc/elementindex_profiles.html deleted file mode 100644 index 6e5d948c..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_profiles.html +++ /dev/null @@ -1,139 +0,0 @@ - - -Package profiles Element Index - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package profiles

- [ d ] - [ g ] - [ l ] - [ p ] - [ s ] - -
- -
-

d

-
-
delAccountProfile
-
in file profiles.inc, function delAccountProfile()
    Deletes an account profile
-
-
- top
-
- -
-

g

-
-
getAccountProfiles
-
in file profiles.inc, function getAccountProfiles()
    Returns an array of string with all available profiles for the given account type
-
-
- top
-
- -
-

l

-
-
loadAccountProfile
-
in file profiles.inc, function loadAccountProfile()
    Loads an profile of the given account type
-
-
- top
-
- -
-

p

-
-
profiles.inc
-
procedural page profiles.inc
-
profiledelete.php
-
procedural page profiledelete.php
-
profilemain.php
-
procedural page profilemain.php
-
profilepage.php
-
procedural page profilepage.php
-
-
- top
-
- -
-

s

-
-
saveAccountProfile
-
in file profiles.inc, function saveAccountProfile()
    Saves an hash array (attribute => value) to an account profile
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_selfService.html b/lam-web/developers/devel/phpdoc/elementindex_selfService.html deleted file mode 100644 index e43f2f2d..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_selfService.html +++ /dev/null @@ -1,186 +0,0 @@ - - -Package selfService Element Index - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package selfService

- [ c ] - [ g ] - [ i ] - [ l ] - [ m ] - [ s ] - [ _ ] - -
- -
-

_

-
-
__construct
-
in file selfService.inc, method selfServiceProfile::__construct()
    Constructor
-
-
- top
-
- -
-

c

-
-
checkSelfServiceOptions
-
in file selfService.inc, function checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.
-
checkSelfServiceSettings
-
in file selfService.inc, function checkSelfServiceSettings()
    Checks if the self service settings are valid
-
-
- top
-
- -
-

g

-
-
getSelfServiceFieldSettings
-
in file selfService.inc, function getSelfServiceFieldSettings()
    Returns the field settings for the self service.
-
getSelfServiceOptions
-
in file selfService.inc, function getSelfServiceOptions()
    Returns meta HTML code for each self service field.
-
getSelfServiceProfiles
-
in file selfService.inc, function getSelfServiceProfiles()
    Returns a list of all available self service profiles (without .conf)
-
getSelfServiceSearchAttributes
-
in file selfService.inc, function getSelfServiceSearchAttributes()
    Returns a list of possible search attributes for the self service.
-
getSelfServiceSettings
-
in file selfService.inc, function getSelfServiceSettings()
    Returns a hash array (module name => elements) of all module options for the configuration page.
-
-
- top
-
- -
-

i

-
-
$inputFields
-
in file selfService.inc, variable selfServiceProfile::$inputFields
    input fields
-
isLAMProVersion
-
in file selfService.inc, function isLAMProVersion()
    Returns if this is a LAM Pro installation.
-
-
- top
-
- -
-

l

-
-
$LDAPPassword
-
in file selfService.inc, variable selfServiceProfile::$LDAPPassword
    LDAP password
-
$LDAPSuffix
-
in file selfService.inc, variable selfServiceProfile::$LDAPSuffix
    LDAP suffix
-
$LDAPUser
-
in file selfService.inc, variable selfServiceProfile::$LDAPUser
    LDAP user DN
-
$loginAttributeText
-
in file selfService.inc, variable selfServiceProfile::$loginAttributeText
    describing text for search attribute
-
$loginCaption
-
in file selfService.inc, variable selfServiceProfile::$loginCaption
    describing text for user login
-
loadSelfServiceProfile
-
in file selfService.inc, function loadSelfServiceProfile()
    Loads all settings of a self service profile.
-
-
- top
-
- -
-

m

-
-
$mainPageText
-
in file selfService.inc, variable selfServiceProfile::$mainPageText
    describing text for self service main page
-
$moduleSettings
-
in file selfService.inc, variable selfServiceProfile::$moduleSettings
    configuration settings of modules
-
-
- top
-
- -
-

s

-
-
$searchAttribute
-
in file selfService.inc, variable selfServiceProfile::$searchAttribute
    LDAP search attribute
-
$serverURL
-
in file selfService.inc, variable selfServiceProfile::$serverURL
    server address
-
selfService.inc
-
procedural page selfService.inc
-
saveSelfServiceProfile
-
in file selfService.inc, function saveSelfServiceProfile()
    Saves a self service profile.
-
selfServiceProfile
-
in file selfService.inc, class selfServiceProfile
    Includes all settings of a self service profile.
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_tests.html b/lam-web/developers/devel/phpdoc/elementindex_tests.html deleted file mode 100644 index 149dca39..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_tests.html +++ /dev/null @@ -1,100 +0,0 @@ - - -Package tests Element Index - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package tests

- [ c ] - [ s ] - -
- -
-

c

-
-
conf-main-test.php
-
procedural page conf-main-test.php
-
conf-test.php
-
procedural page conf-test.php
-
-
- top
-
- -
-

s

-
-
status-test.php
-
procedural page status-test.php
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_tools.html b/lam-web/developers/devel/phpdoc/elementindex_tools.html deleted file mode 100644 index 325dcd7b..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_tools.html +++ /dev/null @@ -1,454 +0,0 @@ - - -Package tools Element Index - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package tools

- [ a ] - [ b ] - [ c ] - [ d ] - [ e ] - [ g ] - [ h ] - [ i ] - [ l ] - [ m ] - [ n ] - [ o ] - [ p ] - [ q ] - [ r ] - [ s ] - [ t ] - [ v ] - -
- -
-

a

-
-
$attributes
-
in file export.inc, variable PlaLdapExporter::$attributes
-
-
- top
-
- -
-

b

-
-
$base_dn
-
in file export.inc, variable LdapExportInfo::$base_dn
-
$br
-
in file export.inc, variable PlaExporter::$br
-
-
- top
-
- -
-

c

-
-
$counter
-
in file export.inc, variable PlaDsmlExporter::$counter
-
$counter
-
in file export.inc, variable PlaLdifExporter::$counter
-
checkSchemaForModule
-
in file schemaTest.php, function checkSchemaForModule()
    Checks if the object classes and attributes for this module are available.
-
-
- top
-
- -
-

d

-
-
$deliveryAddress
-
in file export.inc, variable PlaVcardExporter::$deliveryAddress
-
$description
-
in file tools.php, variable LAMTool::$description
    description text
-
displayExportInfo
-
in file export.inc, method PlaLdifExporter::displayExportInfo()
-
display_main
-
in file ou_edit.php, function display_main()
-
-
- top
-
- -
-

e

-
-
$entry_array
-
in file export.inc, variable PlaLdapExporter::$entry_array
-
$entry_id
-
in file export.inc, variable PlaLdapExporter::$entry_id
-
$escapeCode
-
in file export.inc, variable PlaCSVExporter::$escapeCode
-
$exporter
-
in file export.inc, variable PlaExporter::$exporter
-
export
-
in file export.inc, method PlaLdifExporter::export()
    Export entries to ldif format
-
export
-
in file export.inc, method PlaVcardExporter::export()
    When doing an exporter, the method export need to be overriden.
-
export
-
in file export.inc, method MyCustomExporter::export()
    When doing an exporter, the method export need to be overriden.
-
export
-
in file export.inc, method PlaCSVExporter::export()
-
export
-
in file export.inc, method PlaDsmlExporter::export()
    Export the entries to DSML
-
export
-
in file export.inc, method PlaExporter::export()
    Abstract method use to export data.
-
export.inc
-
procedural page export.inc
-
-
- top
-
- -
-

g

-
-
getRecursiveAttributesFromObjectClass
-
in file schemaTest.php, function getRecursiveAttributesFromObjectClass()
    Returns the names of all attributes which are managed by the given object class and its parents.
-
get_user_agent_string
-
in file export.inc, function get_user_agent_string()
    Gets the USER_AGENT string from the $_SERVER array, all in lower case in an E_NOTICE safe manner.
-
-
- top
-
- -
-

h

-
-
$hasNext
-
in file export.inc, variable PlaLdapExporter::$hasNext
-
-
- top
-
- -
-

i

-
-
$indent_step
-
in file export.inc, variable PlaDsmlExporter::$indent_step
-
is_browser_os_mac
-
in file export.inc, function is_browser_os_mac()
    Determines whether the browser's operating system is Macintosh.
-
is_browser_os_unix
-
in file export.inc, function is_browser_os_unix()
    Determines whether the browser's operating system is UNIX (or something like UNIX).
-
is_browser_os_windows
-
in file export.inc, function is_browser_os_windows()
    Determines whether the browser's operating system is Windows.
-
is_safe_ascii
-
in file export.inc, method PlaExporter::is_safe_ascii()
    Helper method to check if the attribute value should be base 64 encoded.
-
index.php
-
procedural page index.php
-
-
- top
-
- -
-

l

-
-
$ldap_info
-
in file export.inc, variable PlaLdapExporter::$ldap_info
-
$link
-
in file tools.php, variable LAMTool::$link
    link to tool page (relative to templates/)
-
lamRunLamdaemonTestSuite
-
in file lamdaemonTest.php, function lamRunLamdaemonTestSuite()
    Runs all tests for a given server.
-
lamTestLamdaemon
-
in file lamdaemonTest.php, function lamTestLamdaemon()
    Runs a test case of lamdaemon.
-
LAMTool
-
in file tools.php, class LAMTool
    Represents a tool.
-
LdapEscape
-
in file export.inc, method PlaCSVExporter::LdapEscape()
-
LdapExportInfo
-
in file export.inc, class LdapExportInfo
    This class encapsulate informations about the ldap server from which the export is done.
-
LdapExportInfo
-
in file export.inc, method LdapExportInfo::LdapExportInfo()
    Create a new LdapExportInfo object
-
lamdaemonTest.php
-
procedural page lamdaemonTest.php
-
-
- top
-
- -
-

m

-
-
$MAX_LDIF_LINE_LENGTH
-
in file export.inc, variable PlaLdifExporter::$MAX_LDIF_LINE_LENGTH
-
$multivalue_separator
-
in file export.inc, variable PlaCSVExporter::$multivalue_separator
-
multi_lines_display
-
in file export.inc, method PlaLdifExporter::multi_lines_display()
    Helper method to wrap ldif lines
-
MyCustomExporter
-
in file export.inc, class MyCustomExporter
-
MyCutsomExporter
-
in file export.inc, method MyCustomExporter::MyCutsomExporter()
-
massBuildAccounts.php
-
procedural page massBuildAccounts.php
-
masscreate.php
-
procedural page masscreate.php
-
massDoUpload.php
-
procedural page massDoUpload.php
-
-
- top
-
- -
-

n

-
-
$name
-
in file tools.php, variable LAMTool::$name
    name of the tool
-
$num_entries
-
in file export.inc, variable PlaLdapExporter::$num_entries
-
-
- top
-
- -
-

o

-
-
ou_edit.php
-
procedural page ou_edit.php
-
-
- top
-
- -
-

p

-
-
PlaAbstractExporter
-
in file export.inc, class PlaAbstractExporter
    This class represents the base class of all exporters
-
PlaCSVExporter
-
in file export.inc, class PlaCSVExporter
    Export to cvs format
-
PlaCSVExporter
-
in file export.inc, method PlaCSVExporter::PlaCSVExporter()
-
PlaDsmlExporter
-
in file export.inc, method PlaDsmlExporter::PlaDsmlExporter()
    Create a PlaDsmlExporter object
-
PlaDsmlExporter
-
in file export.inc, class PlaDsmlExporter
    Export entries to DSML v.1
-
PlaExporter
-
in file export.inc, method PlaExporter::PlaExporter()
    Constructor
-
PlaExporter
-
in file export.inc, class PlaExporter
    PlaExporter acts a wrapper around another exporter.
-
PlaLdapExporter
-
in file export.inc, method PlaLdapExporter::PlaLdapExporter()
    Create a PlaLdapExporter object.
-
PlaLdapExporter
-
in file export.inc, class PlaLdapExporter
    Export data from a ldap server
-
PlaLdifExporter
-
in file export.inc, class PlaLdifExporter
    Export entries to ldif format
-
PlaLdifExporter
-
in file export.inc, method PlaLdifExporter::PlaLdifExporter()
    Create a PlaLdifExporter object
-
PlaVcardExporter
-
in file export.inc, class PlaVcardExporter
-
PlaVcardExporter
-
in file export.inc, method PlaVcardExporter::PlaVcardExporter()
-
pla_fetch_entry_array
-
in file export.inc, method PlaLdapExporter::pla_fetch_entry_array()
    Return the entry as an array
-
pla_fetch_entry_array
-
in file export.inc, method PlaAbstractExporter::pla_fetch_entry_array()
    Return the entry as an array
-
pla_fetch_entry_array
-
in file export.inc, method PlaExporter::pla_fetch_entry_array()
    Return the entry as an array
-
pla_fetch_entry_object
-
in file export.inc, method PlaLdapExporter::pla_fetch_entry_object()
    Return the entry as an Entry object
-
pla_fetch_entry_object
-
in file export.inc, method PlaExporter::pla_fetch_entry_object()
    Return the entry as an Entry object
-
pla_fetch_entry_object
-
in file export.inc, method PlaAbstractExporter::pla_fetch_entry_object()
    Return the entry as an Entry object
-
pla_get_ldap_info
-
in file export.inc, method PlaAbstractExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object
-
pla_get_ldap_info
-
in file export.inc, method PlaLdapExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object
-
pla_get_ldap_info
-
in file export.inc, method PlaExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object
-
pla_has_entry
-
in file export.inc, method PlaAbstractExporter::pla_has_entry()
    Return true if there is some more entries to be processed
-
pla_has_entry
-
in file export.inc, method PlaLdapExporter::pla_has_entry()
    Return true if there is some more entries to be processed
-
pla_has_entry
-
in file export.inc, method PlaExporter::pla_has_entry()
    Return true if there is some more entries to be processed
-
pla_num_entries
-
in file export.inc, method PlaExporter::pla_num_entries()
    Return the number of entries
-
pla_num_entries
-
in file export.inc, method PlaLdapExporter::pla_num_entries()
    Return the number of entries
-
pla_num_entries
-
in file export.inc, method PlaAbstractExporter::pla_num_entries()
    Return the number of entries
-
-
- top
-
- -
-

q

-
-
$qualifier
-
in file export.inc, variable PlaCSVExporter::$qualifier
-
$queryFilter
-
in file export.inc, variable PlaLdapExporter::$queryFilter
-
$query_filter
-
in file export.inc, variable LdapExportInfo::$query_filter
-
-
- top
-
- -
-

r

-
-
$requiresPasswordChanges
-
in file tools.php, variable LAMTool::$requiresPasswordChanges
    tool requires password change rights
-
$requiresWriteAccess
-
in file tools.php, variable LAMTool::$requiresWriteAccess
    tool requires write access to LDAP
-
$results
-
in file export.inc, variable PlaLdapExporter::$results
-
-
- top
-
- -
-

s

-
-
$scope
-
in file export.inc, variable LdapExportInfo::$scope
-
$scope
-
in file export.inc, variable PlaLdapExporter::$scope
-
$separator
-
in file export.inc, variable PlaCSVExporter::$separator
    When doing an exporter, the method export need to be overriden.
-
setOutputFormat
-
in file export.inc, method PlaExporter::setOutputFormat()
    Set the carriage return /linefeed for the export
-
showColumnData
-
in file masscreate.php, function showColumnData()
    Prints the properties of one input field.
-
showMainPage
-
in file masscreate.php, function showMainPage()
    Displays the acount type specific main page of the upload.
-
schema.php
-
procedural page schema.php
-
schemaTest.php
-
procedural page schemaTest.php
-
-
- top
-
- -
-

t

-
-
tools.php
-
procedural page tools.php
-
-
- top
-
- -
-

v

-
-
$vcardMapping
-
in file export.inc, variable PlaVcardExporter::$vcardMapping
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/elementindex_types.html b/lam-web/developers/devel/phpdoc/elementindex_types.html deleted file mode 100644 index 9a661de7..00000000 --- a/lam-web/developers/devel/phpdoc/elementindex_types.html +++ /dev/null @@ -1,255 +0,0 @@ - - -Package types Element Index - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- - -

Element index for package types

- [ b ] - [ g ] - [ h ] - [ m ] - [ s ] - [ t ] - [ u ] - -
- -
-

b

-
-
baseType
-
in file baseType.inc, class baseType
    This is the parent class of all account types.
-
baseType.inc
-
procedural page baseType.inc
-
-
- top
-
- -
-

g

-
-
getAlias
-
in file smbDomain.inc, method smbDomain::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file baseType.inc, method baseType::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file host.inc, method host::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file mailAlias.inc, method mailAlias::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file group.inc, method group::getAlias()
    Returns the alias name of this account type.
-
getAlias
-
in file user.inc, method user::getAlias()
    Returns the alias name of this account type.
-
getDefaultListAttributes
-
in file host.inc, method host::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file smbDomain.inc, method smbDomain::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file user.inc, method user::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file types.inc, function getDefaultListAttributes()
    Returns the default attribute list for an account type.
-
getDefaultListAttributes
-
in file mailAlias.inc, method mailAlias::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file group.inc, method group::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDefaultListAttributes
-
in file baseType.inc, method baseType::getDefaultListAttributes()
    Returns the default attribute list for this account type.
-
getDescription
-
in file mailAlias.inc, method mailAlias::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file baseType.inc, method baseType::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file user.inc, method user::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file smbDomain.inc, method smbDomain::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file group.inc, method group::getDescription()
    Returns the description of this account type.
-
getDescription
-
in file host.inc, method host::getDescription()
    Returns the description of this account type.
-
getListAttributeDescriptions
-
in file types.inc, function getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file group.inc, method group::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file user.inc, method user::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file smbDomain.inc, method smbDomain::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file baseType.inc, method baseType::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file host.inc, method host::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListAttributeDescriptions
-
in file mailAlias.inc, method mailAlias::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.
-
getListClassName
-
in file group.inc, method group::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file types.inc, function getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file user.inc, method user::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file baseType.inc, method baseType::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file smbDomain.inc, method smbDomain::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file host.inc, method host::getListClassName()
    Returns the class name for the list object.
-
getListClassName
-
in file mailAlias.inc, method mailAlias::getListClassName()
    Returns the class name for the list object.
-
getTypeAlias
-
in file types.inc, function getTypeAlias()
    Returns the alias name of an account type.
-
getTypeDescription
-
in file types.inc, function getTypeDescription()
    Returns the description of an account type.
-
getTypes
-
in file types.inc, function getTypes()
    Returns a list of available account types.
-
group
-
in file group.inc, class group
    The account type for group accounts (e.g. Unix and Samba).
-
group.inc
-
procedural page group.inc
-
-
- top
-
- -
-

h

-
-
host
-
in file host.inc, class host
    The account type for host accounts (e.g. Samba).
-
host.inc
-
procedural page host.inc
-
-
- top
-
- -
-

m

-
-
mailAlias.inc
-
procedural page mailAlias.inc
-
mailAlias
-
in file mailAlias.inc, class mailAlias
    The account type for mail aliases.
-
-
- top
-
- -
-

s

-
-
smbDomain.inc
-
procedural page smbDomain.inc
-
smbDomain
-
in file smbDomain.inc, class smbDomain
    The account type for Samba domains.
-
-
- top
-
- -
-

t

-
-
types.inc
-
procedural page types.inc
-
-
- top
-
- -
-

u

-
-
user.inc
-
procedural page user.inc
-
user
-
in file user.inc, class user
    The account type for user accounts (e.g. Unix, Samba and Kolab).
-
-
- top
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/errors.html b/lam-web/developers/devel/phpdoc/errors.html deleted file mode 100644 index 18f40da4..00000000 --- a/lam-web/developers/devel/phpdoc/errors.html +++ /dev/null @@ -1,175 +0,0 @@ - - -phpDocumentor Parser Errors and Warnings - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -Post-parsing
-fpdf.php
-schema.inc
-ufpdf.php
- -

export.inc

-

Warnings:


-Warning on line 445 - Method "displayExportInfo" has no method-level DocBlock.
-Warning on line 590 - Method "PlaVcardExporter" has no method-level DocBlock.
-Warning on line 687 - Method "PlaCSVExporter" has no method-level DocBlock.
-Warning on line 775 - Method "export" has no method-level DocBlock.
-Warning on line 781 - Method "LdapEscape" has no method-level DocBlock.
-Warning on line 795 - Method "MyCutsomExporter" has no method-level DocBlock.
- -

fpdf.php

-

Warnings:


-Warning on line 202 - Method "SetMargins" has no method-level DocBlock.
-Warning on line 210 - Method "SetLeftMargin" has no method-level DocBlock.
-Warning on line 216 - Method "SetTopMargin" has no method-level DocBlock.
-Warning on line 222 - Method "SetRightMargin" has no method-level DocBlock.
-Warning on line 230 - Method "SetAutoPageBreak" has no method-level DocBlock.
-Warning on line 243 - Method "SetDisplayMode" has no method-level DocBlock.
-Warning on line 252 - Method "SetCompression" has no method-level DocBlock.
-Warning on line 258 - Method "SetTitle" has no method-level DocBlock.
-Warning on line 264 - Method "SetSubject" has no method-level DocBlock.
-Warning on line 270 - Method "SetAuthor" has no method-level DocBlock.
-Warning on line 276 - Method "SetKeywords" has no method-level DocBlock.
-Warning on line 282 - Method "SetCreator" has no method-level DocBlock.
-Warning on line 288 - Method "AliasNbPages" has no method-level DocBlock.
-Warning on line 294 - Method "Error" has no method-level DocBlock.
-Warning on line 300 - Method "Open" has no method-level DocBlock.
-Warning on line 317 - Method "Close" has no method-level DocBlock.
-Warning on line 384 - Method "AddPage" has no method-level DocBlock.
-Warning on line 389 - Method "Header" has no method-level DocBlock.
-Warning on line 394 - Method "Footer" has no method-level DocBlock.
-Warning on line 400 - Method "PageNo" has no method-level DocBlock.
-Warning on line 411 - Method "SetDrawColor" has no method-level DocBlock.
-Warning on line 423 - Method "SetFillColor" has no method-level DocBlock.
-Warning on line 433 - Method "SetTextColor" has no method-level DocBlock.
-Warning on line 445 - Method "GetStringWidth" has no method-level DocBlock.
-Warning on line 453 - Method "SetLineWidth" has no method-level DocBlock.
-Warning on line 459 - Method "Line" has no method-level DocBlock.
-Warning on line 471 - Method "Rect" has no method-level DocBlock.
-Warning on line 519 - Method "AddFont" has no method-level DocBlock.
-Warning on line 579 - Method "SetFont" has no method-level DocBlock.
-Warning on line 590 - Method "SetFontSize" has no method-level DocBlock.
-Warning on line 598 - Method "AddLink" has no method-level DocBlock.
-Warning on line 608 - Method "SetLink" has no method-level DocBlock.
-Warning on line 614 - Method "Link" has no method-level DocBlock.
-Warning on line 625 - Method "Text" has no method-level DocBlock.
-Warning on line 631 - Method "AcceptPageBreak" has no method-level DocBlock.
-Warning on line 710 - Method "Cell" has no method-level DocBlock.
-Warning on line 823 - Method "MultiCell" has no method-level DocBlock.
-Warning on line 904 - Method "Write" has no method-level DocBlock.
-Warning on line 954 - Method "Image" has no method-level DocBlock.
-Warning on line 964 - Method "Ln" has no method-level DocBlock.
-Warning on line 970 - Method "GetX" has no method-level DocBlock.
-Warning on line 979 - Method "SetX" has no method-level DocBlock.
-Warning on line 985 - Method "GetY" has no method-level DocBlock.
-Warning on line 995 - Method "SetY" has no method-level DocBlock.
-Warning on line 1002 - Method "SetXY" has no method-level DocBlock.
-Warning on line 1070 - Method "Output" has no method-level DocBlock.
-Warning on line 1092 - Method "_getfontpath" has no method-level DocBlock.
-Warning on line 1163 - Method "_putpages" has no method-level DocBlock.
-Warning on line 1280 - Method "_putfonts" has no method-level DocBlock.
-Warning on line 1328 - Method "_putimages" has no method-level DocBlock.
-Warning on line 1334 - Method "_putxobjectdict" has no method-level DocBlock.
-Warning on line 1346 - Method "_putresourcedict" has no method-level DocBlock.
-Warning on line 1359 - Method "_putresources" has no method-level DocBlock.
-Warning on line 1375 - Method "_putinfo" has no method-level DocBlock.
-Warning on line 1395 - Method "_putcatalog" has no method-level DocBlock.
-Warning on line 1400 - Method "_putheader" has no method-level DocBlock.
-Warning on line 1407 - Method "_puttrailer" has no method-level DocBlock.
-Warning on line 1442 - Method "_enddoc" has no method-level DocBlock.
-Warning on line 1481 - Method "_beginpage" has no method-level DocBlock.
-Warning on line 1487 - Method "_endpage" has no method-level DocBlock.
-Warning on line 1495 - Method "_newobj" has no method-level DocBlock.
-Warning on line 1504 - Method "_dounderline" has no method-level DocBlock.
-Warning on line 1528 - Method "_parsejpg" has no method-level DocBlock.
-Warning on line 1611 - Method "_parsepng" has no method-level DocBlock.
-Warning on line 1618 - Method "_freadint" has no method-level DocBlock.
-Warning on line 1624 - Method "_textstring" has no method-level DocBlock.
-Warning on line 1630 - Method "_escape" has no method-level DocBlock.
-Warning on line 1637 - Method "_putstream" has no method-level DocBlock.
-Warning on line 1646 - Method "_out" has no method-level DocBlock.
- -

schema.inc

-

Warnings:


-Warning on line 67 - Method "setOID" has no method-level DocBlock.
-Warning on line 72 - Method "setDescription" has no method-level DocBlock.
-Warning on line 77 - Method "getOID" has no method-level DocBlock.
-Warning on line 82 - Method "getDescription" has no method-level DocBlock.
-Warning on line 1232 - Method "MatchingRuleUse" has no method-level DocBlock.
- -

ufpdf.php

-

Warnings:


-Warning on line 70 - Method "GetStringWidth" has no method-level DocBlock.
-Warning on line 99 - Method "AddFont" has no method-level DocBlock.
-Warning on line 110 - Method "Text" has no method-level DocBlock.
-Warning on line 116 - Method "AcceptPageBreak" has no method-level DocBlock.
-Warning on line 196 - Method "Cell" has no method-level DocBlock.
-Warning on line 321 - Method "MultiCell" has no method-level DocBlock.
-Warning on line 404 - Method "Write" has no method-level DocBlock.
-Warning on line 410 - Method "AliasNbPages" has no method-level DocBlock.
-Warning on line 487 - Method "_dounderline" has no method-level DocBlock.
-Warning on line 495 - Method "_textstring" has no method-level DocBlock.
-Warning on line 503 - Method "_escapetext" has no method-level DocBlock.
-Warning on line 519 - Method "_putinfo" has no method-level DocBlock.
-Warning on line 592 - Method "_putpages" has no method-level DocBlock.
-Warning on line 694 - Method "utf8_to_utf16be" has no method-level DocBlock.
-Warning on line 702 - Method "code2utf" has no method-level DocBlock.
-Warning on line 706 - Method "strlen" has no method-level DocBlock.
-Warning on line 721 - Method "utf8_substr" has no method-level DocBlock.
-Warning on line 813 - Method "utf8_to_codepoints" has no method-level DocBlock.
-
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/index.html b/lam-web/developers/devel/phpdoc/index.html deleted file mode 100644 index d96d9e94..00000000 --- a/lam-web/developers/devel/phpdoc/index.html +++ /dev/null @@ -1,65 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
default
- - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to default!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_Help.html b/lam-web/developers/devel/phpdoc/li_Help.html deleted file mode 100644 index b10a68d3..00000000 --- a/lam-web/developers/devel/phpdoc/li_Help.html +++ /dev/null @@ -1,76 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
Help
- - - [ class tree: Help ] - [ index: Help ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to Help!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_LDAP.html b/lam-web/developers/devel/phpdoc/li_LDAP.html deleted file mode 100644 index 0bde2507..00000000 --- a/lam-web/developers/devel/phpdoc/li_LDAP.html +++ /dev/null @@ -1,79 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
LDAP
- - - [ class tree: LDAP ] - [ index: LDAP ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to LDAP!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_PDF.html b/lam-web/developers/devel/phpdoc/li_PDF.html deleted file mode 100644 index bf1f0dff..00000000 --- a/lam-web/developers/devel/phpdoc/li_PDF.html +++ /dev/null @@ -1,106 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
PDF
- - - [ class tree: PDF ] - [ index: PDF ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to PDF!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_configuration.html b/lam-web/developers/devel/phpdoc/li_configuration.html deleted file mode 100644 index 06962702..00000000 --- a/lam-web/developers/devel/phpdoc/li_configuration.html +++ /dev/null @@ -1,96 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
configuration
- - - [ class tree: configuration ] - [ index: configuration ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to configuration!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_lib.html b/lam-web/developers/devel/phpdoc/li_lib.html deleted file mode 100644 index b284450d..00000000 --- a/lam-web/developers/devel/phpdoc/li_lib.html +++ /dev/null @@ -1,94 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to lib!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_lists.html b/lam-web/developers/devel/phpdoc/li_lists.html deleted file mode 100644 index 4c3d119a..00000000 --- a/lam-web/developers/devel/phpdoc/li_lists.html +++ /dev/null @@ -1,152 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to lists!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_main.html b/lam-web/developers/devel/phpdoc/li_main.html deleted file mode 100644 index 7433174a..00000000 --- a/lam-web/developers/devel/phpdoc/li_main.html +++ /dev/null @@ -1,84 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to main!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_modules.html b/lam-web/developers/devel/phpdoc/li_modules.html deleted file mode 100644 index 16c4dfba..00000000 --- a/lam-web/developers/devel/phpdoc/li_modules.html +++ /dev/null @@ -1,138 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to modules!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_profiles.html b/lam-web/developers/devel/phpdoc/li_profiles.html deleted file mode 100644 index 7b2707f6..00000000 --- a/lam-web/developers/devel/phpdoc/li_profiles.html +++ /dev/null @@ -1,80 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to profiles!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_selfService.html b/lam-web/developers/devel/phpdoc/li_selfService.html deleted file mode 100644 index 491db3d6..00000000 --- a/lam-web/developers/devel/phpdoc/li_selfService.html +++ /dev/null @@ -1,79 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to selfService!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_tests.html b/lam-web/developers/devel/phpdoc/li_tests.html deleted file mode 100644 index 5fdf0447..00000000 --- a/lam-web/developers/devel/phpdoc/li_tests.html +++ /dev/null @@ -1,78 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to tests!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_tools.html b/lam-web/developers/devel/phpdoc/li_tools.html deleted file mode 100644 index be3b59b4..00000000 --- a/lam-web/developers/devel/phpdoc/li_tools.html +++ /dev/null @@ -1,106 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to tools!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/li_types.html b/lam-web/developers/devel/phpdoc/li_types.html deleted file mode 100644 index e82f9fe8..00000000 --- a/lam-web/developers/devel/phpdoc/li_types.html +++ /dev/null @@ -1,96 +0,0 @@ - - -LDAP Account Manager - Documentation - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

LDAP Account Manager - Documentation

-Welcome to types!
-
-This documentation was generated by phpDocumentor v1.4.0
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lib/AttributeType.html b/lam-web/developers/devel/phpdoc/lib/AttributeType.html deleted file mode 100644 index e7f251f7..00000000 --- a/lam-web/developers/devel/phpdoc/lib/AttributeType.html +++ /dev/null @@ -1,1199 +0,0 @@ - - -Docs For Class AttributeType - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: AttributeType

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --AttributeType

-
Represents an LDAP AttributeType


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 514]
-Represents an LDAP AttributeType



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$aliases =

-

[line 539]

- An array of alias attribute names, strings

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$equality =

-

[line 523]

- The equality rule used

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$is_collective =

-

[line 533]

- boolean: is collective?

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$is_no_user_modification =

-

[line 535]

- boolean: can use modify?

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$is_obsolete =

-

[line 519]

- string: the description

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$is_single_value =

-

[line 531]

- boolean: is single valued only?

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$max_length =

-

[line 541]

- The max number of characters this attribute can be

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$name =

-

[line 517]

- The name of this attributeType

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$ordering =

-

[line 525]

- The ordering of the attributeType

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$required_by_object_classes = array()

-

[line 547]

- A list of object class names that require this attribute type.

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sub_str =

-

[line 527]

- Boolean: supports substring matching?

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sup_attribute =

-

[line 521]

- The attribute from which this attribute inherits (if any)

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$syntax =

-

[line 529]

- The full syntax string, ie 1.2.3.4{16}

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$type =

-

[line 543]

- A string description of the syntax type (taken from the LDAPSyntaxes)

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$usage =

-

[line 537]

- The usage string set by the LDAP schema

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$used_in_object_classes =

-

[line 545]

- An array of objectClasses which use this attributeType (must be set by caller)

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor AttributeType [line 579]

-
-
-
- AttributeType AttributeType( - -$raw_ldap_attr_string) -
-

- - Creates a new AttributeType objcet from a raw LDAP AttributeType string.



- - -

Parameters:

-
- - - - - - -
  $raw_ldap_attr_string  
-

-
[ Top ]
-
-
- -

method addAlias [line 878]

-
-
-
- void addAlias( -string -$new_alias_name) -
-

- - Adds an attribute name to the alias array.



- - -

Parameters:

-
- - - - - - -
string  $new_alias_name  The name of a new attribute to add to this attribute's list of aliases.
-

-
[ Top ]
-
-
- -

method addRequiredByObjectClass [line 948]

-
-
-
- void addRequiredByObjectClass( -string -$object_class_name) -
-

- - Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.



- - -

Parameters:

-
- - - - - - -
string  $object_class_name  The name of the objectClass to add.
-

-
[ Top ]
-
-
- -

method addUsedInObjectClass [line 924]

-
-
-
- void addUsedInObjectClass( -string -$object_class_name) -
-

- - Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.



- - -

Parameters:

-
- - - - - - -
string  $object_class_name  The name of the objectClass to add.
-

-
[ Top ]
-
-
- -

method getAliases [line 761]

-
-
-
- array getAliases( -) -
-

- - Gets the names of attributes that are an alias for this attribute (if any).



-

Tags:

-
- - - - -
return:  An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object.
-
-

- - -
[ Top ]
-
-
- -

method getEquality [line 733]

-
-
-
- string getEquality( -) -
-

- - Gets this attribute's equality string



- - -
[ Top ]
-
-
- -

method getIsCollective [line 833]

-
-
-
- bool getIsCollective( -) -
-

- - Gets whether this attribute is collective.



-

Tags:

-
- - - - -
return:  Returns true if this attribute is collective and false otherwise.
-
-

- - -
[ Top ]
-
-
- -

method getIsNoUserModification [line 842]

-
-
-
- bool getIsNoUserModification( -) -
-

- - Gets whether this attribute is not modifiable by users.



-

Tags:

-
- - - - -
return:  Returns true if this attribute is not modifiable by users.
-
-

- - -
[ Top ]
-
-
- -

method getIsObsolete [line 705]

-
-
-
- bool getIsObsolete( -) -
-

- - Gets whether this attribute has been flagged as obsolete by the LDAP server



- - -
[ Top ]
-
-
- -

method getIsSingleValue [line 815]

-
-
-
- bool getIsSingleValue( -) -
-

- - Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.



-

Tags:

-
- - - - -
return:  Returns true if this attribute is single-valued or false otherwise.
-
-

- - -
[ Top ]
-
-
- -

method getMaxLength [line 805]

-
-
-
- int getMaxLength( -) -
-

- - Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.



-

Tags:

-
- - - - -
return:  The maximum length (in characters) of this attribute or null if no maximum is specified.
-
-

- - -
[ Top ]
-
-
- -

method getName [line 696]

-
-
-
- string getName( -) -
-

- - Gets this attribute's name



- - -
[ Top ]
-
-
- -

method getOrdering [line 742]

-
-
-
- string getOrdering( -) -
-

- - Gets this attribute's ordering specification.



- - -
[ Top ]
-
-
- -

method getRequiredByObjectClasses [line 962]

-
-
-
- array getRequiredByObjectClasses( -) -
-

- - Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.



-

Tags:

-
- - - - -
return:  An array of names of objectclasses (strings) which provide this attribute
-
-

- - -
[ Top ]
-
-
- -

method getSubstr [line 751]

-
-
-
- string getSubstr( -) -
-

- - Gets this attribute's substring matching specification



- - -
[ Top ]
-
-
- -

method getSupAttribute [line 724]

-
-
-
- string getSupAttribute( -) -
-

- - Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.



- - -
[ Top ]
-
-
- -

method getSyntaxOID [line 796]

-
-
-
- string getSyntaxOID( -) -
-

- - Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.

Ie, if the syntax string is "1.2.3.4{16}", this function only retruns "1.2.3.4".




-

Tags:

-
- - - - -
return:  The syntax OID string.
-
-

- - -
[ Top ]
-
-
- -

method getSyntaxString [line 784]

-
-
-
- string getSyntaxString( -) -
-

- - Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").



-

Tags:

-
- - - - -
return:  The raw syntax string
-
-

- - -
[ Top ]
-
-
- -

method getType [line 851]

-
-
-
- string getType( -) -
-

- - Gets this attribute's type



-

Tags:

-
- - - - -
return:  The attribute's type.
-
-

- - -
[ Top ]
-
-
- -

method getUsage [line 714]

-
-
-
- string getUsage( -) -
-

- - Gets this attribute's usage string as defined by the LDAP server



- - -
[ Top ]
-
-
- -

method getUsedInObjectClasses [line 938]

-
-
-
- array getUsedInObjectClasses( -) -
-

- - Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.



-

Tags:

-
- - - - -
return:  An array of names of objectclasses (strings) which provide this attribute
-
-

- - -
[ Top ]
-
-
- -

method initVars [line 552]

-
-
-
- void initVars( -) -
-

- - Initialize the class' member variables



- - Overrides SchemaItem::initVars() (Initialize class members to default values.)

-
[ Top ]
-
-
- -

method isAliasFor [line 771]

-
-
-
- bool isAliasFor( -string -$attr_name) -
-

- - Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).



-

Tags:

-
- - - - -
return:  True if the specified attribute is an alias for this one, or false otherwise.
-
-

- - -

Parameters:

-
- - - - - - -
string  $attr_name  The name of the attribute to check.
-

-
[ Top ]
-
-
- -

method removeAlias [line 862]

-
-
-
- bool removeAlias( -string -$remove_alias_name) -
-

- - Removes an attribute name from this attribute's alias array.



-

Tags:

-
- - - - -
return:  true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)
-
-

- - -

Parameters:

-
- - - - - - -
string  $remove_alias_name  The name of the attribute to remove.
-

-
[ Top ]
-
-
- -

method setAliases [line 905]

-
-
-
- void setAliases( -array -$new_aliases) -
-

- - Sets this attribute's list of aliases.



- - -

Parameters:

-
- - - - - - -
array  $new_aliases  The array of alias names (strings)
-

-
[ Top ]
-
-
- -

method setIsSingleValue [line 824]

-
-
-
- void setIsSingleValue( -bool -$is_single_value) -
-

- - Sets whether this attribute is single-valued.



- - -

Parameters:

-
- - - - - - -
bool  $is_single_value  
-

-
[ Top ]
-
-
- -

method setName [line 887]

-
-
-
- void setName( -string -$new_name) -
-

- - Sets this attriute's name.



- - -

Parameters:

-
- - - - - - -
string  $new_name  The new name to give this attribute.
-

-
[ Top ]
-
-
- -

method setSupAttribute [line 896]

-
-
-
- void setSupAttribute( -string -$new_sup_attr) -
-

- - Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).



- - -

Parameters:

-
- - - - - - -
string  $new_sup_attr  The name of the new parent (SUP) attribute
-

-
[ Top ]
-
-
- -

method setType [line 914]

-
-
-
- void setType( -string -$new_type) -
-

- - Sets this attribute's type.



- - -

Parameters:

-
- - - - - - -
string  $new_type  The new type.
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:53 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lib/MatchingRule.html b/lam-web/developers/devel/phpdoc/lib/MatchingRule.html deleted file mode 100644 index 7175f21f..00000000 --- a/lam-web/developers/devel/phpdoc/lib/MatchingRule.html +++ /dev/null @@ -1,473 +0,0 @@ - - -Docs For Class MatchingRule - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: MatchingRule

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --MatchingRule

-
Represents an LDAP MatchingRule


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 1019]
-Represents an LDAP MatchingRule



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$is_obsolete =

-

[line 1026]

- Boolean value indicating whether this MatchingRule is obsolete

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$name =

-

[line 1022]

- This rule's name

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$syntax =

-

[line 1024]

- This rule's syntax OID

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$used_by_attrs =

-

[line 1028]

- An array of attribute names who use this MatchingRule

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor MatchingRule [line 1045]

-
-
-
- MatchingRule MatchingRule( - -$raw_ldap_matching_rule_string) -
-

- - Creates a new MatchingRule object from a raw LDAP MatchingRule string.



- - -

Parameters:

-
- - - - - - -
  $raw_ldap_matching_rule_string  
-

-
[ Top ]
-
-
- -

method addUsedByAttr [line 1115]

-
-
-
- true addUsedByAttr( - -$new_attr_name) -
-

- - Adds an attribute name to the list of attributes who use this MatchingRule



-

Tags:

-
- - - - -
return:  if the attribute was added and false otherwise (already in the list)
-
-

- - -

Parameters:

-
- - - - - - -
  $new_attr_name  
-

-
[ Top ]
-
-
- -

method getIsObsolete [line 1137]

-
-
-
- bool getIsObsolete( -) -
-

- - Gets whether this MatchingRule is flagged as obsolete by the LDAP server.



-

Tags:

-
- - - - -
return:  True if this MatchingRule is obsolete and false otherwise.
-
-

- - -
[ Top ]
-
-
- -

method getName [line 1128]

-
-
-
- string getName( -) -
-

- - Gets this MatchingRule's name.



-

Tags:

-
- - - - -
return:  The name.
-
-

- - -
[ Top ]
-
-
- -

method getUsedByAttrs [line 1146]

-
-
-
- array getUsedByAttrs( -) -
-

- - Gets an array of attribute names (strings) which use this MatchingRule



-

Tags:

-
- - - - -
return:  The array of attribute names (strings).
-
-

- - -
[ Top ]
-
-
- -

method initVars [line 1031]

-
-
-
- void initVars( -) -
-

- - Initialize the class' member variables



- - Overrides SchemaItem::initVars() (Initialize class members to default values.)

-
[ Top ]
-
-
- -

method setUsedByAttrs [line 1106]

-
-
-
- void setUsedByAttrs( -array -$attrs) -
-

- - Sets the list of used_by_attrs to the array specified by $attrs;



- - -

Parameters:

-
- - - - - - -
array  $attrs  The array of attribute names (strings) which use this MatchingRule
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lib/MatchingRuleUse.html b/lam-web/developers/devel/phpdoc/lib/MatchingRuleUse.html deleted file mode 100644 index 7b00cea9..00000000 --- a/lam-web/developers/devel/phpdoc/lib/MatchingRuleUse.html +++ /dev/null @@ -1,350 +0,0 @@ - - -Docs For Class MatchingRuleUse - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: MatchingRuleUse

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --MatchingRuleUse

-
Represents an LDAP schema matchingRuleUse entry


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 1157]
-Represents an LDAP schema matchingRuleUse entry



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$name =

-

[line 1160]

- The name of the MathingRule this applies to

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$used_by_attrs =

-

[line 1163]

- An array of attributeType names who make use of the mathingRule

identified by $this->oid and $this->name


-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor MatchingRuleUse [line 1174]

-
-
-
- MatchingRuleUse MatchingRuleUse( - -$raw_matching_rule_use_string) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $raw_matching_rule_use_string  
-

-
[ Top ]
-
-
- -

method getName [line 1239]

-
-
-
- string getName( -) -
-

- - Gets this MatchingRuleUse's name



-

Tags:

-
- - - - -
return:  The name
-
-

- - -
[ Top ]
-
-
- -

method getUsedByAttrs [line 1248]

-
-
-
- array getUsedByAttrs( -) -
-

- - Gets an array of attribute names (strings) which use this MatchingRuleUse object.



-

Tags:

-
- - - - -
return:  The array of attribute names (strings).
-
-

- - -
[ Top ]
-
-
- -

method initVars [line 1166]

-
-
-
- void initVars( -) -
-

- - Initialize the class' member variables



- - Overrides SchemaItem::initVars() (Initialize class members to default values.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lib/ObjectClass.html b/lam-web/developers/devel/phpdoc/lib/ObjectClass.html deleted file mode 100644 index b472a709..00000000 --- a/lam-web/developers/devel/phpdoc/lib/ObjectClass.html +++ /dev/null @@ -1,770 +0,0 @@ - - -Docs For Class ObjectClass - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: ObjectClass

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --ObjectClass

-
Represents an LDAP objectClass


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 91]
-Represents an LDAP objectClass



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$children_objectclasses =

-

[line 106]

- array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$is_obsolete =

-

[line 104]

- boolean value indicating whether this objectClass is obsolete

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$may_attrs =

-

[line 102]

- arrays of attribute names that this objectClass allows, but does not require

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$must_attrs =

-

[line 100]

- arrays of attribute names that this objectClass requires

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$name =

-

[line 94]

- This objectClass' name, ie "inetOrgPerson"

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sup_classes =

-

[line 96]

- array of objectClass names from which this objectClass inherits

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$type =

-

[line 98]

- one of STRUCTURAL, ABSTRACT, or AUXILIARY

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor ObjectClass [line 126]

-
-
-
- ObjectClass ObjectClass( - -$raw_ldap_schema_string) -
-

- - Creates a new ObjectClass object given a raw LDAP objectClass string.



- - -

Parameters:

-
- - - - - - -
  $raw_ldap_schema_string  
-

-
[ Top ]
-
-
- -

method addChildObjectClass [line 376]

-
-
-
- bool addChildObjectClass( -String -$object_class_name) -
-

- - Adds an objectClass to the list of objectClasses that inherit from this objectClass.



-

Tags:

-
- - - - -
return:  Returns true on success or false on failure (objectclass already existed for example)
-
-

- - -

Parameters:

-
- - - - - - -
String  $object_class_name  The name of the objectClass to add
-

-
[ Top ]
-
-
- -

method addMayAttrs [line 454]

-
-
-
- void addMayAttrs( -array -$new_may_attrs) -
-

- - Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.



- - -

Parameters:

-
- - - - - - -
array  $new_may_attrs  An array of attribute names (strings) to add.
-

-
[ Top ]
-
-
- -

method addMustAttrs [line 439]

-
-
-
- void addMustAttrs( -array -$new_must_attrs) -
-

- - Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.



- - -

Parameters:

-
- - - - - - -
array  $new_must_attrs  An array of attribute names (strings) to add.
-

-
[ Top ]
-
-
- -

method getChildObjectClasses [line 392]

-
-
-
- Array getChildObjectClasses( -) -
-

- - Returns the array of objectClass names which inherit from this objectClass.



-

Tags:

-
- - - - -
return:  Names of objectClasses which inherit from this objectClass.
-
-

- - -
[ Top ]
-
-
- -

method getIsObsolete [line 427]

-
-
-
- void getIsObsolete( -) -
-

- - Gets whether this objectClass is flagged as obsolete by the LDAP server.



- - -
[ Top ]
-
-
- -

method getMayAttrNames [line 361]

-
-
-
- array getMayAttrNames( -[array -$oclasses = null]) -
-

- - Gets an array of attribute names (strings) that entries of this ObjectClass must define.

This differs from getMayAttrs in that it returns an array of strings rather than array of AttributeType objects




-

Tags:

-
- - - - - - - - - - - - - -
return:  The array of allowed attribute names (strings).
see:  ObjectClass::getMustAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrs()
-
-

- - -

Parameters:

-
- - - - - - -
array  $oclasses  An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
-

-
[ Top ]
-
-
- -

method getMayAttrs [line 303]

-
-
-
- array getMayAttrs( -[array -$oclasses = NULL]) -
-

- - Gets an array of AttributeType objects that entries of this ObjectClass may define.

This differs from getMayAttrNames in that it returns an array of AttributeType objects




-

Tags:

-
- - - - - - - - - - - - - - - - -
return:  The array of allowed AttributeType objects.
see:  AttributeType
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMustAttrs()
see:  ObjectClass::getMustAttrNames()
-
-

- - -

Parameters:

-
- - - - - - -
array  $oclasses  An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
-

-
[ Top ]
-
-
- -

method getMustAttrNames [line 337]

-
-
-
- array getMustAttrNames( -[array -$oclasses = null]) -
-

- - Gets an array of attribute names (strings) that entries of this ObjectClass must define.

This differs from getMustAttrs in that it returns an array of strings rather than array of AttributeType objects




-

Tags:

-
- - - - - - - - - - - - - -
return:  The array of allowed attribute names (strings).
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrs()
-
-

- - -

Parameters:

-
- - - - - - -
array  $oclasses  An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.
-

-
[ Top ]
-
-
- -

method getMustAttrs [line 269]

-
-
-
- array getMustAttrs( -[array -$oclasses = NULL]) -
-

- - Gets an array of AttributeType objects that entries of this ObjectClass must define.

This differs from getMustAttrNames in that it returns an array of AttributeType objects




-

Tags:

-
- - - - - - - - - - - - - -
return:  The array of required AttributeType objects.
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrNames()
-
-

- - -

Parameters:

-
- - - - - - -
array  $oclasses  An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass requires.
-

-
[ Top ]
-
-
- -

method getName [line 401]

-
-
-
- string getName( -) -
-

- - Gets the name of this objectClass (ie, "inetOrgPerson")



-

Tags:

-
- - - - -
return:  The name of the objectClass
-
-

- - -
[ Top ]
-
-
- -

method getSupClasses [line 411]

-
-
-
- array getSupClasses( -) -
-

- - Gets the objectClass names from which this objectClass inherits.



-

Tags:

-
- - - - -
return:  An array of objectClass names (strings)
-
-

- - -
[ Top ]
-
-
- -

method getType [line 419]

-
-
-
- void getType( -) -
-

- - Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.



- - -
[ Top ]
-
-
- -

method initVars [line 109]

-
-
-
- void initVars( -) -
-

- - Initialize the class' member variables



- - Overrides SchemaItem::initVars() (Initialize class members to default values.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lib/ObjectClassAttribute.html b/lam-web/developers/devel/phpdoc/lib/ObjectClassAttribute.html deleted file mode 100644 index bad03f78..00000000 --- a/lam-web/developers/devel/phpdoc/lib/ObjectClassAttribute.html +++ /dev/null @@ -1,255 +0,0 @@ - - -Docs For Class ObjectClassAttribute - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: ObjectClassAttribute

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-

-
A simple class for representing AttributeTypes used only by the ObjectClass class.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 476]
-A simple class for representing AttributeTypes used only by the ObjectClass class.

Users should never instantiate this class. It represents an attribute internal to an ObjectClass. If PHP supported inner-classes and variable permissions, this would be interior to class ObjectClass and flagged private. The reason this class is used and not the "real" class AttributeType is because this class supports the notion of a "source" objectClass, meaning that it keeps track of which objectClass originally specified it. This class is therefore used by the class ObjectClass to determine inheritance.




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$name =

-

[line 479]

- This Attribute's name

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$source =

-

[line 481]

- This Attribute's root

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor ObjectClassAttribute [line 489]

-
-
-
- ObjectClassAttribute ObjectClassAttribute( -string -$name, string -$source) -
-

- - Creates a new ObjectClassAttribute with specified name and source objectClass.



- - -

Parameters:

-
- - - - - - - - - - - -
string  $name  the name of the new attribute.
string  $source  the name of the ObjectClass which specifies this attribute.
-

-
[ Top ]
-
-
- -

method getName [line 496]

-
-
-
- void getName( -) -
-

- - Gets this attribute's name



- - -
[ Top ]
-
-
- -

method getSource [line 502]

-
-
-
- void getSource( -) -
-

- - Gets the name of the ObjectClass which originally specified this attribute.



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lib/SchemaItem.html b/lam-web/developers/devel/phpdoc/lib/SchemaItem.html deleted file mode 100644 index d4cde90b..00000000 --- a/lam-web/developers/devel/phpdoc/lib/SchemaItem.html +++ /dev/null @@ -1,358 +0,0 @@ - - -Docs For Class SchemaItem - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: SchemaItem

-Source Location: /lib/schema.inc

- - - - - - - - - - -
- -

Class Overview

-

-
Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
ObjectClass
-
Represents an LDAP objectClass
-
-
-
AttributeType
-
Represents an LDAP AttributeType
-
-
-
Syntax
-
Represents an LDAP Syntax
-
-
-
MatchingRule
-
Represents an LDAP MatchingRule
-
-
-
MatchingRuleUse
-
Represents an LDAP schema matchingRuleUse entry
-
-
-
-
- - -

Class Details

-
-[line 45]
-Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.

All schema items have at least two things in common: An OID and a description. This class provides an implementation for these two data.




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$description =

-

[line 50]

- The description of this schema item.

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$oid =

-

[line 48]

- The OID of this schema item.

-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor SchemaItem [line 60]

-
-
-
- SchemaItem SchemaItem( -) -
-

- - Default constructor.



- - -
[ Top ]
-
-
- -

method getDescription [line 80]

-
-
-
- void getDescription( -) -
-

- -

- - -
[ Top ]
-
-
- -

method getOID [line 75]

-
-
-
- void getOID( -) -
-

- -

- - -
[ Top ]
-
-
- -

method initVars [line 53]

-
-
-
- void initVars( -) -
-

- - Initialize class members to default values.



- -

Overridden in child classes as:
-

-
ObjectClass::initVars()
-
Initialize the class' member variables
-
-
-
AttributeType::initVars()
-
Initialize the class' member variables
-
-
-
Syntax::initVars()
-
Initializes the class' member variables
-
-
-
MatchingRule::initVars()
-
Initialize the class' member variables
-
-
-
MatchingRuleUse::initVars()
-
Initialize the class' member variables
-
-

- -
[ Top ]
-
-
- -

method setDescription [line 70]

-
-
-
- void setDescription( - -$new_desc) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $new_desc  
-

-
[ Top ]
-
-
- -

method setOID [line 65]

-
-
-
- void setOID( - -$new_oid) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $new_oid  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:54 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lib/Syntax.html b/lam-web/developers/devel/phpdoc/lib/Syntax.html deleted file mode 100644 index 127c1024..00000000 --- a/lam-web/developers/devel/phpdoc/lib/Syntax.html +++ /dev/null @@ -1,256 +0,0 @@ - - -Docs For Class Syntax - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: Syntax

-Source Location: /lib/schema.inc

- - - - - - - - - -
- -

Class Overview

-
SchemaItem
-   |
-   --Syntax

-
Represents an LDAP Syntax


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: SchemaItem

-
-
- SchemaItem::$description -
-
- -
-
- SchemaItem::$oid -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: SchemaItem

-
-
- SchemaItem::SchemaItem() -
-
- Default constructor. -
-
- SchemaItem::getDescription() -
-
- -
-
- SchemaItem::getOID() -
-
- -
-
- SchemaItem::initVars() -
-
- Initialize class members to default values. -
-
- SchemaItem::setDescription() -
-
- -
-
- SchemaItem::setOID() -
-
- -
-
-
-
-
- - -

Class Details

-
-[line 973]
-Represents an LDAP Syntax



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor Syntax [line 986]

-
-
-
- Syntax Syntax( - -$raw_ldap_syntax_string) -
-

- - Creates a new Syntax object from a raw LDAP syntax string.



- - -

Parameters:

-
- - - - - - -
  $raw_ldap_syntax_string  
-

-
[ Top ]
-
-
- -

method initVars [line 976]

-
-
-
- void initVars( -) -
-

- - Initializes the class' member variables



- - Overrides SchemaItem::initVars() (Initialize class members to default values.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:55 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lib/_lib---account.inc.html b/lam-web/developers/devel/phpdoc/lib/_lib---account.inc.html deleted file mode 100644 index f587d900..00000000 --- a/lam-web/developers/devel/phpdoc/lib/_lib---account.inc.html +++ /dev/null @@ -1,588 +0,0 @@ - - -Docs for page account.inc - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: account.inc

-Source Location: /lib/account.inc

- -
-
- -
-

Classes:

-
samba3domain
-
Represents a Samba 3 domain entry
-


- -

Page Details:

-This provides several helper function for the account modules.



-

Tags:

-
- - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
-
-

-

-

-
-
- -

array_delete [line 69]

-
-
-
- array array_delete( -array $values, array $array) -
-

- - This function will return all values from $array without values of $values.



-

Tags:

-
- - - - -
return:  list of remaining values
-
-

- -

Parameters

- - - - - - - - - - - -
array  $values  list of values which should be removed
array  $array  list of original values
-
[ Top ]


-
-
- -

cmp_domain [line 342]

-
-
-
- integer cmp_domain( -string $a, string $b) -
-

- - Helper function to sort the domains



-

Tags:

-
- - - - -
return:  0 if equal, 1 if $a is greater, -1 if $b is greater
-
-

- -

Parameters

- - - - - - - - - - - -
string  $a  first argument to compare
string  $b  second argument to compare
-
[ Top ]


-
-
- -

generateRandomPassword [line 293]

-
-
-
- String generateRandomPassword( -) -
-

- - Generates a random password with 12 digits.



-

Tags:

-
- - - - -
return:  password
-
-

- -
[ Top ]


-
-
- -

getdays [line 102]

-
-
-
- number getdays( -) -
-

- - This function will return the days from 1.1.1970 until now.



-

Tags:

-
- - - - -
return:  of days
-
-

- -
[ Top ]


-
-
- -

getshells [line 40]

-
-
-
- array getshells( -) -
-

- - Returns a list of shells listed in config/shells.



-

Tags:

-
- - - - -
return:  list of shell names
-
-

- -
[ Top ]


-
-
- -

get_preg [line 385]

-
-
-
- boolean get_preg( -string $argument, string $regexp) -
-

- - Checks if a given value matches the selected regular expression.



-

Tags:

-
- - - - -
return:  true if matches, otherwise false
-
-

- -

Parameters

- - - - - - - - - - - -
string  $argument  value to check
string  $regexp  pattern name
-
[ Top ]


-
-
- -

in_array_ignore_case [line 85]

-
-
-
- void in_array_ignore_case( - $needle, $haystack) -
-

- - Checks if a string exists in an array, ignoring case.



- -

Parameters

- - - - - - - - - - - -
  $needle  
  $haystack  
-
[ Top ]


-
-
- -

lmPassword [line 137]

-
-
-
- string lmPassword( -string $password) -
-

- - Generates the LM hash of a password.



-

Tags:

-
- - - - -
return:  password hash
-
-

- -

Parameters

- - - - - - -
string  $password  password original password
-
[ Top ]


-
-
- -

ntPassword [line 151]

-
-
-
- string ntPassword( -string $password) -
-

- - Generates the NT hash of a password.



-

Tags:

-
- - - - -
return:  password hash
-
-

- -

Parameters

- - - - - - -
string  $password  password original password
-
[ Top ]


-
-
- -

pwd_disable [line 251]

-
-
-
- string pwd_disable( -string $hash) -
-

- - Marks an password hash as disabled and returns the new hash string



-

Tags:

-
- - - - -
return:  disabled hash value
-
-

- -

Parameters

- - - - - - -
string  $hash  hash value to disable
-
[ Top ]


-
-
- -

pwd_enable [line 226]

-
-
-
- string pwd_enable( -string $hash) -
-

- - Marks an password hash as enabled and returns the new hash string



-

Tags:

-
- - - - -
return:  enabled password hash
-
-

- -

Parameters

- - - - - - -
string  $hash  hash value to enable
-
[ Top ]


-
-
- -

pwd_hash [line 171]

-
-
-
- string pwd_hash( -string $password, [boolean $enabled = true], [string $hashType = 'SSHA']) -
-

- - Returns the hash value of a plain text password the hash algorithm depends on the configuration file



-

Tags:

-
- - - - -
return:  the password hash
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $password  the password string
boolean  $enabled  marks the hash as enabled/disabled (e.g. by prefixing "!")
string  $hashType  password hash type (CRYPT, SHA, SSHA, MD5, SMD5, PLAIN)
-
[ Top ]


-
-
- -

pwd_is_enabled [line 276]

-
-
-
- boolean pwd_is_enabled( -string $hash) -
-

- - Checks if a password hash is enabled/disabled



-

Tags:

-
- - - - -
return:  true if the password is marked as enabled
-
-

- -

Parameters

- - - - - - -
string  $hash  password hash to check
-
[ Top ]


-
-
- -

search_domains [line 308]

-
-
-
- array search_domains( -) -
-

- - Returns an array with all Samba 3 domain entries under the given suffix



-

Tags:

-
- - - - -
return:  list of samba3domain objects
-
-

- -
[ Top ]


-
-
- -

smbflag [line 114]

-
-
-
- string smbflag( -array $input) -
-

- - Takes a list of Samba flags and creates the corresponding flag string.



-

Tags:

-
- - - - -
return:  Samba flag string
-
-

- -

Parameters

- - - - - - -
array  $input  is an array of Samba flags (e.g. X or D)
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:16 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lib/_lib---cache.inc.html b/lam-web/developers/devel/phpdoc/lib/_lib---cache.inc.html deleted file mode 100644 index 5ce67ca1..00000000 --- a/lam-web/developers/devel/phpdoc/lib/_lib---cache.inc.html +++ /dev/null @@ -1,123 +0,0 @@ - - -Docs for page cache.inc - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: cache.inc

-Source Location: /lib/cache.inc

- -
-
- -
-

Classes:

-
cache
-
This class contains all functions which are needed to manage the LDAP cache.
-


- -

Page Details:

-Provides a cache for LDAP attributes.



-

Tags:

-
- - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('ldap.inc') [line 34]
-en/decryption functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:20 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lib/_lib---schema.inc.html b/lam-web/developers/devel/phpdoc/lib/_lib---schema.inc.html deleted file mode 100644 index 2d97557a..00000000 --- a/lam-web/developers/devel/phpdoc/lib/_lib---schema.inc.html +++ /dev/null @@ -1,595 +0,0 @@ - - -Docs for page schema.inc - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: schema.inc

-Source Location: /lib/schema.inc

- -
-
- -
-

Classes:

-
SchemaItem
-
Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
-
ObjectClass
-
Represents an LDAP objectClass
-
ObjectClassAttribute
-
A simple class for representing AttributeTypes used only by the ObjectClass class.
-
AttributeType
-
Represents an LDAP AttributeType
-
Syntax
-
Represents an LDAP Syntax
-
MatchingRule
-
Represents an LDAP MatchingRule
-
MatchingRuleUse
-
Represents an LDAP schema matchingRuleUse entry
-


- -

Page Details:

-Classes and functions for fetching and parsing schema from an LDAP server.



-

Tags:

-
- - - - - - - -
author:  The phpLDAPadmin development team
author:  Roland Gruber
-
-

-

-

-
- -

SCHEMA_SESSION_CACHE_ENABLED [line 34]

-
-
-
- SCHEMA_SESSION_CACHE_ENABLED = 1 -
-
- - To enable/disable session-based schema caching (1: enabled, 0: disabled).


-
-
[ Top ]


-
-
- -

add_aliases_to_attrs [line 1702]

-
-
-
- void add_aliases_to_attrs( - &$attrs) -
-

- - For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.

This function will create a unique entry for 'gn' and 'givenName'.




- -

Parameters

- - - - - - -
  &$attrs  
-
[ Top ]


-
-
- -

add_sup_to_attrs [line 1727]

-
-
-
- void add_sup_to_attrs( - &$attrs, &$attrs_oid) -
-

- - Adds inherited values to each attributeType specified by the SUP directive.

Supports infinite levels of inheritance. Bug 856832: require a second paramter that has all attributes indexed by OID




- -

Parameters

- - - - - - - - - - - -
  &$attrs  
  &$attrs_oid  
-
[ Top ]


-
-
- -

cached_schema_available [line 1936]

-
-
-
- void cached_schema_available( - $schema_type) -
-

- - Returns true if the schema for $schema_type has been cached and

is availble. $schema_type may be one of (lowercase) the following: objectclasses attributetypes ldapsyntaxes matchingrules matchingruleuse Note that _get_raw_schema() takes a similar parameter.




- -

Parameters

- - - - - - -
  $schema_type  
-
[ Top ]


-
-
- -

get_cached_schema [line 1973]

-
-
-
- void get_cached_schema( - $schema_type) -
-

- - Returns the cached array of schemaitem objects for the specified

$schema_type. For list of valid $schema_type values, see above schema_cache_available(). Note that internally, this function utilizes a two-layer cache, one in memory using a static variable for multiple calls within the same page load, and one in a session for multiple calls within the same user session (spanning multiple page loads).

Returns an array of SchemaItem objects on success or false on failure.




- -

Parameters

- - - - - - -
  $schema_type  
-
[ Top ]


-
-
- -

get_schema_attribute [line 1589]

-
-
-
- AttributeType get_schema_attribute( - $attr_name, [string $dn = null], [ $use_cache = true], string $oclass_name) -
-

- - Gets a single AttributeType object specified by name.



-

Tags:

-
- - - - - - - - - - -
return:  The specified AttributeType object or false on error.
see:  get_schema_attributes()
see:  AttributeType
-
-

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string  $oclass_name  The name of the AttributeType to fetch.
string  $dn  (optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).
  $attr_name  
  $use_cache  
-
[ Top ]


-
-
- -

get_schema_attributes [line 1610]

-
-
-
- array get_schema_attributes( -[string $dn = null], [ $use_cache = true]) -
-

- - Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.



-

Tags:

-
- - - - -
return:  An array of AttributeType objects.
-
-

- -

Parameters

- - - - - - - - - - - -
string  $dn  (optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).
  $use_cache  
-
[ Top ]


-
-
- -

get_schema_matching_rules [line 1841]

-
-
-
- void get_schema_matching_rules( -[ $dn = null], [ $use_cache = true]) -
-

- - Returns an array of MatchingRule objects for the specified server.

The key of each entry is the OID of the matching rule.




- -

Parameters

- - - - - - - - - - - -
  $dn  
  $use_cache  
-
[ Top ]


-
-
- -

get_schema_objectclass [line 1565]

-
-
-
- ObjectClass get_schema_objectclass( -string $oclass_name, [string $dn = null], [ $use_cache = true]) -
-

- - Gets a single ObjectClass object specified by name.



-

Tags:

-
- - - - - - - - - - -
return:  The specified ObjectClass object or false on error.
see:  get_schema_objectclasses()
see:  ObjectClass
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $oclass_name  The name of the objectClass to fetch.
string  $dn  (optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).
  $use_cache  
-
[ Top ]


-
-
- -

get_schema_objectclasses [line 1525]

-
-
-
- array get_schema_objectclasses( -[string $dn = null], [ $use_cache = true]) -
-

- - Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.



-

Tags:

-
- - - - - - - - - - -
return:  An array of ObjectClass objects.
see:  get_schema_objectclass()
see:  ObjectClass
-
-

- -

Parameters

- - - - - - - - - - - -
string  $dn  (optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should).
  $use_cache  
-
[ Top ]


-
-
- -

get_schema_syntaxes [line 1895]

-
-
-
- void get_schema_syntaxes( -[ $dn = null], [ $use_cache = true]) -
-

- - Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.



- -

Parameters

- - - - - - - - - - - -
  $dn  
  $use_cache  
-
[ Top ]


-
-
- -

set_cached_schema [line 2004]

-
-
-
- void set_cached_schema( - $schema_type, $schema_items) -
-

- - Caches the specified $schema_type.

$schema_items should be an array of SchemaItem instances (ie, an array of ObjectClass, AttributeType, LDAPSyntax, MatchingRuleUse, or MatchingRule objects.

Returns true on success of false on failure.




- -

Parameters

- - - - - - - - - - - -
  $schema_type  
  $schema_items  
-
[ Top ]


-
-
- -

set_schema_cache_unavailable [line 2033]

-
-
-
- void set_schema_cache_unavailable( -) -
-

- - Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.



- -
[ Top ]


-
-
- -

_get_raw_schema [line 1334]

-
-
-
- an _get_raw_schema( -$schema_to_fetch $schema_to_fetch, [$dn $dn = '']) -
-

- - Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".



-

Tags:

-
- - - - -
return:  array of strings of this form: Array ( [0] => "( 1.3.6.1.4.1.7165.1.2.2.4 NAME 'gidPool' DESC 'Pool ... [1] => "( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaAccount' DESC 'Sa ... etc.
-
-

- -

Parameters

- - - - - - - - - - - -
$schema_to_fetch  $schema_to_fetch  - A string indicating which type of schema to fetch. Five valid values: 'objectclasses', 'attributetypes', 'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'. Case insensitive.
$dn  $dn  (optional) This paremeter is the DN of the entry whose schema you would like to fetch. Entries have the option of specifying their own subschemaSubentry that points to the DN of the system schema entry which applies to this attribute. If unspecified, this will try to retrieve the schema from the RootDSE subschemaSubentry. Failing that, we use some commonly known schema DNs. Default value is the Root DSE DN (zero-length string)
-
[ Top ]


-
-
- -

_get_schema_dn [line 1267]

-
-
-
- string _get_schema_dn( -string $dn, [bool $debug = false]) -
-

- - Helper for _get_raw_schema() which fetches the DN of the schema object

in an LDAP server based on a DN. Entries should set the subSchemaSubEntry attribute pointing to the DN of the server schema. You can specify the DN whose subSchemaSubEntry you wish to retrieve of specify an empty string to fetch the subScehamSubEntry from the Root DSE.




-

Tags:

-
- - - - -
return:  The DN of the entry which houses this LDAP server's schema.
-
-

- -

Parameters

- - - - - - - - - - - -
string  $dn  The DN (may be null) which houses the subschemaSubEntry attribute which this function can use to determine the schema entry's DN.
bool  $debug  Switch to true to see some nice and copious output. :)
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:53 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lib/_lib---security.inc.html b/lam-web/developers/devel/phpdoc/lib/_lib---security.inc.html deleted file mode 100644 index fac2bf84..00000000 --- a/lam-web/developers/devel/phpdoc/lib/_lib---security.inc.html +++ /dev/null @@ -1,237 +0,0 @@ - - -Docs for page security.inc - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: security.inc

-Source Location: /lib/security.inc

- -
-
- - -

Page Details:

-This file includes functions to perform several security checks on each page load.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('ldap.inc') [line 34]
-ldap connection

include_once('config.inc') [line 32]
-configuration options

-

-

-
-
- -

checkClientIP [line 75]

-
-
-
- void checkClientIP( -) -
-

- - Checks if the client's IP address is on the list of allowed IPs.

The script is stopped if the host is not valid.




- -
[ Top ]


-
-
- -

checkIfPasswordChangeIsAllowed [line 202]

-
-
-
- boolean checkIfPasswordChangeIsAllowed( -) -
-

- - Checks if passwords may be changed.



-

Tags:

-
- - - - -
return:  true, if allowed
-
-

- -
[ Top ]


-
-
- -

checkIfWriteAccessIsAllowed [line 187]

-
-
-
- boolean checkIfWriteAccessIsAllowed( -) -
-

- - Checks if write access to LDAP is allowed.



-

Tags:

-
- - - - -
return:  true, if allowed
-
-

- -
[ Top ]


-
-
- -

logNewMessage [line 150]

-
-
-
- void logNewMessage( -string $level, string $message) -
-

- - Puts a new message in the log file.



- -

Parameters

- - - - - - - - - - - -
string  $level  log level (LOG_NOTICE, LOG_WARNING, LOG_ERR)
string  $message  log message
-
[ Top ]


-
-
- -

logoffAndBackToLoginPage [line 103]

-
-
-
- void logoffAndBackToLoginPage( -) -
-

- - Logs off the user and displays the login page.



- -
[ Top ]


-
-
- -

startSecureSession [line 43]

-
-
-
- void startSecureSession( -) -
-

- - Starts a session and checks the environment.

The script is stopped if one of the checks fail.




- -
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:55 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lib/_lib---status.inc.html b/lam-web/developers/devel/phpdoc/lib/_lib---status.inc.html deleted file mode 100644 index 43c98504..00000000 --- a/lam-web/developers/devel/phpdoc/lib/_lib---status.inc.html +++ /dev/null @@ -1,149 +0,0 @@ - - -Docs for page status.inc - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: status.inc

-Source Location: /lib/status.inc

- -
-
- - -

Page Details:

-LDAP Account Manager status messages.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-

-

-

-
-
- -

StatusMessage [line 50]

-
-
-
- void StatusMessage( -string $MessageTyp, string $MessageHeadline, [string $MessageText = ''], [array $MessageVariables = array()]) -
-

- - This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.

The headline and text may be formated with special tags:

{bold}, {endbold}: All text between these tags is printed bold.
{color=#123456}, {endcolor}: All text between these tags is printed in the given color.
{link=http://nodomain.org}, {endlink}: A link with the given target is created. The link text is the text between the tags.




- -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string  $MessageTyp  The type of the message to be printed. It must be one of the following types: 'INFO', 'WARN' or 'ERROR'.
Every other type will lead to an error message indicating an invalid message type.
string  $MessageHeadline  The headline of the status message.
It may be formatted with special color/link/bold tags.
string  $MessageText  The text of the status message.
It may be formatted with special color/link/bold tags. This parameter is optional.
array  $MessageVariables  The variables that are used to replace the spacers (%s) in the submitted text. This parameter is optional.
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lib/cache.html b/lam-web/developers/devel/phpdoc/lib/cache.html deleted file mode 100644 index 0625b161..00000000 --- a/lam-web/developers/devel/phpdoc/lib/cache.html +++ /dev/null @@ -1,459 +0,0 @@ - - -Docs For Class cache - - - - - - - - - - - - - -
lib
- - - [ class tree: lib ] - [ index: lib ] - [ all elements ] -
- - - - - - -
-
- -

Class: cache

-Source Location: /lib/cache.inc

- - - - - - - - - -
- -

Class Overview

-

-
This class contains all functions which are needed to manage the LDAP cache.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 42]
-This class contains all functions which are needed to manage the LDAP cache.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 56]

-
-
-
- cache __construct( -) -
-

- - Constructor.



-

Tags:

-
- - - - -
return:  cache object
-
-

- - -
[ Top ]
-
-
- -

method add_cache [line 66]

-
-
-
- void add_cache( -array -$attributes) -
-

- - This function adds attributes to the cache.



- - -

Parameters:

-
- - - - - - -
array  $attributes  syntax: is array( scope1 => array ( attributes ), scope2 => array ( attributes ), ...)
-

-
[ Top ]
-
-
- -

method findgroups [line 242]

-
-
-
- array findgroups( -) -
-

- - This function returns an array with all group names which were found in the LDAP directory.



-

Tags:

-
- - - - -
return:  group names
-
-

- - -
[ Top ]
-
-
- -

method getgid [line 223]

-
-
-
- string getgid( -string -$groupname) -
-

- - This function will return the GID number to an existing group name (using the cache).



-

Tags:

-
- - - - -
return:  GID number
-
-

- - -

Parameters:

-
- - - - - - -
string  $groupname  name of group
-

-
[ Top ]
-
-
- -

method getgrnam [line 260]

-
-
-
- group getgrnam( -string -$gidNumber) -
-

- - This function returns the group name to an existing gidNumber.



-

Tags:

-
- - - - -
return:  name
-
-

- - -

Parameters:

-
- - - - - - -
string  $gidNumber  GID number
-

-
[ Top ]
-
-
- -

method get_cache [line 95]

-
-
-
- array get_cache( -mixed -$attributes, string -$objectClass, mixed -$scopelist) -
-

- - Queries the cache for a list of LDAP entries and their attributes.



-

Tags:

-
- - - - -
return:  The found LDAP entries.
Format: array(dn1 => array(uidnumber1), dn2 => array(uidnumber2), ... ) if $attributes is of type string
or array(dn1 => array(uid => array(myuid), uidNumber => array(1234)), ... ) if $attributes is an array
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
mixed  $attributes  One (string) or many (array) attribute names.
string  $objectClass  The resulting entries need to contain this object class.
mixed  $scopelist  the account type(s) as string or array, all scopes if NULL given
-

-
[ Top ]
-
-
- -

method in_cache [line 140]

-
-
-
- void in_cache( -string -$value, string -$attribute, mixed -$scopelist) -
-

- - This function returns the DN if an LDAP entry with $attribute=$value is found.



- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
string  $value  is the searched value of the attribute $attribute
string  $attribute  name of the LDAP attribute
mixed  $scopelist  the account type(s) as string or array, all scopes if NULL given
-

-
[ Top ]
-
-
- -

method refresh_cache [line 175]

-
-
-
- void refresh_cache( -[boolean -$rebuild = false]) -
-

- - This function refreshes the cache.



- - -

Parameters:

-
- - - - - - -
boolean  $rebuild  forces a refresh if set to true
-

-
[ Top ]
-
-
- -

method __sleep [line 278]

-
-
-
- array __sleep( -) -
-

- - Encrypts LDAP cache before saving to session file.



-

Tags:

-
- - - - -
return:  list of variables to save
-
-

- - -
[ Top ]
-
-
- -

method __wakeup [line 287]

-
-
-
- void __wakeup( -) -
-

- - Decrypts LDAP cache after loading from session file.



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:20 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/_lib---lists.inc.html b/lam-web/developers/devel/phpdoc/lists/_lib---lists.inc.html deleted file mode 100644 index b51b32b7..00000000 --- a/lam-web/developers/devel/phpdoc/lists/_lib---lists.inc.html +++ /dev/null @@ -1,188 +0,0 @@ - - -Docs for page lists.inc - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: lists.inc

-Source Location: /lib/lists.inc

- -
-
- -
-

Classes:

-
lamList
-
Generates the list view.
-
lamListTool
-
Represents a tool which can be included in the account lists.
-
lamListOption
-
Represents a list configuration option.
-
lamBooleanListOption
-
Boolean option for list configuration.
-
lamSelectListOption
-
Boolean option for list configuration.
-


- -

Page Details:

-This file includes functions to manage the list views.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("types.inc") [line 33]
-Used to get type information.

include_once("pdfstruct.inc") [line 35]
-Used to get PDF information.

include_once("pdf.inc") [line 37]
-Used to create PDF files.

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/_templates---lists---deletelink.php.html b/lam-web/developers/devel/phpdoc/lists/_templates---lists---deletelink.php.html deleted file mode 100644 index fbee3ddc..00000000 --- a/lam-web/developers/devel/phpdoc/lists/_templates---lists---deletelink.php.html +++ /dev/null @@ -1,175 +0,0 @@ - - -Docs for page deletelink.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: deletelink.php

-Source Location: /templates/lists/deletelink.php

- -
-
- - -

Page Details:

-This page will redirect to delete.php if the given user is valid.

It is called from the list views via the delete links.




-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 34]
-security functions

include_once("../../lib/ldap.inc") [line 36]
-Needed to find DNs of users

include_once("../../lib/status.inc") [line 38]
-Used to display error messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:25 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/_templates---lists---list.php.html b/lam-web/developers/devel/phpdoc/lists/_templates---lists---list.php.html deleted file mode 100644 index 3cb1b02f..00000000 --- a/lam-web/developers/devel/phpdoc/lists/_templates---lists---list.php.html +++ /dev/null @@ -1,175 +0,0 @@ - - -Docs for page list.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: list.php

-Source Location: /templates/lists/list.php

- -
-
- - -

Page Details:

-This file shows the list views.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 33]
-security functions

include_once("../../lib/types.inc") [line 35]
-Used to get type information.

include_once("../../lib/config.inc") [line 37]
-Access to configuration options

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/_templates---lists---userlink.php.html b/lam-web/developers/devel/phpdoc/lists/_templates---lists---userlink.php.html deleted file mode 100644 index 7003851d..00000000 --- a/lam-web/developers/devel/phpdoc/lists/_templates---lists---userlink.php.html +++ /dev/null @@ -1,207 +0,0 @@ - - -Docs for page userlink.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: userlink.php

-Source Location: /templates/lists/userlink.php

- -
-
- - -

Page Details:

-This page will redirect to account/edit.php if the given user is valid.

It is called from listgroups.php via the memberUID links.




-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 34]
-security functions

include_once("../../lib/ldap.inc") [line 36]
-Needed to find DNs of users

include_once("../../lib/status.inc") [line 38]
-Used to display error messages

-

-

-
-
- -

search_username [line 77]

-
-
-
- string search_username( -string $name) -
-

- - Searches LDAP for a specific user name (uid attribute) and returns its DN entry



-

Tags:

-
- - - - -
return:  DN
-
-

- -

Parameters

- - - - - - -
string  $name  user name
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/lamBooleanListOption.html b/lam-web/developers/devel/phpdoc/lists/lamBooleanListOption.html deleted file mode 100644 index 66d6a090..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamBooleanListOption.html +++ /dev/null @@ -1,395 +0,0 @@ - - -Docs For Class lamBooleanListOption - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamBooleanListOption

-Source Location: /lib/lists.inc

- - - - - - - - - -
- -

Class Overview

-
lamListOption
-   |
-   --lamBooleanListOption

-
Boolean option for list configuration.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: lamListOption

-
-
- lamListOption::__construct() -
-
- Creates a new config option. -
-
- lamListOption::fillFromPostData() -
-
- Fills the config option from POST data. -
-
- lamListOption::getID() -
-
- Returns the option ID. -
-
- lamListOption::getMetaHTML() -
-
- Returns the meta HTML data to display this option. -
-
- lamListOption::getValue() -
-
- Returns the option value. The value must not contain "=" and ";". -
-
- lamListOption::setValue() -
-
- Sets the config option value. The value must not contain "=" and ";". -
-
-
-
-
- - -

Class Details

-
-[line 1066]
-Boolean option for list configuration.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 1077]

-
-
-
- lamBooleanListOption __construct( -String -$name, String -$ID) -
-

- - Creates a new boolean option.



-

Tags:

-
- - - - - - - -
return:  config option
access:  public
-
-

- - Overrides lamListOption::__construct() (Creates a new config option.)

-

Parameters:

-
- - - - - - - - - - - -
String  $name  name to show on config page
String  $ID  unique ID
-

-
[ Top ]
-
-
- -

method fillFromPostData [line 1096]

-
-
-
- array fillFromPostData( -) -
-

- - Fills the config option from POST data.



-

Tags:

-
- - - - - - - -
return:  list of StatusMessages (array(<type>, <head line>, <body>))
access:  public
-
-

- - Overrides lamListOption::fillFromPostData() (Fills the config option from POST data.)

-
[ Top ]
-
-
- -

method getMetaHTML [line 1110]

-
-
-
- array getMetaHTML( -) -
-

- - Returns the meta HTML data to display this option.



-

Tags:

-
- - - - - - - -
return:  meta HTML
access:  public
-
-

- - Overrides lamListOption::getMetaHTML() (Returns the meta HTML data to display this option.)

-
[ Top ]
-
-
- -

method isSelected [line 1087]

-
-
-
- boolean isSelected( -) -
-

- - Returns if this option is selected.



-

Tags:

-
- - - - - - - -
return:  true, if selected
access:  public
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamGroupList.html b/lam-web/developers/devel/phpdoc/lists/lamGroupList.html deleted file mode 100644 index c6dd6263..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamGroupList.html +++ /dev/null @@ -1,665 +0,0 @@ - - -Docs For Class lamGroupList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamGroupList

-Source Location: /lib/types/group.inc

- - - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamGroupList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Constants

- -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDoPost() -
-
- Manages all POST actions (e.g. button pressed) for the account lists. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- lamList::listPrintTableBody() -
-
- Prints the entry list -
-
- lamList::listPrintTableCellContent() -
-
- Prints the content of a cell in the account list for a given LDAP entry and attribute. -
-
- lamList::listPrintTableHeader() -
-
- Prints the attribute and filter row at the account table head -
-
- lamList::listRefreshData() -
-
- Rereads the entries from LDAP. -
-
- lamList::listShowOUSelection() -
-
- Prints a combobox with possible sub-DNs. -
-
- lamList::listSort() -
-
- Sorts an account list by a given attribute -
-
- lamList::showPage() -
-
- Prints the HTML code to display the list view. -
-
-
-
-
- - -

Class Details

-
-[line 100]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 117]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - -
return:  list object
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-
- -

method groupRefreshPrimary [line 222]

-
-
-
- void groupRefreshPrimary( -) -
-

- - Refreshes the primary group members list.



- - -
[ Top ]
-
-
- -

method listConfigurationChanged [line 268]

-
-
-
- void listConfigurationChanged( -) -
-

- - Called when the configuration options changed.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listConfigurationChanged() (Called when the configuration options changed.)

-
[ Top ]
-
-
- -

method listGetAllConfigOptions [line 259]

-
-
-
- array listGetAllConfigOptions( -) -
-

- - Returns a list of possible configuration options.



-

Tags:

-
- - - - - - - -
return:  list of lamListOption objects
access:  protected
-
-

- - Overrides lamList::listGetAllConfigOptions() (Returns a list of possible configuration options.)

-
[ Top ]
-
-
- -

method listGetParams [line 131]

-
-
-
- void listGetParams( -) -
-

- - Sets some internal parameters.



- - Overrides lamList::listGetParams() (Sets some internal parameters.)

-
[ Top ]
-
-
- -

method listPrintTableCellContent [line 145]

-
-
-
- void listPrintTableCellContent( - -&$entry, -&$attribute, array -$entry, string -$attribute) -
-

- - Prints the content of a cell in the account list for a given LDAP entry and attribute.



- - Overrides lamList::listPrintTableCellContent() (Prints the content of a cell in the account list for a given LDAP entry and attribute.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $entry  LDAP attributes
string  $attribute  attribute name
  &$entry  
  &$attribute  
-

-
[ Top ]
-
-
- -

method listRefreshData [line 212]

-
-
-
- void listRefreshData( -) -
-

- - Rereads the entries from LDAP.



- - Overrides lamList::listRefreshData() (Rereads the entries from LDAP.)

-
[ Top ]
-
-

- -
- -

Class Constants

-
- -

-

TRANS_PRIMARY_OPTION_NAME =  "LG_TP"

-

[line 109]

- ID for config option

-
-
[ Top ]

-

- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:31 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamHostList.html b/lam-web/developers/devel/phpdoc/lists/lamHostList.html deleted file mode 100644 index 9a95bc2a..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamHostList.html +++ /dev/null @@ -1,495 +0,0 @@ - - -Docs For Class lamHostList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamHostList

-Source Location: /lib/types/host.inc

- - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamHostList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDoPost() -
-
- Manages all POST actions (e.g. button pressed) for the account lists. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- lamList::listPrintTableBody() -
-
- Prints the entry list -
-
- lamList::listPrintTableCellContent() -
-
- Prints the content of a cell in the account list for a given LDAP entry and attribute. -
-
- lamList::listPrintTableHeader() -
-
- Prints the attribute and filter row at the account table head -
-
- lamList::listRefreshData() -
-
- Rereads the entries from LDAP. -
-
- lamList::listShowOUSelection() -
-
- Prints a combobox with possible sub-DNs. -
-
- lamList::listSort() -
-
- Sorts an account list by a given attribute -
-
- lamList::showPage() -
-
- Prints the HTML code to display the list view. -
-
-
-
-
- - -

Class Details

-
-[line 101]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 109]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - -
return:  list object
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamList.html b/lam-web/developers/devel/phpdoc/lists/lamList.html deleted file mode 100644 index 5d54d6f5..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamList.html +++ /dev/null @@ -1,1401 +0,0 @@ - - -Docs For Class lamList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamList

-Source Location: /lib/lists.inc

- - - - - - - - - - - -
- -

Class Overview

-

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Variables

- -
-

Constants

- -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
lamGroupList
-
Generates the list view.
-
-
-
lamHostList
-
Generates the list view.
-
-
-
lamMailAliasList
-
Generates the list view.
-
-
-
lamSmbDomainList
-
Generates the list view.
-
-
-
lamUserList
-
Generates the list view.
-
-
-
-
- - -

Class Details

-
-[line 47]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$attrArray = array()

-

[line 56]

- list of LDAP attributes



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$descArray = array()

-

[line 59]

- list of attribute descriptions



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$entries =

-

[line 77]

- LDAP entries



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$filterText =

-

[line 80]

- filter string to include in URL



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$labels =

-

[line 86]

- list of account specific labels



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$maxPageEntries =  30

-

[line 62]

- maximum count of entries per page



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$page =  1

-

[line 53]

- current page number



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$possibleSuffixes =

-

[line 83]

- list of possible LDAP suffixes(organizational units)



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$refresh =  true

-

[line 74]

- refresh page switch



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sortColumn =

-

[line 65]

- sort column name



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$sortDirection =  1

-

[line 68]

- sort direction: 1 for ascending, -1 for descending



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$suffix =

-

[line 71]

- LDAP suffix



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$type =

-

[line 50]

- Account type



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 100]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - - - - -
return:  list object
access:  public
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::__construct()
-
Constructor
-
-
-
lamHostList::__construct()
-
Constructor
-
-
-
lamMailAliasList::__construct()
-
Constructor
-
-
-
lamSmbDomainList::__construct()
-
Constructor
-
-
-
lamUserList::__construct()
-
Constructor
-
-

- -

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-
- -

method cmp_array [line 302]

-
-
-
- integer cmp_array( - -&$a, -&$b, array -$a, array -$b) -
-

- - Compare function used for usort-method

Rows are sorted with the first attribute entry of the sort column. If objects have attributes with multiple values only the first is used for sorting.




-

Tags:

-
- - - - - - - -
return:  0 if both are equal, 1 if $a is greater, -1 if $b is greater
access:  protected
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $a  first row which is compared
array  $b  second row which is compared
  &$a  
  &$b  
-

-
[ Top ]
-
-
- -

method getAdditionalTools [line 865]

-
-
-
- lamListTool[] getAdditionalTools( -) -
-

- - Returns a list of lamListTool objects to display next to the edit/delete buttons.



-

Tags:

-
- - - - - - - -
return:  tools
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamUserList::getAdditionalTools()
-
Returns a list of lamListTool objects to display next to the edit/delete buttons.
-
-

- -
[ Top ]
-
-
- -

method listBuildFilter [line 204]

-
-
-
- array listBuildFilter( -) -
-

- - Builds the regular expressions from the filter values.



-

Tags:

-
- - - - - - - -
return:  filter data array($attribute => array('regex' => $reg, 'original' => $orig)) $reg is the regular expression to use, $orig the user's unmodified input string
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listConfigurationChanged [line 924]

-
-
-
- void listConfigurationChanged( -) -
-

- - Called when the configuration options changed.



-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listConfigurationChanged()
-
Called when the configuration options changed.
-
-
-
lamUserList::listConfigurationChanged()
-
Called when the configuration options changed.
-
-

- -
[ Top ]
-
-
- -

method listDoPost [line 506]

-
-
-
- void listDoPost( -) -
-

- - Manages all POST actions (e.g. button pressed) for the account lists.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listDrawNavigationBar [line 321]

-
-
-
- void listDrawNavigationBar( -integer -$count) -
-

- - Draws a navigation bar to switch between pages



-

Tags:

-
- - - - -
access:  protected
-
-

- - -

Parameters:

-
- - - - - - -
integer  $count  number of account entries
-

-
[ Top ]
-
-
- -

method listFilterAccounts [line 248]

-
-
-
- array listFilterAccounts( -) -
-

- - Removes all entries which do not fit to the filter.



-

Tags:

-
- - - - - - - -
return:  filtered list of accounts
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listGetAllConfigOptions [line 874]

-
-
-
- array listGetAllConfigOptions( -) -
-

- - Returns a list of possible configuration options.



-

Tags:

-
- - - - - - - -
return:  list of lamListOption objects
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listGetAllConfigOptions()
-
Returns a list of possible configuration options.
-
-
-
lamUserList::listGetAllConfigOptions()
-
Returns a list of possible configuration options.
-
-

- -
[ Top ]
-
-
- -

method listGetConfigOptionByID [line 912]

-
-
-
- void listGetConfigOptionByID( -String -$ID) -
-

- - Returns the configuration option with the given ID.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -

Parameters:

-
- - - - - - -
String  $ID  ID
-

-
[ Top ]
-
-
- -

method listGetParams [line 791]

-
-
-
- void listGetParams( -) -
-

- - Sets some internal parameters.



-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listGetParams()
-
Sets some internal parameters.
-
-
-
lamUserList::listGetParams()
-
Sets some internal parameters.
-
-

- -
[ Top ]
-
-
- -

method listPrintButtons [line 707]

-
-
-
- void listPrintButtons( -boolean -$createOnly) -
-

- - Prints the create and delete buttons.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -

Parameters:

-
- - - - - - -
boolean  $createOnly  true if only the create button should be displayed
-

-
[ Top ]
-
-
- -

method listPrintConfigurationPage [line 882]

-
-
-
- void listPrintConfigurationPage( -) -
-

- - Prints the list configuration page.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listPrintFooter [line 746]

-
-
-
- void listPrintFooter( -) -
-

- - Prints the HTML footer.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listPrintHeader [line 734]

-
-
-
- void listPrintHeader( -) -
-

- - Prints the HTML header.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listPrintTableBody [line 412]

-
-
-
- void listPrintTableBody( - -&$info, array -$info) -
-

- - Prints the entry list



-

Tags:

-
- - - - -
access:  protected
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
array  $info  entries
  &$info  
-

-
[ Top ]
-
-
- -

method listPrintTableCellContent [line 487]

-
-
-
- void listPrintTableCellContent( - -&$entry, -&$attribute, array -$entry, string -$attribute) -
-

- - Prints the content of a cell in the account list for a given LDAP entry and attribute.



-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listPrintTableCellContent()
-
Prints the content of a cell in the account list for a given LDAP entry and attribute.
-
-
-
lamUserList::listPrintTableCellContent()
-
Prints the content of a cell in the account list for a given LDAP entry and attribute.
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $entry  LDAP attributes
string  $attribute  attribute name
  &$entry  
  &$attribute  
-

-
[ Top ]
-
-
- -

method listPrintTableHeader [line 360]

-
-
-
- void listPrintTableHeader( -) -
-

- - Prints the attribute and filter row at the account table head



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listRefreshData [line 830]

-
-
-
- void listRefreshData( -) -
-

- - Rereads the entries from LDAP.



-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
lamGroupList::listRefreshData()
-
Rereads the entries from LDAP.
-
-
-
lamUserList::listRefreshData()
-
Rereads the entries from LDAP.
-
-

- -
[ Top ]
-
-
- -

method listShowOUSelection [line 687]

-
-
-
- void listShowOUSelection( -) -
-

- - Prints a combobox with possible sub-DNs.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method listSort [line 283]

-
-
-
- array listSort( - -&$info, array -$info) -
-

- - Sorts an account list by a given attribute



-

Tags:

-
- - - - - - - -
return:  sorted account list
access:  protected
-
-

- - -

Parameters:

-
- - - - - - - - - - - -
array  $info  the account list
  &$info  
-

-
[ Top ]
-
-
- -

method showPage [line 142]

-
-
-
- void showPage( -) -
-

- - Prints the HTML code to display the list view.



-

Tags:

-
- - - - -
access:  public
-
-

- - -
[ Top ]
-
-

- -
- -

Class Constants

-
- -

-

LIST_SIZE_OPTION_NAME =  "L_SIZE"

-

[line 92]

- ID for list size config option

-
-
[ Top ]

-

- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamListOption.html b/lam-web/developers/devel/phpdoc/lists/lamListOption.html deleted file mode 100644 index bd02f932..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamListOption.html +++ /dev/null @@ -1,461 +0,0 @@ - - -Docs For Class lamListOption - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamListOption

-Source Location: /lib/lists.inc

- - - - - - - - - -
- -

Class Overview

-

-
Represents a list configuration option.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
lamBooleanListOption
-
Boolean option for list configuration.
-
-
-
lamSelectListOption
-
Boolean option for list configuration.
-
-
-
-
- - -

Class Details

-
-[line 998]
-Represents a list configuration option.



-

Tags:

-
- - - - - - - -
author:  Roland Gruber
abstract:  
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 1010]

-
-
-
- lamConfigOption __construct( -String -$ID) -
-

- - Creates a new config option.



-

Tags:

-
- - - - - - - -
return:  config option
access:  public
-
-

- -

Overridden in child classes as:
-

-
lamBooleanListOption::__construct()
-
Creates a new boolean option.
-
-
-
lamSelectListOption::__construct()
-
Creates a new selection list option.
-
-

- -

Parameters:

-
- - - - - - -
String  $ID  unique ID
-

-
[ Top ]
-
-
- -

method fillFromPostData [line 1028]

-
-
-
- array fillFromPostData( -) -
-

- - Fills the config option from POST data.



-

Tags:

-
- - - - - - - - - - -
return:  list of StatusMessages (array(<type>, <head line>, <body>))
abstract:  
access:  public
-
-

- -

Overridden in child classes as:
-

-
lamBooleanListOption::fillFromPostData()
-
Fills the config option from POST data.
-
-
-
lamSelectListOption::fillFromPostData()
-
Fills the config option from POST data.
-
-

- -
[ Top ]
-
-
- -

method getID [line 1019]

-
-
-
- String getID( -) -
-

- - Returns the option ID.



-

Tags:

-
- - - - - - - -
return:  ID
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getMetaHTML [line 1056]

-
-
-
- array getMetaHTML( -) -
-

- - Returns the meta HTML data to display this option.



-

Tags:

-
- - - - - - - - - - -
return:  meta HTML
abstract:  
access:  public
-
-

- -

Overridden in child classes as:
-

-
lamBooleanListOption::getMetaHTML()
-
Returns the meta HTML data to display this option.
-
-
-
lamSelectListOption::getMetaHTML()
-
Returns the meta HTML data to display this option.
-
-

- -
[ Top ]
-
-
- -

method getValue [line 1035]

-
-
-
- String getValue( -) -
-

- - Returns the option value. The value must not contain "=" and ";".



-

Tags:

-
- - - - - - - -
return:  value
access:  public
-
-

- - -
[ Top ]
-
-
- -

method setValue [line 1044]

-
-
-
- void setValue( -String -$value) -
-

- - Sets the config option value. The value must not contain "=" and ";".



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
String  $value  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:39 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamListTool.html b/lam-web/developers/devel/phpdoc/lists/lamListTool.html deleted file mode 100644 index 52d9f5d0..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamListTool.html +++ /dev/null @@ -1,355 +0,0 @@ - - -Docs For Class lamListTool - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamListTool

-Source Location: /lib/lists.inc

- - - - - - - - - -
- -

Class Overview

-

-
Represents a tool which can be included in the account lists.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 940]
-Represents a tool which can be included in the account lists.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 954]

-
-
-
- lamListTool __construct( -String -$name, String -$image, String -$target) -
-

- - Constructor



-

Tags:

-
- - - - - - - -
return:  tool object
access:  public
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
String  $name  tool name
String  $image  image file
String  $target  target page
-

-
[ Top ]
-
-
- -

method getImage [line 966]

-
-
-
- String getImage( -) -
-

- - Returns the name of the tool image.

The image is returned without path (e.g. mytool.png). All images must reside in the graphics folder.




-

Tags:

-
- - - - - - - -
return:  image name
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getLinkTarget [line 986]

-
-
-
- String getLinkTarget( -) -
-

- - Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.

The target page will be opened with two GET parameters: DN and type (e.g. user)




-

Tags:

-
- - - - - - - -
return:  page file (e.g. 'mytool.php')
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getName [line 976]

-
-
-
- String getName( -) -
-

- - Returns the tool name.

This is used for the tool tip.




-

Tags:

-
- - - - - - - -
return:  name
access:  public
-
-

- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamMailAliasList.html b/lam-web/developers/devel/phpdoc/lists/lamMailAliasList.html deleted file mode 100644 index 6f86df33..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamMailAliasList.html +++ /dev/null @@ -1,495 +0,0 @@ - - -Docs For Class lamMailAliasList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamMailAliasList

-Source Location: /lib/types/mailAlias.inc

- - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamMailAliasList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDoPost() -
-
- Manages all POST actions (e.g. button pressed) for the account lists. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- lamList::listPrintTableBody() -
-
- Prints the entry list -
-
- lamList::listPrintTableCellContent() -
-
- Prints the content of a cell in the account list for a given LDAP entry and attribute. -
-
- lamList::listPrintTableHeader() -
-
- Prints the attribute and filter row at the account table head -
-
- lamList::listRefreshData() -
-
- Rereads the entries from LDAP. -
-
- lamList::listShowOUSelection() -
-
- Prints a combobox with possible sub-DNs. -
-
- lamList::listSort() -
-
- Sorts an account list by a given attribute -
-
- lamList::showPage() -
-
- Prints the HTML code to display the list view. -
-
-
-
-
- - -

Class Details

-
-[line 97]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 105]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - -
return:  list object
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamSelectListOption.html b/lam-web/developers/devel/phpdoc/lists/lamSelectListOption.html deleted file mode 100644 index 8b7feac0..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamSelectListOption.html +++ /dev/null @@ -1,409 +0,0 @@ - - -Docs For Class lamSelectListOption - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamSelectListOption

-Source Location: /lib/lists.inc

- - - - - - - - - -
- -

Class Overview

-
lamListOption
-   |
-   --lamSelectListOption

-
Boolean option for list configuration.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: lamListOption

-
-
- lamListOption::__construct() -
-
- Creates a new config option. -
-
- lamListOption::fillFromPostData() -
-
- Fills the config option from POST data. -
-
- lamListOption::getID() -
-
- Returns the option ID. -
-
- lamListOption::getMetaHTML() -
-
- Returns the meta HTML data to display this option. -
-
- lamListOption::getValue() -
-
- Returns the option value. The value must not contain "=" and ";". -
-
- lamListOption::setValue() -
-
- Sets the config option value. The value must not contain "=" and ";". -
-
-
-
-
- - -

Class Details

-
-[line 1127]
-Boolean option for list configuration.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 1141]

-
-
-
- lamBooleanListOption __construct( -String -$name, array -$options, String -$ID) -
-

- - Creates a new selection list option.



-

Tags:

-
- - - - - - - -
return:  config option
access:  public
-
-

- - Overrides lamListOption::__construct() (Creates a new config option.)

-

Parameters:

-
- - - - - - - - - - - - - - - - -
String  $name  name to show on config page
array  $options  list of possible values
String  $ID  unique ID
-

-
[ Top ]
-
-
- -

method fillFromPostData [line 1161]

-
-
-
- array fillFromPostData( -) -
-

- - Fills the config option from POST data.



-

Tags:

-
- - - - - - - -
return:  list of StatusMessages (array(<type>, <head line>, <body>))
access:  public
-
-

- - Overrides lamListOption::fillFromPostData() (Fills the config option from POST data.)

-
[ Top ]
-
-
- -

method getMetaHTML [line 1175]

-
-
-
- array getMetaHTML( -) -
-

- - Returns the meta HTML data to display this option.



-

Tags:

-
- - - - - - - -
return:  meta HTML
access:  public
-
-

- - Overrides lamListOption::getMetaHTML() (Returns the meta HTML data to display this option.)

-
[ Top ]
-
-
- -

method setHelpID [line 1152]

-
-
-
- void setHelpID( -Strign -$id) -
-

- - Sets the help ID.



-

Tags:

-
- - - - -
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
Strign  $id  help ID
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamSmbDomainList.html b/lam-web/developers/devel/phpdoc/lists/lamSmbDomainList.html deleted file mode 100644 index 3b566a9a..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamSmbDomainList.html +++ /dev/null @@ -1,495 +0,0 @@ - - -Docs For Class lamSmbDomainList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamSmbDomainList

-Source Location: /lib/types/smbDomain.inc

- - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamSmbDomainList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDoPost() -
-
- Manages all POST actions (e.g. button pressed) for the account lists. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- lamList::listPrintTableBody() -
-
- Prints the entry list -
-
- lamList::listPrintTableCellContent() -
-
- Prints the content of a cell in the account list for a given LDAP entry and attribute. -
-
- lamList::listPrintTableHeader() -
-
- Prints the attribute and filter row at the account table head -
-
- lamList::listRefreshData() -
-
- Rereads the entries from LDAP. -
-
- lamList::listShowOUSelection() -
-
- Prints a combobox with possible sub-DNs. -
-
- lamList::listSort() -
-
- Sorts an account list by a given attribute -
-
- lamList::showPage() -
-
- Prints the HTML code to display the list view. -
-
-
-
-
- - -

Class Details

-
-[line 97]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 105]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - -
return:  list object
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/lamUserList.html b/lam-web/developers/devel/phpdoc/lists/lamUserList.html deleted file mode 100644 index 698768af..00000000 --- a/lam-web/developers/devel/phpdoc/lists/lamUserList.html +++ /dev/null @@ -1,733 +0,0 @@ - - -Docs For Class lamUserList - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Class: lamUserList

-Source Location: /lib/types/user.inc

- - - - - - - - - - -
- -

Class Overview

-
lamList
-   |
-   --lamUserList

-
Generates the list view.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Constants

- -
-

Methods

- -
-
- - - - - - - - - - - -
-

Inherited Constants

-
-

Class: lamList

-
-
- lamList::LIST_SIZE_OPTION_NAME -
-
- -
-
-
-
-

Inherited Variables

-
-

Class: lamList

-
-
- lamList::$attrArray -
-
- -
-
- lamList::$descArray -
-
- -
-
- lamList::$entries -
-
- -
-
- lamList::$filterText -
-
- -
-
- lamList::$labels -
-
- -
-
- lamList::$maxPageEntries -
-
- -
-
- lamList::$page -
-
- -
-
- lamList::$possibleSuffixes -
-
- -
-
- lamList::$refresh -
-
- -
-
- lamList::$sortColumn -
-
- -
-
- lamList::$sortDirection -
-
- -
-
- lamList::$suffix -
-
- -
-
- lamList::$type -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: lamList

-
-
- lamList::__construct() -
-
- Constructor -
-
- lamList::cmp_array() -
-
- Compare function used for usort-method -
-
- lamList::getAdditionalTools() -
-
- Returns a list of lamListTool objects to display next to the edit/delete buttons. -
-
- lamList::listBuildFilter() -
-
- Builds the regular expressions from the filter values. -
-
- lamList::listConfigurationChanged() -
-
- Called when the configuration options changed. -
-
- lamList::listDoPost() -
-
- Manages all POST actions (e.g. button pressed) for the account lists. -
-
- lamList::listDrawNavigationBar() -
-
- Draws a navigation bar to switch between pages -
-
- lamList::listFilterAccounts() -
-
- Removes all entries which do not fit to the filter. -
-
- lamList::listGetAllConfigOptions() -
-
- Returns a list of possible configuration options. -
-
- lamList::listGetConfigOptionByID() -
-
- Returns the configuration option with the given ID. -
-
- lamList::listGetParams() -
-
- Sets some internal parameters. -
-
- lamList::listPrintButtons() -
-
- Prints the create and delete buttons. -
-
- lamList::listPrintConfigurationPage() -
-
- Prints the list configuration page. -
-
- lamList::listPrintFooter() -
-
- Prints the HTML footer. -
-
- lamList::listPrintHeader() -
-
- Prints the HTML header. -
-
- lamList::listPrintTableBody() -
-
- Prints the entry list -
-
- lamList::listPrintTableCellContent() -
-
- Prints the content of a cell in the account list for a given LDAP entry and attribute. -
-
- lamList::listPrintTableHeader() -
-
- Prints the attribute and filter row at the account table head -
-
- lamList::listRefreshData() -
-
- Rereads the entries from LDAP. -
-
- lamList::listShowOUSelection() -
-
- Prints a combobox with possible sub-DNs. -
-
- lamList::listSort() -
-
- Sorts an account list by a given attribute -
-
- lamList::showPage() -
-
- Prints the HTML code to display the list view. -
-
-
-
-
- - -

Class Details

-
-[line 106]
-Generates the list view.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 123]

-
-
-
- lamList __construct( -string -$type) -
-

- - Constructor



-

Tags:

-
- - - - - - - -
return:  list object
access:  public
-
-

- - Overrides lamList::__construct() (Constructor)

-

Parameters:

-
- - - - - - -
string  $type  account type
-

-
[ Top ]
-
-
- -

method getAdditionalTools [line 234]

-
-
-
- lamListTool[] getAdditionalTools( -) -
-

- - Returns a list of lamListTool objects to display next to the edit/delete buttons.



-

Tags:

-
- - - - - - - -
return:  tools
access:  protected
-
-

- - Overrides lamList::getAdditionalTools() (Returns a list of lamListTool objects to display next to the edit/delete buttons.)

-
[ Top ]
-
-
- -

method listConfigurationChanged [line 256]

-
-
-
- void listConfigurationChanged( -) -
-

- - Called when the configuration options changed.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listConfigurationChanged() (Called when the configuration options changed.)

-
[ Top ]
-
-
- -

method listGetAllConfigOptions [line 247]

-
-
-
- array listGetAllConfigOptions( -) -
-

- - Returns a list of possible configuration options.



-

Tags:

-
- - - - - - - -
return:  list of lamListOption objects
access:  protected
-
-

- - Overrides lamList::listGetAllConfigOptions() (Returns a list of possible configuration options.)

-
[ Top ]
-
-
- -

method listGetParams [line 137]

-
-
-
- void listGetParams( -) -
-

- - Sets some internal parameters.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listGetParams() (Sets some internal parameters.)

-
[ Top ]
-
-
- -

method listPrintTableCellContent [line 179]

-
-
-
- void listPrintTableCellContent( - -&$entry, -&$attribute, array -$entry, string -$attribute) -
-

- - Prints the content of a cell in the account list for a given LDAP entry and attribute.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listPrintTableCellContent() (Prints the content of a cell in the account list for a given LDAP entry and attribute.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $entry  LDAP attributes
string  $attribute  attribute name
  &$entry  
  &$attribute  
-

-
[ Top ]
-
-
- -

method listRefreshData [line 148]

-
-
-
- void listRefreshData( -) -
-

- - Rereads the entries from LDAP.



-

Tags:

-
- - - - -
access:  protected
-
-

- - Overrides lamList::listRefreshData() (Rereads the entries from LDAP.)

-
[ Top ]
-
-
- -

method refreshPrimaryGroupTranslation [line 158]

-
-
-
- void refreshPrimaryGroupTranslation( -) -
-

- - Refreshes the GID to group name cache.



-

Tags:

-
- - - - -
access:  protected
-
-

- - -
[ Top ]
-
-

- -
- -

Class Constants

-
- -

-

TRANS_PRIMARY_OPTION_NAME =  "LU_TP"

-

[line 115]

- ID for config option

-
-
[ Top ]

-

- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_lib---tree.inc.html b/lam-web/developers/devel/phpdoc/lists/tree/_lib---tree.inc.html deleted file mode 100644 index df65ef30..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_lib---tree.inc.html +++ /dev/null @@ -1,1198 +0,0 @@ - - -Docs for page tree.inc - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: tree.inc

-Source Location: /lib/tree.inc

- -
-
- - -

Page Details:

-This function displays the LDAP tree for all the servers that you have

in config.php. We read the session variable 'tree' to know which dns are expanded or collapsed. No query string parameters are expected, however, you can use a '#' offset to scroll to a given dn. The syntax is tree.php#<rawurlencoded dn>, so if I wanted to scroll to dc=example,dc=com for server 3, the URL would be: tree.php#3_dc%3Dexample%2Cdc%3Dcom




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

-

-
-
- -

arrayLower [line 940]

-
-
-
- void arrayLower( - $array) -
-

- -

- -

Parameters

- - - - - - -
  $array  
-
[ Top ]


-
-
- -

array_stripslashes [line 61]

-
-
-
- void array_stripslashes( - &$array, Array $array) -
-

- - Strips all slashes from the specified array in place (pass by ref).



- -

Parameters

- - - - - - - - - - - -
Array  $array  The array to strip slashes from, typically one of $_GET, $_POST, or $_COOKIE.
  &$array  
-
[ Top ]


-
-
- -

build_initial_tree_icons [line 209]

-
-
-
- void build_initial_tree_icons( -) -
-

- - Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned

array is then stored in the current session. The structure of the returned array is simple, and looks like this:

  1.    Array
  2. -
  3.     (
  4. -
  5.       [0=> Array
  6. -
  7.           (
  8. -
  9.              [dc=example,dc=com=> "dcobject.png"
  10. -
  11.           )
  12. -
  13.       [1=> Array
  14. -
  15.             [o=Corporation=> "o.png"
  16. -
  17.           )
  18. -
  19.      )
  20. -
This function is not meant as a user-callable function, but rather a convenient, automated method for setting up the initial data structure for the tree viewer's icon cache.




- -
[ Top ]


-
-
- -

dn_exists [line 228]

-
-
-
- bool dn_exists( -string $dn) -
-

- - Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.



- -

Parameters

- - - - - - -
string  $dn  The DN of the entry of interest.
-
[ Top ]


-
-
- -

draw_formatted_dn [line 676]

-
-
-
- void draw_formatted_dn( - $dn) -
-

- - Gets a DN string using the user-configured tree_display_format string to format it.



- -

Parameters

- - - - - - -
  $dn  
-
[ Top ]


-
-
- -

draw_jpeg_photos [line 1151]

-
-
-
- void draw_jpeg_photos( -string $dn, [string $attr_name = 'jpegPhoto'], [bool $draw_delete_buttons = false], [bool $draw_bytes_and_size = true], [string $table_html_attrs = 'align=&quot;left&quot;'], [ $img_html_attrs = '']) -
-

- - Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.

Usage Examples:

  1.     draw_jpeg_photos0"cn=Bob,ou=People,dc=example,dc=com""jpegPhoto" truefalse"border: 1px; width: 150px" );
  2. -
  3.     draw_jpeg_photos1"cn=Fred,ou=People,dc=example,dc=com" );
  4. -




- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string  $dn  The DN of the entry that contains the jpeg attribute you want to draw.
string  $attr_name  The name of the attribute containing the jpeg data (usually 'jpegPhoto').
bool  $draw_delete_buttons  If true, draws a button beneath the image titled 'Delete' allowing the user to delete the jpeg attribute by calling JavaScript function deleteAttribute() provided in the default modification template.
bool  $draw_bytes_and_size  If true, draw text below the image indicating the byte size and dimensions.
string  $table_html_attrs  Specifies optional CSS style attributes for the table tag.
  $img_html_attrs  
-
[ Top ]


-
-
- -

draw_server_tree [line 73]

-
-
-
- void draw_server_tree( -) -
-

- - Prints the HTML of the tree view.



- -
[ Top ]


-
-
- -

get_container [line 1329]

-
-
-
- string get_container( -string $dn) -
-

- - Given a DN string, this returns the parent container portion of the string.

For example. given 'cn=Manager,dc=example,dc=com', this function returns 'dc=example,dc=com'.




-

Tags:

-
- - - - - - - -
return:  The container
see:  get_rdn()
-
-

- -

Parameters

- - - - - - -
string  $dn  The DN whose container string to return.
-
[ Top ]


-
-
- -

get_container_contents [line 274]

-
-
-
- array get_container_contents( -string $dn, [int $size_limit = 0], [string $filter = '(objectClass=*)']) -
-

- - Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of child entries one level beneath the parent. For example, for the following tree:

  1.  dc=example,dc=com
  2. -
  3.    ou=People
  4. -
  5.       cn=Dave
  6. -
  7.       cn=Fred
  8. -
  9.       cn=Joe
  10. -
  11.       ou=More People
  12. -
  13.          cn=Mark
  14. -
  15.          cn=Bob
  16. -

Calling

  1. get_container_contents"ou=people,dc=example,dc=com" )
  2. -
would return the following list:

  1.   cn=Dave
  2. -
  3.   cn=Fred
  4. -
  5.   cn=Joe
  6. -
  7.   ou=More People
  8. -




-

Tags:

-
- - - - -
return:  An array of DN strings listing the immediate children of the specified entry.
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $dn  The DN of the entry whose children to return.
int  $size_limit  (optional) The maximum number of entries to return. If unspecified, no limit is applied to the number of entries in the returned.
string  $filter  (optional) An LDAP filter to apply when fetching children, example: "(objectClass=inetOrgPerson)"
-
[ Top ]


-
-
- -

get_enc_type [line 1121]

-
-
-
- void get_enc_type( - $user_password) -
-

- -

- -

Parameters

- - - - - - -
  $user_password  
-
[ Top ]


-
-
- -

get_entry_system_attrs [line 912]

-
-
-
- array get_entry_system_attrs( -string $dn, [int $deref = LDAP_DEREF_NEVER]) -
-

- - Gets the operational attributes for an entry. Given a DN, this function fetches that entry's

operational (ie, system or internal) attributes. These attributes include "createTimeStamp", "creatorsName", and any other attribute that the LDAP server sets automatically. The returned associative array is of this form:

  1.   Array
  2. -
  3.   (
  4. -
  5.     [creatorsName=> Array
  6. -
  7.         (
  8. -
  9.            [0=> "cn=Admin,dc=example,dc=com"
  10. -
  11.         )
  12. -
  13.     [createTimeStamp]=> Array
  14. -
  15.         (
  16. -
  17.            [0=> "10401040130"
  18. -
  19.         )
  20. -
  21.     [hasSubordinates=> Array
  22. -
  23.         (
  24. -
  25.            [0=> "FALSE"
  26. -
  27.         )
  28. -
  29.   )
  30. -




-

Tags:

-
- - - - -
return:  An associative array whose keys are attribute names and whose values are arrays of values for the aforementioned attribute.
-
-

- -

Parameters

- - - - - - - - - - - -
string  $dn  The DN of the entry whose interal attributes are desired.
int  $deref  For aliases and referrals, this parameter specifies whether to follow references to the referenced DN or to fetch the attributes for the referencing DN. See http://php.net/ldap_search for the 4 valid options.
-
[ Top ]


-
-
- -

get_icon [line 311]

-
-
-
- string get_icon( -string $dn) -
-

- - Given a DN and server ID, this function reads the DN's objectClasses and

determines which icon best represents the entry. The results of this query are cached in a session variable so it is not run every time the tree browser changes, just when exposing new DNs that were not displayed previously. That means we can afford a little bit of inefficiency here in favor of coolness. :)

This function returns a string like "country.png". All icon files are assumed to be contained in the /../../graphics/ directory of phpLDAPadmin.

Developers are encouraged to add new icons to the images directory and modify this function as needed to suit their types of LDAP entries. If the modifications are general to an LDAP audience, the phpLDAPadmin team will gladly accept them as a patch.




- -

Parameters

- - - - - - -
string  $dn  The DN of the entry whose icon you wish to fetch.
-
[ Top ]


-
-
- -

get_object_attr [line 455]

-
-
-
- void get_object_attr( -string $dn, string $attr, bool $lower_case_attr_names) -
-

- - Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:

  1.  print_rget_object_attr0"cn=Bob,ou=people,dc=example,dc=com""sn" ) );
  2. -
  3.  // prints:
  4. -
  5.  //  Array
  6. -
  7.  //    (
  8. -
  9.  //       [0] => "Smith"
  10. -
  11.  //    )
  12. -
  13.  
  14. -
  15.  print_rget_object_attr0"cn=Bob,ou=people,dc=example,dc=com""objectClass" ) );
  16. -
  17.  // prints:
  18. -
  19.  //  Array
  20. -
  21.  //    (
  22. -
  23.  //       [0] => "top"
  24. -
  25.  //       [1] => "person"
  26. -
  27.  //    )
  28. -




-

Tags:

-
- - - - -
see:  get_object_attrs()
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $dn  The distinguished name (DN) of the entry whose attributes/values to fetch.
string  $attr  The attribute whose value(s) to return (ie, "objectClass", "cn", "userPassword")
bool  $lower_case_attr_names  (optional) If true, all keys of the returned associative array will be lower case. Otherwise, they will be cased as the LDAP server returns them.
-
[ Top ]


-
-
- -

get_object_attrs [line 750]

-
-
-
- array get_object_attrs( -string $dn, [bool $lower_case_attr_names = false], [int $deref = LDAP_DEREF_NEVER]) -
-

- - Gets the attributes/values of an entry. Returns an associative array whose

keys are attribute value names and whose values are arrays of values for said attribute. Optionally, callers may specify true for the parameter $lower_case_attr_names to force all keys in the associate array (attribute names) to be lower case.

Sample return value of

  1. get_object_attrs0"cn=Bob,ou=pepole,dc=example,dc=com" )
  2. -

  1.  Array
  2. -
  3.   (
  4. -
  5.    [objectClass=> Array
  6. -
  7.        (
  8. -
  9.            [0=> person
  10. -
  11.            [1=> top
  12. -
  13.        )
  14. -
  15.    [cn=> Array
  16. -
  17.        (
  18. -
  19.            [0=> Bob
  20. -
  21.        )
  22. -
  23.    [sn=> Array
  24. -
  25.        (
  26. -
  27.            [0=> Jones
  28. -
  29.        )
  30. -
  31.    [dn=> Array
  32. -
  33.        (
  34. -
  35.             [0=> cn=Bob,ou=pepole,dc=example,dc=com
  36. -
  37.        )
  38. -
  39.   )
  40. -




-

Tags:

-
- - - - - - - -
see:  get_object_attr()
see:  get_entry_system_attrs()
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $dn  The distinguished name (DN) of the entry whose attributes/values to fetch.
bool  $lower_case_attr_names  (optional) If true, all keys of the returned associative array will be lower case. Otherwise, they will be cased as the LDAP server returns them.
int  $deref  For aliases and referrals, this parameter specifies whether to follow references to the referenced DN or to fetch the attributes for the referencing DN. See http://php.net/ldap_search for the 4 valid options.
-
[ Top ]


-
-
- -

get_rdn [line 489]

-
-
-
- string get_rdn( -string $dn, [bool $include_attrs = 0]) -
-

- - Given a DN string, this returns the 'RDN' portion of the string.

For example. given 'cn=Manager,dc=example,dc=com', this function returns 'cn=Manager' (it is really the exact opposite of get_container()).




-

Tags:

-
- - - - - - - -
return:  The RDN
see:  get_container()
-
-

- -

Parameters

- - - - - - - - - - - -
string  $dn  The DN whose RDN to return.
bool  $include_attrs  If true, include attributes in the RDN string. See http://php.net/ldap_explode_dn for details
-
[ Top ]


-
-
- -

initialize_session_tree [line 172]

-
-
-
- void initialize_session_tree( -) -
-

- - Checks and fixes an initial session's tree cache if needed.

This function is not meant as a user-callable function, but rather a convenient, automated method for checking the initial data structure of the session.




- -
[ Top ]


-
-
- -

is_attr_binary [line 802]

-
-
-
- bool is_attr_binary( -string $attr_name) -
-

- - Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.



-

Tags:

-
- - - - -
see:  is_jpeg_photo()
-
-

- -

Parameters

- - - - - - -
string  $attr_name  The name of the attribute to test.
-
[ Top ]


-
-
- -

is_attr_boolean [line 988]

-
-
-
- bool is_attr_boolean( -string $attr_name) -
-

- - Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.



- -

Parameters

- - - - - - -
string  $attr_name  The name of the attribute to test.
-
[ Top ]


-
-
- -

is_dn_attr [line 1095]

-
-
-
- bool is_dn_attr( -string $attr_name) -
-

- - Returns true if the attribute specified is required to take as input a DN.

Some examples include 'distinguishedName', 'member' and 'uniqueMember'.




- -

Parameters

- - - - - - -
string  $attr_name  The name of the attribute of interest (case insensitive)
-
[ Top ]


-
-
- -

is_jpeg_photo [line 956]

-
-
-
- bool is_jpeg_photo( -string $attr_name) -
-

- - Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.



-

Tags:

-
- - - - -
see:  draw_jpeg_photos()
-
-

- -

Parameters

- - - - - - -
string  $attr_name  The name of the attribute to test.
-
[ Top ]


-
-
- -

is_mail_string [line 1008]

-
-
-
- bool is_mail_string( -string $str) -
-

- - Get whether a string looks like an email address (user@example.com).



-

Tags:

-
- - - - -
return:  Returns true if the specified string looks like an email address or false otherwise.
-
-

- -

Parameters

- - - - - - -
string  $str  The string to analyze.
-
[ Top ]


-
-
- -

is_multi_line_attr [line 1056]

-
-
-
- bool is_multi_line_attr( -string $attr_name, [string $val = null]) -
-

- - Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;

Usage example:

  1.   ifis_muli_line_attr"postalAddress" ) )
  2. -
  3.       echo "<textarea name=\"postalAddress\"></textarea>";
  4. -
  5.   else
  6. -
  7.       echo "<input name=\"postalAddress\" type=\"text\">";
  8. -




- -

Parameters

- - - - - - - - - - - -
string  $attr_name  The name of the attribute of interestd (case insensivite)
string  $val  (optional) The current value of the attribute (speeds up the process by searching for carriage returns already in the attribute value)
-
[ Top ]


-
-
- -

is_url_string [line 1024]

-
-
-
- bool is_url_string( -string $str) -
-

- - Get whether a string looks like a web URL (http://www.example.com/)



-

Tags:

-
- - - - -
return:  Returns true if the specified string looks like a web URL or false otherwise.
-
-

- -

Parameters

- - - - - - -
string  $str  The string to analyze.
-
[ Top ]


-
-
- -

pla_compare_dns [line 591]

-
-
-
- int pla_compare_dns( -string $dn1, string $dn2) -
-

- - Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.

Returns > 0 if dn1 is greater than dn2.

The comparison is performed starting with the top-most element of the DN. Thus, the following list:

  1.        ou=people,dc=example,dc=com
  2. -
  3.        cn=Admin,ou=People,dc=example,dc=com
  4. -
  5.        cn=Joe,ou=people,dc=example,dc=com
  6. -
  7.        dc=example,dc=com
  8. -
  9.        cn=Fred,ou=people,dc=example,dc=org
  10. -
  11.        cn=Dave,ou=people,dc=example,dc=org
  12. -
Will be sorted thus using usort( $list, "pla_compare_dns" ):
  1.        dc=com
  2. -
  3.        dc=example,dc=com
  4. -
  5.        ou=people,dc=example,dc=com
  6. -
  7.        cn=Admin,ou=People,dc=example,dc=com
  8. -
  9.        cn=Joe,ou=people,dc=example,dc=com
  10. -
  11.        cn=Dave,ou=people,dc=example,dc=org
  12. -
  13.        cn=Fred,ou=people,dc=example,dc=org
  14. -




- -

Parameters

- - - - - - - - - - - -
string  $dn1  The first of two DNs to compare
string  $dn2  The second of two DNs to compare
-
[ Top ]


-
-
- -

pla_explode_dn [line 521]

-
-
-
- array pla_explode_dn( -string $dn, [ $with_attributes = 0], int $with_attriutes) -
-

- - Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.



-

Tags:

-
- - - - -
return:  An array of RDN parts of this format:
  1.    Array
  2. -
  3.     (
  4. -
  5.        [0=> uid=ppratt
  6. -
  7.        [1=> ou=People
  8. -
  9.        [2=> dc=example
  10. -
  11.        [3=> dc=com
  12. -
  13.     )
  14. -
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $dn  The DN to explode.
int  $with_attriutes  (optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)
  $with_attributes  
-
[ Top ]


-
-
- -

pla_ldap_search [line 1255]

-
-
-
- void pla_ldap_search( -string $filter, [string $base_dn = null], [array $attrs = array()], [string $scope = 'sub'], [bool $sort_results = true], [int $deref = LDAP_DEREF_ALWAYS]) -
-

- - A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.

Example usage:

  1.  $samba_users ldap_search0"(&(objectClass=sambaAccount)(objectClass=posixAccount))",
  2. -
  3.                               "ou=People,dc=example,dc=com"array"uid""homeDirectory" ) );
  4. -
  5.  print_r$samba_users );
  6. -
  7.  // prints (for example):
  8. -
  9.  //  Array
  10. -
  11.  //    (
  12. -
  13.  //       [uid=jsmith,ou=People,dc=example,dc=com] => Array
  14. -
  15.  //           (
  16. -
  17.  //               [dn] => "uid=jsmith,ou=People,dc=example,dc=com"
  18. -
  19.  //               [uid] => "jsmith"
  20. -
  21.  //               [homeDirectory] => "\\server\jsmith"
  22. -
  23.  //           )
  24. -
  25.  //       [uid=byoung,ou=People,dc=example,dc=com] => Array
  26. -
  27.  //           (
  28. -
  29.  //               [dn] => "uid=byoung,ou=Samba,ou=People,dc=example,dc=com"
  30. -
  31.  //               [uid] => "byoung"
  32. -
  33.  //               [homeDirectory] => "\\server\byoung"
  34. -
  35.  //           )
  36. -
  37.  //    )
  38. -

WARNING: This function will use a lot of memory on large searches since the entire result set is stored in a single array. For large searches, you should consider sing the less memory intensive PHP LDAP API directly (ldap_search(), ldap_next_entry(), ldap_next_attribute(), etc).




- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string  $filter  The LDAP filter to use when searching (example: "(objectClass=*)") (see RFC 2254)
string  $base_dn  The DN of the base of search.
array  $attrs  An array of attributes to include in the search result (example: array( "objectClass", "uid", "sn" )).
string  $scope  The LDAP search scope. Must be one of "base", "one", or "sub". Standard LDAP search scope.
bool  $sort_results  Specify false to not sort results by DN or true to have the returned array sorted by DN (uses ksort)
int  $deref  When handling aliases or referrals, this specifies whether to follow referrals. Must be one of LDAP_DEREF_ALWAYS, LDAP_DEREF_NEVER, LDAP_DEREF_SEARCHING, or LDAP_DEREF_FINDING. See the PHP LDAP API for details.
-
[ Top ]


-
-
- -

pla_reverse_dn [line 657]

-
-
-
- string pla_reverse_dn( -string $dn) -
-

- - Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last

For example:

  1.    cn=Brigham,ou=People,dc=example,dc=com
  2. -
Becomes:
  1.    dc=com,dc=example,ou=People,cn=Brigham
  2. -
This makes it possible to sort lists of DNs such that they are grouped by container.




-

Tags:

-
- - - - - - - -
return:  The reversed DN
see:  pla_compare_dns()
-
-

- -

Parameters

- - - - - - -
string  $dn  The DN to reverse
-
[ Top ]


-
-
- -

pretty_print_dn [line 546]

-
-
-
- string pretty_print_dn( -string $dn) -
-

- - Returns an HTML-beautified version of a DN.

Internally, this function makes use of pla_explode_dn() to break the the DN into its components. It then glues them back together with "pretty" HTML. The returned HTML is NOT to be used as a real DN, but simply displayed.




- -

Parameters

- - - - - - -
string  $dn  The DN to pretty-print.
-
[ Top ]


-
-
- -

real_attr_name [line 875]

-
-
-
- string real_attr_name( -string $attr_name) -
-

- - Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.



- -

Parameters

- - - - - - -
string  $attr_name  The name of the attribute to examine.
-
[ Top ]


-
-
- -

sortAttrs [line 1034]

-
-
-
- void sortAttrs( - $a, $b) -
-

- -

- -

Parameters

- - - - - - - - - - - -
  $a  
  $b  
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:58 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_attr.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_attr.php.html deleted file mode 100644 index 1de9df19..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_attr.php.html +++ /dev/null @@ -1,204 +0,0 @@ - - -Docs for page add_attr.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: add_attr.php

-Source Location: /templates/tree/add_attr.php

- -
-
- - -

Page Details:

-Adds an attribute/value pair to an object

Variables that come in as POST vars:

  • dn
  • attr
  • val
  • binary




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/tree.inc') [line 49]
-tree functions

include_once('../../lib/config.inc') [line 51]
-access to configuration

include_once('../../lib/ldap.inc') [line 53]
-LDAP functions

include_once('../../lib/account.inc') [line 57]
-common functions

include_once('../../lib/security.inc') [line 47]
-security functions

include_once('../../lib/status.inc') [line 55]
-status messages

-

-

-
-
- -

is_binary_option_required [line 140]

-
-
-
- void is_binary_option_required( - $attr) -
-

- -

- -

Parameters

- - - - - - -
  $attr  
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:17 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html deleted file mode 100644 index 36370c91..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_attr_form.php.html +++ /dev/null @@ -1,203 +0,0 @@ - - -Docs for page add_attr_form.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: add_attr_form.php

-Source Location: /templates/tree/add_attr_form.php

- -
-
- - -

Page Details:

-Displays a form for adding an attribute/value to an LDAP entry.

Variables that come in as GET vars:

  • dn (rawurlencoded)




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/tree.inc') [line 46]
-tree functions

include_once('../../lib/security.inc') [line 44]
-security functions

include_once('../../lib/config.inc') [line 48]
-access to configuration

include_once('../../lib/ldap.inc') [line 50]
-LDAP functions

include_once('../../lib/status.inc') [line 52]
-status messages

-

-

-
-
- -

not_an_attr [line 188]

-
-
-
- void not_an_attr( - $x) -
-

- - Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.



- -

Parameters

- - - - - - -
  $x  
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:17 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_oclass.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_oclass.php.html deleted file mode 100644 index 55ede221..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_oclass.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page add_oclass.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: add_oclass.php

-Source Location: /templates/tree/add_oclass.php

- -
-
- - -

Page Details:

-Adds an objectClass to the specified dn.

Variables that come in as POST vars:

Note, this does not do any schema violation checking. That is performed in add_oclass_form.php.

Vars that come in as POST:

  • dn (rawurlencoded)
  • new_oclass
  • new_attrs (array, if any)




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 49]
-security functions

include_once('../../lib/tree.inc') [line 51]
-tree functions

include_once('../../lib/config.inc') [line 53]
-access to configuration

include_once('../../lib/ldap.inc') [line 55]
-LDAP functions

include_once('../../lib/status.inc') [line 57]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:17 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html deleted file mode 100644 index be3040e7..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_oclass_form.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page add_oclass_form.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: add_oclass_form.php

-Source Location: /templates/tree/add_oclass_form.php

- -
-
- - -

Page Details:

-This page may simply add the objectClass and take you back to the edit page, but, in one condition it may prompt the user for input. That condition is this:

If the user has requested to add an objectClass that requires a set of attributes with 1 or more not defined by the object. In that case, we will present a form for the user to add those attributes to the object.

Variables that come in as POST vars:

  • dn (rawurlencoded)
  • new_oclass




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 50]
-security functions

include_once('../../lib/tree.inc') [line 52]
-tree functions

include_once('../../lib/config.inc') [line 54]
-access to configuration

include_once('../../lib/ldap.inc') [line 56]
-LDAP functions

include_once('../../lib/status.inc') [line 58]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:17 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_value.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_value.php.html deleted file mode 100644 index 8b06aa0e..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_value.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page add_value.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: add_value.php

-Source Location: /templates/tree/add_value.php

- -
-
- - -

Page Details:

-Adds a value to an attribute for a given dn.

Variables that come in as POST vars:

  • dn (rawurlencoded)
  • attr (rawurlencoded) the attribute to which we are adding a value
  • new_value (form element)
  • binary
On success, redirect to the edit_dn page. On failure, echo an error.




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 49]
-security functions

include_once('../../lib/tree.inc') [line 51]
-tree functions

include_once('../../lib/config.inc') [line 53]
-access to configuration

include_once('../../lib/ldap.inc') [line 55]
-LDAP functions

include_once('../../lib/status.inc') [line 57]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:17 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_value_form.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_value_form.php.html deleted file mode 100644 index 992e1f7d..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---add_value_form.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page add_value_form.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: add_value_form.php

-Source Location: /templates/tree/add_value_form.php

- -
-
- - -

Page Details:

-add_value_form.php Displays a form to allow the user to enter a new value to add to the existing list of values for a multi-valued attribute.

Variables that come in as GET vars:

  • dn (rawurlencoded)
  • attr (rawurlencoded) the attribute to which we are adding a value




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 46]
-security functions

include_once('../../lib/tree.inc') [line 48]
-tree functions

include_once('../../lib/config.inc') [line 50]
-access to configuration

include_once('../../lib/ldap.inc') [line 52]
-LDAP functions

include_once('../../lib/status.inc') [line 54]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:18 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---collapse.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---collapse.php.html deleted file mode 100644 index 46d9d379..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---collapse.php.html +++ /dev/null @@ -1,179 +0,0 @@ - - -Docs for page collapse.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: collapse.php

-Source Location: /templates/tree/collapse.php

- -
-
- - -

Page Details:

-This script alters the session variable 'tree', collapsing it at the dn specified in the query string.

Variables that come in as GET vars:

  • dn (rawurlencoded)
  • server_id
Note: this script is equal and opposite to expand.php




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 48]
-security functions

include_once('../../lib/tree.inc') [line 50]
-tree functions

include_once('../../lib/config.inc') [line 52]
-access to configuration

include_once('../../lib/ldap.inc') [line 54]
-LDAP functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:21 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---create.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---create.php.html deleted file mode 100644 index 6cfe2ba9..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---create.php.html +++ /dev/null @@ -1,181 +0,0 @@ - - -Docs for page create.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: create.php

-Source Location: /templates/tree/create.php

- -
-
- - -

Page Details:

-Creates a new object.

Variables that come in as POST vars:

  • new_dn
  • attrs (an array of attributes)
  • vals (an array of values for the above attrs)
  • required_attrs (an array with indices being the attributes, - and the values being their respective values)
  • object_classes (rawurlencoded, and serialized array of objectClasses)




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 49]
-security functions

include_once('../../lib/tree.inc') [line 51]
-tree functions

include_once('../../lib/config.inc') [line 53]
-access to configuration

include_once('../../lib/ldap.inc') [line 55]
-LDAP functions

include_once('../../lib/status.inc') [line 57]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---create_form.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---create_form.php.html deleted file mode 100644 index 2ac6be42..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---create_form.php.html +++ /dev/null @@ -1,181 +0,0 @@ - - -Docs for page create_form.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: create_form.php

-Source Location: /templates/tree/create_form.php

- -
-
- - -

Page Details:

-The menu where the user chooses an RDN, Container, and Template for creating a new entry.

After submitting this form, the user is taken to their chosen Template handler.

Variables that come in as GET vars

  • container (rawurlencoded) (optional)




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/tree.inc') [line 47]
-tree functions

include_once('../../lib/security.inc') [line 45]
-security functions

include_once('../../lib/config.inc') [line 49]
-access to configuration

include_once('../../lib/ldap.inc') [line 51]
-LDAP functions

include_once('templates/templates.inc') [line 55]
-template configuration

include_once('../../lib/status.inc') [line 53]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---creation_template.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---creation_template.php.html deleted file mode 100644 index 16a517f8..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---creation_template.php.html +++ /dev/null @@ -1,182 +0,0 @@ - - -Docs for page creation_template.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: creation_template.php

-Source Location: /templates/tree/creation_template.php

- -
-
- - -

Page Details:

-This file simply acts as a plugin grabber for the creator templates in the directory templates/creation/

Expected POST vars: template




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include($handler) [line 93]
-include_once('../../lib/config.inc') [line 48]
-access to configuration

include_once('../../lib/security.inc') [line 44]
-security functions

include_once('../../lib/tree.inc') [line 46]
-tree functions

include_once('../../lib/ldap.inc') [line 50]
-LDAP functions

include_once('templates/templates.inc') [line 54]
-template configuration

include_once('../../lib/status.inc') [line 52]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:25 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete.php.html deleted file mode 100644 index 6e569fd9..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page delete.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: delete.php

-Source Location: /templates/tree/delete.php

- -
-
- - -

Page Details:

-Deletes a DN and presents a "job's done" message.

Variables that come in as POST vars:

  • dn (rawurlencoded)




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 44]
-security functions

include_once('../../lib/tree.inc') [line 46]
-tree functions

include_once('../../lib/config.inc') [line 48]
-access to configuration

include_once('../../lib/ldap.inc') [line 50]
-LDAP functions

include_once('../../lib/status.inc') [line 52]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:25 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete_attr.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete_attr.php.html deleted file mode 100644 index e760dfb7..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete_attr.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page delete_attr.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: delete_attr.php

-Source Location: /templates/tree/delete_attr.php

- -
-
- - -

Page Details:

-Deletes an attribute from an entry with NO confirmation.

On success, redirect to edit.php On failure, echo an error.




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 44]
-security functions

include_once('../../lib/tree.inc') [line 46]
-tree functions

include_once('../../lib/config.inc') [line 48]
-access to configuration

include_once('../../lib/ldap.inc') [line 50]
-LDAP functions

include_once('../../lib/status.inc') [line 52]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:25 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete_form.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete_form.php.html deleted file mode 100644 index 34de4411..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---delete_form.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page delete_form.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: delete_form.php

-Source Location: /templates/tree/delete_form.php

- -
-
- - -

Page Details:

-Displays a last chance confirmation form to delete a dn.

Variables that come in as GET vars:

  • dn (rawurlencoded)




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 44]
-security functions

include_once('../../lib/tree.inc') [line 46]
-tree functions

include_once('../../lib/config.inc') [line 48]
-access to configuration

include_once('../../lib/ldap.inc') [line 50]
-LDAP functions

include_once('../../lib/status.inc') [line 52]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html deleted file mode 100644 index 9a71bacb..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---download_binary_attr.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page download_binary_attr.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: download_binary_attr.php

-Source Location: /templates/tree/download_binary_attr.php

- -
-
- - -

Page Details:

-Used to send binary values to user.



-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 41]
-security functions

include_once('../../lib/tree.inc') [line 43]
-tree functions

include_once('../../lib/config.inc') [line 45]
-access to configuration

include_once('../../lib/ldap.inc') [line 47]
-LDAP functions

include_once('../../lib/status.inc') [line 49]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---edit.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---edit.php.html deleted file mode 100644 index 117cbcdf..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---edit.php.html +++ /dev/null @@ -1,181 +0,0 @@ - - -Docs for page edit.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: edit.php

-Source Location: /templates/tree/edit.php

- -
-
- - -

Page Details:

-Displays the specified dn from the specified server for editing

Variables that come in as GET vars:

  • dn (rawurlencoded)
  • modified_attrs (optional) an array of attributes to highlight as - they were changed by the last operation




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 46]
-security functions

include_once('../../lib/tree.inc') [line 48]
-tree functions

include_once('../../lib/config.inc') [line 50]
-access to configuration

include_once('../../lib/ldap.inc') [line 52]
-LDAP functions

include_once('../../lib/status.inc') [line 54]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---expand.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---expand.php.html deleted file mode 100644 index ca0836e4..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---expand.php.html +++ /dev/null @@ -1,179 +0,0 @@ - - -Docs for page expand.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: expand.php

-Source Location: /templates/tree/expand.php

- -
-
- - -

Page Details:

-This script alters the session variable 'tree', expanding it at the dn specified in the query string.

Variables that come in as GET vars:

  • dn (rawurlencoded)
Note: this script is equal and opposite to collapse.php




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 47]
-security functions

include_once('../../lib/tree.inc') [line 49]
-tree functions

include_once('../../lib/config.inc') [line 51]
-access to configuration

include_once('../../lib/ldap.inc') [line 53]
-LDAP functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---export.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---export.php.html deleted file mode 100644 index 4b37ff12..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---export.php.html +++ /dev/null @@ -1,181 +0,0 @@ - - -Docs for page export.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: export.php

-Source Location: /templates/tree/export.php

- -
-
- - -

Page Details:

-

-

Tags:

-
- - - - - - - -
author:  The phpLDAPadmin development team
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/ldap.inc') [line 47]
-LDAP functions

include_once('../../lib/config.inc') [line 45]
-access to configuration

include_once('../../lib/status.inc') [line 49]
-status messages

include_once('../../lib/security.inc') [line 39]
-security functions

require('../../lib/export.inc') [line 41]
-export functions

require('../../lib/tree.inc') [line 43]
-common functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---export_form.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---export_form.php.html deleted file mode 100644 index 12c37a81..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---export_form.php.html +++ /dev/null @@ -1,204 +0,0 @@ - - -Docs for page export_form.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: export_form.php

-Source Location: /templates/tree/export_form.php

- -
-
- - -

Page Details:

-export_form.php --------------------

Html form to choose an export format(ldif,...)




-

Tags:

-
- - - - - - - -
author:  The phpLDAPadmin development team
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 44]
-security functions

include_once('../../lib/config.inc') [line 48]
-access to configuration

include_once('../../lib/ldap.inc') [line 50]
-LDAP functions

include_once('../../lib/status.inc') [line 52]
-status messages

require('../../lib/export.inc') [line 46]
-export functions

-

-

-
-
- -

get_line_end_format [line 181]

-
-
-
- String get_line_end_format( -) -
-

- - Helper functoin for fetching the line end format.



-

Tags:

-
- - - - -
return:  'win', 'unix', or 'mac' based on the user's browser..
-
-

- -
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---rdelete.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---rdelete.php.html deleted file mode 100644 index d3ac2a42..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---rdelete.php.html +++ /dev/null @@ -1,203 +0,0 @@ - - -Docs for page rdelete.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: rdelete.php

-Source Location: /templates/tree/rdelete.php

- -
-
- - -

Page Details:

-Recursively deletes the specified DN and all of its children Variables that come in as POST vars:
  • dn (rawurlencoded)




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/tree.inc') [line 45]
-tree functions

include_once('../../lib/security.inc') [line 43]
-security functions

include_once('../../lib/config.inc') [line 47]
-access to configuration

include_once('../../lib/ldap.inc') [line 49]
-LDAP functions

include_once('../../lib/status.inc') [line 51]
-status messages

-

-

-
-
- -

pla_rdelete [line 129]

-
-
-
- void pla_rdelete( - $dn) -
-

- -

- -

Parameters

- - - - - - -
  $dn  
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---refresh.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---refresh.php.html deleted file mode 100644 index 9c7a0ef1..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---refresh.php.html +++ /dev/null @@ -1,179 +0,0 @@ - - -Docs for page refresh.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: refresh.php

-Source Location: /templates/tree/refresh.php

- -
-
- - -

Page Details:

-This script alters the session variable 'tree', by re-querying the LDAP server to grab the contents of every expanded container.

Variables that come in as GET vars:




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 44]
-security functions

include_once('../../lib/tree.inc') [line 46]
-tree functions

include_once('../../lib/config.inc') [line 48]
-access to configuration

include_once('../../lib/ldap.inc') [line 50]
-LDAP functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html deleted file mode 100644 index 0bd5357a..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---creation---custom.php.html +++ /dev/null @@ -1,251 +0,0 @@ - - -Docs for page custom.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: custom.php

-Source Location: /templates/tree/templates/creation/custom.php

- -
-
- - -

Page Details:

-Creates custom LDAP objects.



-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

-

-
-
- -

get_attr_select_html [line 245]

-
-
-
- void get_attr_select_html( - $all_attrs, [ $highlight_attr = null]) -
-

- - Returns option values.



- -

Parameters

- - - - - - - - - - - -
  $all_attrs  
  $highlight_attr  
-
[ Top ]


-
-
- -

get_binary_attr_select_html [line 264]

-
-
-
- void get_binary_attr_select_html( - $binary_attrs, [ $highlight_attr = null]) -
-

- - Returns option values.



- -

Parameters

- - - - - - - - - - - -
  $binary_attrs  
  $highlight_attr  
-
[ Top ]


-
-
- -

remove_aliases [line 285]

-
-
-
- void remove_aliases( - &$attribute_list) -
-

- - Removes attributes from the array that are aliases for eachother

(just removes the second instance of the aliased attr)




- -

Parameters

- - - - - - -
  &$attribute_list  
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:25 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html deleted file mode 100644 index 3d3c9b1c..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---creation---new_ou_template.php.html +++ /dev/null @@ -1,172 +0,0 @@ - - -Docs for page new_ou_template.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: new_ou_template.php

-Source Location: /templates/tree/templates/creation/new_ou_template.php

- -
-
- - -

Page Details:

-Creates new OUs.



-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:42 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html deleted file mode 100644 index aa000733..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---templates---templates.inc.html +++ /dev/null @@ -1,172 +0,0 @@ - - -Docs for page templates.inc - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: templates.inc

-Source Location: /templates/tree/templates/templates.inc

- -
-
- - -

Page Details:

-Configuration for creation templates.



-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---tree.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---tree.php.html deleted file mode 100644 index 26da237b..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---tree.php.html +++ /dev/null @@ -1,240 +0,0 @@ - - -Docs for page tree.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: tree.php

-Source Location: /templates/tree/tree.php

- -
-
- - -

Page Details:

-This script displays the LDAP tree for all the servers that you have

in config.php. We read the session variable 'tree' to know which dns are expanded or collapsed. No query string parameters are expected, however, you can use a '#' offset to scroll to a given dn. The syntax is tree.php#<rawurlencoded dn>, so if I wanted to scroll to dc=example,dc=com for server 3, the URL would be: tree.php#3_dc%3Dexample%2Cdc%3Dcom




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 47]
-security functions

include_once('../../lib/tree.inc') [line 49]
-tree functions

include_once('../../lib/ldap.inc') [line 53]
-LDAP functions

include_once('../../lib/config.inc') [line 51]
-access to configuration

-

-

-
-
- -

draw_create_link [line 175]

-
-
-
- void draw_create_link( - $rdn, $level, $encoded_dn) -
-

- -

- -

Parameters

- - - - - - - - - - - - - - - - -
  $rdn  
  $level  
  $encoded_dn  
-
[ Top ]


-
-
- -

draw_tree_html [line 102]

-
-
-
- void draw_tree_html( - $dn, [ $level = 0]) -
-

- - Recursively descend on the given dn and draw the tree in html



- -

Parameters

- - - - - - - - - - - -
  $dn  
  $level  
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---tree_view.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---tree_view.php.html deleted file mode 100644 index 497ca15b..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---tree_view.php.html +++ /dev/null @@ -1,176 +0,0 @@ - - -Docs for page tree_view.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: tree_view.php

-Source Location: /templates/tree/tree_view.php

- -
-
- - -

Page Details:

-This file includes the main frame of the LDAP browser.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 34]
-security functions

include_once('../../lib/tree.inc') [line 36]
-tree functions

include_once('../../lib/config.inc') [line 38]
-access to configuration

include_once('../../lib/ldap.inc') [line 40]
-LDAP functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---update.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---update.php.html deleted file mode 100644 index f0243d89..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---update.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page update.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: update.php

-Source Location: /templates/tree/update.php

- -
-
- - -

Page Details:

-Updates or deletes a value from a specified attribute for a specified dn.

Variables that come in on the query string:

  • dn (rawurlencoded)
  • update_array (an array in the form expected by PHP's ldap_modify, except for deletions) - (will never be empty: update_confirm.php ensures that)
Attribute deletions: To specify that an attribute is to be deleted (whether multi- or single-valued), enter that attribute in the update array like this: attr => ''. For example, to delete the 'sn' attribute from an entry, the update array would look like this: Array ( sn => '' )

On success, redirect to edit.php On failure, echo an error.




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 57]
-security functions

include_once('../../lib/tree.inc') [line 59]
-tree functions

include_once('../../lib/config.inc') [line 61]
-access to configuration

include_once('../../lib/ldap.inc') [line 63]
-LDAP functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---update_confirm.php.html b/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---update_confirm.php.html deleted file mode 100644 index 49326a75..00000000 --- a/lam-web/developers/devel/phpdoc/lists/tree/_templates---tree---update_confirm.php.html +++ /dev/null @@ -1,180 +0,0 @@ - - -Docs for page update_confirm.php - - - - - - - - - - - - - -
lists
- - - [ class tree: lists ] - [ index: lists ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: update_confirm.php

-Source Location: /templates/tree/update_confirm.php

- -
-
- - -

Page Details:

-Takes the results of clicking "Save" in edit.php and determines which

attributes need to be updated (ie, which ones actually changed). Then, we present a confirmation table to the user outlining the changes they are about to make. That form submits directly to update.php, which makes the change.




-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../../lib/security.inc') [line 45]
-security functions

include_once('../../lib/tree.inc') [line 47]
-tree functions

include_once('../../lib/config.inc') [line 49]
-access to configuration

include_once('../../lib/ldap.inc') [line 51]
-LDAP functions

include_once('../../lib/account.inc') [line 53]
-common functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/main/_templates---delete.php.html b/lam-web/developers/devel/phpdoc/main/_templates---delete.php.html deleted file mode 100644 index 31af1d7a..00000000 --- a/lam-web/developers/devel/phpdoc/main/_templates---delete.php.html +++ /dev/null @@ -1,178 +0,0 @@ - - -Docs for page delete.php - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: delete.php

-Source Location: /templates/delete.php

- -
-
- - -

Page Details:

-Used to delete accounts from LDAP tree.



-

Tags:

-
- - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../lib/status.inc') [line 41]
-message displaying

include_once("../lib/security.inc") [line 35]
-security functions

include_once('../lib/config.inc') [line 39]
-current configuration options

include_once('../lib/ldap.inc') [line 43]
-LDAP connection

include_once('../lib/modules.inc') [line 47]
-module interface

include_once('../lib/lamdaemon.inc') [line 45]
-lamdaemon interface

include_once('../lib/account.inc') [line 37]
-account functions

-

-

-
-
- -

deleteDN [line 272]

-
-
-
- array deleteDN( -string $dn) -
-

- - Deletes a DN and all child entries.



-

Tags:

-
- - - - -
return:  error messages
-
-

- -

Parameters

- - - - - - -
string  $dn  DN to delete
-
[ Top ]


-
-
- -

getChildCount [line 256]

-
-
-
- interger getChildCount( -string $dn) -
-

- - Returns the number of child entries of a DN.



-

Tags:

-
- - - - -
return:  number of childs
-
-

- -

Parameters

- - - - - - -
string  $dn  DN of parent
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:25 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/main/_templates---initsuff.php.html b/lam-web/developers/devel/phpdoc/main/_templates---initsuff.php.html deleted file mode 100644 index b271f44d..00000000 --- a/lam-web/developers/devel/phpdoc/main/_templates---initsuff.php.html +++ /dev/null @@ -1,108 +0,0 @@ - - -Docs for page initsuff.php - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: initsuff.php

-Source Location: /templates/initsuff.php

- -
-
- - -

Page Details:

-Creates main suffixes if they are missing.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../lib/security.inc") [line 32]
-security functions

include_once("../lib/config.inc") [line 34]
-access to configuration settings

include_once("../lib/ldap.inc") [line 36]
-LDAP access

include_once("../lib/status.inc") [line 38]
-status messages

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:35 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/main/_templates---login.php.html b/lam-web/developers/devel/phpdoc/main/_templates---login.php.html deleted file mode 100644 index 70866c02..00000000 --- a/lam-web/developers/devel/phpdoc/main/_templates---login.php.html +++ /dev/null @@ -1,132 +0,0 @@ - - -Docs for page login.php - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: login.php

-Source Location: /templates/login.php

- -
-
- - -

Page Details:

-Login form of LDAP Account Manager.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-

-

Includes:

-
-include_once("../lib/status.inc") [line 32]
-status messages

include_once("../lib/security.inc") [line 34]
-security functions

include_once("../lib/config.inc") [line 100]
-access to configuration options

include_once("../lib/ldap.inc") [line 380]
-include_once("../lib/selfService.inc") [line 36]
-self service functions

-

-

-
-
- -

display_LoginPage [line 110]

-
-
-
- void display_LoginPage( -object $config_object) -
-

- - Displays the login window.



- -

Parameters

- - - - - - -
object  $config_object  current active configuration
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/main/_templates---logout.php.html b/lam-web/developers/devel/phpdoc/main/_templates---logout.php.html deleted file mode 100644 index 71006dff..00000000 --- a/lam-web/developers/devel/phpdoc/main/_templates---logout.php.html +++ /dev/null @@ -1,107 +0,0 @@ - - -Docs for page logout.php - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: logout.php

-Source Location: /templates/logout.php

- -
-
- - -

Page Details:

-User is logged off from LDAP server, session is destroyed.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../lib/security.inc") [line 39]
-security functions

include_once("../lib/status.inc") [line 41]
-Used to display status messages

include_once("../lib/ldap.inc") [line 43]
-LDAP settings are deleted at logout

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/main/_templates---main.php.html b/lam-web/developers/devel/phpdoc/main/_templates---main.php.html deleted file mode 100644 index 399a2d47..00000000 --- a/lam-web/developers/devel/phpdoc/main/_templates---main.php.html +++ /dev/null @@ -1,106 +0,0 @@ - - -Docs for page main.php - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: main.php

-Source Location: /templates/main.php

- -
-
- - -

Page Details:

-This is the main window. The user and group lists will be shown in this frameset.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../lib/cache.inc') [line 32]
-LDAP attibute cache

include_once('../lib/config.inc') [line 34]
-config object

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:41 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/main/_templates---main_header.php.html b/lam-web/developers/devel/phpdoc/main/_templates---main_header.php.html deleted file mode 100644 index 1450433a..00000000 --- a/lam-web/developers/devel/phpdoc/main/_templates---main_header.php.html +++ /dev/null @@ -1,107 +0,0 @@ - - -Docs for page main_header.php - - - - - - - - - - - - - -
main
- - - [ class tree: main ] - [ index: main ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: main_header.php

-Source Location: /templates/main_header.php

- -
-
- - -

Page Details:

-Head frame in main window, includes links to lists etc.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../lib/security.inc") [line 32]
-security functions

include_once("../lib/config.inc") [line 34]
-access to configuration options

include_once("../lib/selfService.inc") [line 36]
-self service functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:41 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/media/background.png b/lam-web/developers/devel/phpdoc/media/background.png deleted file mode 100644 index 638060d2..00000000 Binary files a/lam-web/developers/devel/phpdoc/media/background.png and /dev/null differ diff --git a/lam-web/developers/devel/phpdoc/media/empty.png b/lam-web/developers/devel/phpdoc/media/empty.png deleted file mode 100644 index b26eb55a..00000000 Binary files a/lam-web/developers/devel/phpdoc/media/empty.png and /dev/null differ diff --git a/lam-web/developers/devel/phpdoc/media/style.css b/lam-web/developers/devel/phpdoc/media/style.css deleted file mode 100644 index bc65d896..00000000 --- a/lam-web/developers/devel/phpdoc/media/style.css +++ /dev/null @@ -1,195 +0,0 @@ -.php { - padding: 1em; -} -.php-src { font-family: 'Courier New', Courier, monospace; font-weight: normal; } - -body -{ - color: #000000; - background-color: #ffffff; - background-image: url("background.png"); - background-repeat: repeat-y; - font-family: tahoma, verdana, arial, sans-serif; - font-size: 10pt; - margin: 0; - padding: 0; -} - -a -{ - color: #000099; - background-color: transparent; - text-decoration: none; -} - -a:hover -{ - text-decoration: underline; -} - -a.menu -{ - color: #ffffff; - background-color: transparent; -} - -td -{ - font-size: 10pt; -} - -td.header_top -{ - color: #ffffff; - background-color: #9999cc; - font-size: 16pt; - font-weight: bold; - text-align: right; - padding: 10px; -} - -td.header_line -{ - color: #ffffff; - background-color: #333366; -} - -td.header_menu -{ - color: #ffffff; - background-color: #666699; - font-size: 8pt; - text-align: right; - padding: 2px; - padding-right: 5px; -} - -td.menu -{ - padding: 2px; - padding-left: 5px; -} - -td.code_border -{ - color: #000000; - background-color: #c0c0c0; -} - -td.code -{ - color: #000000; - background-color: #f0f0f0; -} - -td.type -{ - font-style: italic; -} - -div.credit -{ - font-size: 8pt; - text-align: center; -} - -div.package -{ - padding-left: 5px; -} - -div.tags -{ - padding-left: 15px; -} - -div.function -{ - padding-left: 15px; -} - -div.top -{ - font-size: 8pt; -} - -div.warning -{ - color: #ff0000; - background-color: transparent; -} - -div.description -{ - padding-left: 15px; -} - -hr -{ - height: 1px; - border-style: solid; - border-color: #c0c0c0; - margin-top: 10px; - margin-bottom: 10px; -} - -span.smalllinenumber -{ - font-size: 8pt; -} - -ul { - margin-left: 0px; - padding-left: 8px; -} -/* Syntax highlighting */ - -.src-code { background-color: #f5f5f5; border: 1px solid #ccc9a4; padding: 0 0 0 1em; margin : 0px; - font-family: 'Courier New', Courier, monospace; font-weight: normal; } -.src-line { font-family: 'Courier New', Courier, monospace; font-weight: normal; } - -.src-comm { color: green; } -.src-id { } -.src-inc { color: #0000FF; } -.src-key { color: #0000FF; } -.src-num { color: #CC0000; } -.src-str { color: #66cccc; } -.src-sym { font-weight: bold; } -.src-var { } - -.src-php { font-weight: bold; } - -.src-doc { color: #009999 } -.src-doc-close-template { color: #0000FF } -.src-doc-coretag { color: #0099FF; font-weight: bold } -.src-doc-inlinetag { color: #0099FF } -.src-doc-internal { color: #6699cc } -.src-doc-tag { color: #0080CC } -.src-doc-template { color: #0000FF } -.src-doc-type { font-style: italic } -.src-doc-var { font-style: italic } - -.tute-tag { color: #009999 } -.tute-attribute-name { color: #0000FF } -.tute-attribute-value { color: #0099FF } -.tute-entity { font-weight: bold; } -.tute-comment { font-style: italic } -.tute-inline-tag { color: #636311; font-weight: bold } - -/* tutorial */ - -.authors { } -.author { font-style: italic; font-weight: bold } -.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal } -.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; } -.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap; } -.release-info { font-size: 85%; font-style: italic; margin: 1em 0em } -.ref-title-box { } -.ref-title { } -.ref-purpose { font-style: italic; color: #666666 } -.ref-synopsis { } -.title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #9999CC } -.cmd-synopsis { margin: 1em 0em } -.cmd-title { font-weight: bold } -.toc { margin-left: 2em; padding-left: 0em } - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---baseModule.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---baseModule.inc.html deleted file mode 100644 index b41409f2..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---baseModule.inc.html +++ /dev/null @@ -1,163 +0,0 @@ - - -Docs for page baseModule.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: baseModule.inc

-Source Location: /lib/baseModule.inc

- -
-
- -
-

Classes:

-
baseModule
-
Parent class of all account modules.
-


- -

Page Details:

-This is the parent class for all account modules.

It implements the complete module interface and uses meta-data provided by the account modules for its functions.




-

Tags:

-
- - - - - - - -
author:  Roland Gruber
see:  baseModule
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:18 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---createntlm.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---createntlm.inc.html deleted file mode 100644 index 3795e53c..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---createntlm.inc.html +++ /dev/null @@ -1,160 +0,0 @@ - - -Docs for page createntlm.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: createntlm.inc

-Source Location: /lib/createntlm.inc

- -
-
- -
-

Classes:

-
smbHash
-
Calculates NT and LM hashes.
-


- -

Page Details:

-This class provides functions to calculate Samba NT and LM hashes.

The code is a conversion from createntlm.pl (Benjamin Kuit) and smbdes.c/md4.c (Andrew Tridgell).




-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---lamdaemon.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---lamdaemon.inc.html deleted file mode 100644 index 8c4c4cd8..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---lamdaemon.inc.html +++ /dev/null @@ -1,235 +0,0 @@ - - -Docs for page lamdaemon.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: lamdaemon.inc

-Source Location: /lib/lamdaemon.inc

- -
-
- - -

Page Details:

-This file includes functions to control lamdaemon.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Thomas Manninger
-
-

-

-

-
-
- -

lamdaemon [line 42]

-
-
-
- array lamdaemon( -array $commands, string $server) -
-

- - Sends commands to lamdaemon script.



-

Tags:

-
- - - - -
return:  Output of lamdaemon
-
-

- -

Parameters

- - - - - - - - - - - -
array  $commands  List of command lines
string  $server  remote server
-
[ Top ]


-
-
- -

lamdaemonSSH [line 97]

-
-
-
- array lamdaemonSSH( -array $commands, string $server) -
-

- - Sends commands to lamdaemon script via PHP SSH functions.



-

Tags:

-
- - - - -
return:  Output of lamdaemon
-
-

- -

Parameters

- - - - - - - - - - - -
array  $commands  List of command lines
string  $server  remote server
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:36 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---account.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---account.inc.html deleted file mode 100644 index 397ee72f..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---account.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -Docs for page account.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: account.inc

-Source Location: /lib/modules/account.inc

- -
-
- -
-

Classes:

-
account
-
Manages the object class "account" for users and hosts.
-


- -

Page Details:

-Manages the object class "account" for users and hosts.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---ieee802device.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---ieee802device.inc.html deleted file mode 100644 index b013e5d3..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---ieee802device.inc.html +++ /dev/null @@ -1,160 +0,0 @@ - - -Docs for page ieee802device.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: ieee802device.inc

-Source Location: /lib/modules/ieee802device.inc

- -
-
- -
-

Classes:

-
ieee802Device
-
Provides MAC addresses for hosts.
-


- -

Page Details:

-Provides MAC addresses for hosts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html deleted file mode 100644 index 24efc5bf..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---inetLocalMailRecipient.inc.html +++ /dev/null @@ -1,160 +0,0 @@ - - -Docs for page inetLocalMailRecipient.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: inetLocalMailRecipient.inc

-Source Location: /lib/modules/inetLocalMailRecipient.inc

- -
-
- -
-

Classes:

-
inetLocalMailRecipient
-
Provides mail routing for users.
-


- -

Page Details:

-Provides mail routing for user accounts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:33 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html deleted file mode 100644 index c812afd0..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---inetOrgPerson.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -Docs for page inetOrgPerson.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: inetOrgPerson.inc

-Source Location: /lib/modules/inetOrgPerson.inc

- -
-
- -
-

Classes:

-
inetOrgPerson
-
This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
-


- -

Page Details:

-Manages the atrributes of object class inetOrgPerson.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:34 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---kolabUser.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---kolabUser.inc.html deleted file mode 100644 index 91f568f7..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---kolabUser.inc.html +++ /dev/null @@ -1,160 +0,0 @@ - - -Docs for page kolabUser.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: kolabUser.inc

-Source Location: /lib/modules/kolabUser.inc

- -
-
- -
-

Classes:

-
kolabUser
-
Manages Kolab user accounts.
-


- -

Page Details:

-Manages Kolab user accounts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:35 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html deleted file mode 100644 index 02d2fb6c..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---ldapPublicKey.inc.html +++ /dev/null @@ -1,163 +0,0 @@ - - -Docs for page ldapPublicKey.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: ldapPublicKey.inc

-Source Location: /lib/modules/ldapPublicKey.inc

- -
-
- -
-

Classes:

-
ldapPublicKey
-
Manages SSH public keys.
-


- -

Page Details:

-Manages SSH public keys.



-

Tags:

-
- - - - - - - -
author:  Roland Gruber
author:  Andrew Dibble <adibble@mobitv.com>
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---nisMailAlias.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---nisMailAlias.inc.html deleted file mode 100644 index 7d92ac7d..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---nisMailAlias.inc.html +++ /dev/null @@ -1,160 +0,0 @@ - - -Docs for page nisMailAlias.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: nisMailAlias.inc

-Source Location: /lib/modules/nisMailAlias.inc

- -
-
- -
-

Classes:

-
nisMailAlias
-
Provides NIS mail alias management.
-


- -

Page Details:

-Provides NIS mail alias management.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:42 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---posixAccount.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---posixAccount.inc.html deleted file mode 100644 index f212d130..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---posixAccount.inc.html +++ /dev/null @@ -1,169 +0,0 @@ - - -Docs for page posixAccount.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: posixAccount.inc

-Source Location: /lib/modules/posixAccount.inc

- -
-
- -
-

Classes:

-
posixAccount
-
Manages the object class "posixAccount" for users and hosts.
-


- -

Page Details:

-Manages Unix accounts for users and hosts.



-

Tags:

-
- - - - - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
author:  Thomas Manninger
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:44 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---posixGroup.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---posixGroup.inc.html deleted file mode 100644 index 77c01fb5..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---posixGroup.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -Docs for page posixGroup.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: posixGroup.inc

-Source Location: /lib/modules/posixGroup.inc

- -
-
- -
-

Classes:

-
posixGroup
-
Manages the object class "posixGroup" for groups.
-


- -

Page Details:

-Manages Unix accounts for groups.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:45 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---quota.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---quota.inc.html deleted file mode 100644 index 44368757..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---quota.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -Docs for page quota.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: quota.inc

-Source Location: /lib/modules/quota.inc

- -
-
- -
-

Classes:

-
quota
-
Manages quotas for users and groups.
-


- -

Page Details:

-Manages quotas for users and groups.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaAccount.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaAccount.inc.html deleted file mode 100644 index 05e0d57c..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaAccount.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -Docs for page sambaAccount.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: sambaAccount.inc

-Source Location: /lib/modules/sambaAccount.inc

- -
-
- -
-

Classes:

-
sambaAccount
-
Manages the object class "sambaAccount" for users and hosts.
-


- -

Page Details:

-Manages Samba 2 accounts for users and hosts.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaDomain.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaDomain.inc.html deleted file mode 100644 index 437e0b7f..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaDomain.inc.html +++ /dev/null @@ -1,160 +0,0 @@ - - -Docs for page sambaDomain.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: sambaDomain.inc

-Source Location: /lib/modules/sambaDomain.inc

- -
-
- -
-

Classes:

-
sambaDomain
-
Manages Samba 3 domain entries.
-


- -

Page Details:

-Manages Samba 3 domain entries.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:49 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html deleted file mode 100644 index f4d2d899..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaGroupMapping.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -Docs for page sambaGroupMapping.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: sambaGroupMapping.inc

-Source Location: /lib/modules/sambaGroupMapping.inc

- -
-
- -
-

Classes:

-
sambaGroupMapping
-
Manages the object class "sambaGroupMapping" for groups.
-


- -

Page Details:

-Manages Samba 3 accounts for groups.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:50 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html deleted file mode 100644 index 50d8067d..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html +++ /dev/null @@ -1,186 +0,0 @@ - - -Docs for page sambaMungedDial.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: sambaMungedDial.inc

-Source Location: /lib/modules/sambaSamAccount/sambaMungedDial.inc

- -
-
- -
-

Classes:

-
sambaMungedDial
-
Manages terminal server settings for Samba 3.
-


- -

Page Details:

-Manages terminal server settings for Samba 3.



-

Tags:

-
- - - - -
author:  Cajus Pollmeier
-
-

-

-

-
- -

SAMBA_MUNGEDDIAL_FILEHEADER [line 32]

-
-
-
- SAMBA_MUNGEDDIAL_FILEHEADER = "20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."5000" -
-
- - File header


-
-
[ Top ]


-
- -

SAMBA_MUNGEDDIAL_FILEHEADER_OLD [line 43]

-
-
-
- SAMBA_MUNGEDDIAL_FILEHEADER_OLD = "6d000800200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200064000100"."20002000200020002000200020002000"."20002000200020002000200020002000"."20002000200020002000200020002000"."50001000" -
-
- - File header for old format.


-
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:51 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html deleted file mode 100644 index d081eaa9..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---sambaSamAccount.inc.html +++ /dev/null @@ -1,170 +0,0 @@ - - -Docs for page sambaSamAccount.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: sambaSamAccount.inc

-Source Location: /lib/modules/sambaSamAccount.inc

- -
-
- -
-

Classes:

-
sambaSamAccount
-
Manages the object class "sambaSamAccount" for users and hosts.
-


- -

Page Details:

-Manages Samba 3 accounts for users and hosts.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
-
-

-

Includes:

-
-include_once('sambaSamAccount/sambaMungedDial.inc') [line 35]
-terminals server options

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:51 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules---shadowAccount.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules---shadowAccount.inc.html deleted file mode 100644 index 3677547f..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules---shadowAccount.inc.html +++ /dev/null @@ -1,166 +0,0 @@ - - -Docs for page shadowAccount.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: shadowAccount.inc

-Source Location: /lib/modules/shadowAccount.inc

- -
-
- -
-

Classes:

-
shadowAccount
-
Manages the object class "shadowAccount" for users.
-


- -

Page Details:

-Manages Unix shadow accounts for users.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Roland Gruber
author:  Michael Duergner
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:56 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_lib---modules.inc.html b/lam-web/developers/devel/phpdoc/modules/_lib---modules.inc.html deleted file mode 100644 index 8d24d1db..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_lib---modules.inc.html +++ /dev/null @@ -1,911 +0,0 @@ - - -Docs for page modules.inc - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: modules.inc

-Source Location: /lib/modules.inc

- -
-
- -
-

Classes:

-
accountContainer
-
This class includes all modules and attributes of an account.
-


- -

Page Details:

-Interface between modules and other parts of LAM.



-

Tags:

-
- - - - - - - - - - -
author:  Tilo Lutz
author:  Michael Duergner
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("lamdaemon.inc") [line 43]
-lamdaemon functions

include_once("baseModule.inc") [line 39]
-parent class of account modules

include_once("cache.inc") [line 35]
-LDAP caches

include_once("account.inc") [line 37]
-some helper functions

include_once($modulesINC_dirname.'/'.$entry) [line 55]
-This includes all module files.

include_once("ldap.inc") [line 41]
-access to LDAP server

include_once("security.inc") [line 45]
-security functions

-

-

-
-
- -

buildUploadAccounts [line 396]

-
-
-
- mixed buildUploadAccounts( -string $scope, array $data, array $ids) -
-

- - This function builds the LDAP accounts for the file upload.

If there are problems status messages will be printed automatically.




-

Tags:

-
- - - - -
return:  array including accounts or false if there were errors
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $scope  account type
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
-
[ Top ]


-
-
- -

checkConfigOptions [line 319]

-
-
-
- array checkConfigOptions( -array $scopes, array $options) -
-

- - Checks if the configuration options are valid



-

Tags:

-
- - - - -
return:  list of error messages
-
-

- -

Parameters

- - - - - - - - - - - -
array  $scopes  hash array (module name => array(account types))
array  $options  hash array containing all options (name => array(...))
-
[ Top ]


-
-
- -

checkProfileOptions [line 285]

-
-
-
- array checkProfileOptions( -string $scope, array $options) -
-

- - Checks if the profile options are valid



-

Tags:

-
- - - - -
return:  list of error messages
-
-

- -

Parameters

- - - - - - - - - - - -
string  $scope  account type (user, group, host)
array  $options  hash array containing all options (name => array(...))
-
[ Top ]


-
-
- -

check_module_conflicts [line 229]

-
-
-
- boolean check_module_conflicts( -array $selected, array $deps) -
-

- - Checks if there are conflicts between modules



-

Tags:

-
- - - - -
return:  false if no conflict was found, otherwise an array of array(selected module, conflicting module) if conflicts were found
-
-

- -

Parameters

- - - - - - - - - - - -
array  $selected  selected module names
array  $deps  module dependencies
-
[ Top ]


-
-
- -

check_module_depends [line 188]

-
-
-
- mixed check_module_depends( -array $selected, array $deps) -
-

- - Checks if there are missing dependencies between modules.



-

Tags:

-
- - - - -
return:  false if no misssing dependency was found, otherwise an array of array(selected module, depending module) if missing dependencies were found
-
-

- -

Parameters

- - - - - - - - - - - -
array  $selected  selected module names
array  $deps  module dependencies
-
[ Top ]


-
-
- -

doUploadPostActions [line 476]

-
-
-
- array doUploadPostActions( -string $scope, array $data, array $ids, array $failed) -
-

- - This function executes one post upload action.



-

Tags:

-
- - - - -
return:  current status
array (
'status' => 'finished' | 'inProgress'
'module' => <name of active module>
'progress' => 0..100
'errors' => array (<array of parameters for StatusMessage>)
)
-
-

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string  $scope  account type
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
-
[ Top ]


-
-
- -

getAvailableModules [line 248]

-
-
-
- array getAvailableModules( -string $scope) -
-

- - Returns an array with all available user module names



-

Tags:

-
- - - - -
return:  list of possible modules
-
-

- -

Parameters

- - - - - - -
string  $scope  account type (user, group, host)
-
[ Top ]


-
-
- -

getAvailablePDFFields [line 350]

-
-
-
- array getAvailablePDFFields( -string $scope) -
-

- - Returns a list of available PDF entries.



-

Tags:

-
- - - - -
return:  PDF entries
-
-

- -

Parameters

- - - - - - -
string  $scope  account type (user, group, host)
-
[ Top ]


-
-
- -

getConfigOptions [line 302]

-
-
-
- array getConfigOptions( -array $scopes) -
-

- - Returns a hash array (module name => elements) of all module options for the configuration page.



-

Tags:

-
- - - - -
return:  configuration options
-
-

- -

Parameters

- - - - - - -
array  $scopes  hash array (module name => array(account types))
-
[ Top ]


-
-
- -

getHelp [line 339]

-
-
-
- array getHelp( -string $module, string $helpID, [ $scope = '']) -
-

- - Returns a help entry from an account module.



-

Tags:

-
- - - - -
return:  help entry
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $helpID  help identifier
string  $module  module name
  $scope  
-
[ Top ]


-
-
- -

getModuleAlias [line 65]

-
-
-
- string getModuleAlias( -string $name, string $scope) -
-

- - Returns the alias name of a module



-

Tags:

-
- - - - -
return:  alias name
-
-

- -

Parameters

- - - - - - - - - - - -
string  $name  the module name
string  $scope  the account type ("user", "group", "host")
-
[ Top ]


-
-
- -

getModulesDependencies [line 170]

-
-
-
- array getModulesDependencies( -string $scope) -
-

- - Returns a hash array (module name => dependencies) of all module dependencies

"dependencies" contains an array with two sub arrays: depends, conflicts
The elements of "depends" are either module names or an array of module names (OR-case).
The elements of conflicts are module names.




-

Tags:

-
- - - - -
return:  dependencies
-
-

- -

Parameters

- - - - - - -
string  $scope  the account type (user, group, host)
-
[ Top ]


-
-
- -

getProfileOptions [line 268]

-
-
-
- array getProfileOptions( -string $scope) -
-

- - Returns the elements for the profile page.



-

Tags:

-
- - - - -
return:  profile elements
-
-

- -

Parameters

- - - - - - -
string  $scope  account type (user, group, host)
-
[ Top ]


-
-
- -

getRDNAttributes [line 120]

-
-
-
- array getRDNAttributes( -string $scope) -
-

- - Returns a list of LDAP attributes which can be used to form the RDN.

The list is already sorted by the priority given by the nodules.




-

Tags:

-
- - - - -
return:  list of LDAP attributes
-
-

- -

Parameters

- - - - - - -
string  $scope  account type (user, group, host)
-
[ Top ]


-
-
- -

getRequiredExtensions [line 512]

-
-
-
- array getRequiredExtensions( -) -
-

- - Returns true if the module is a base module



-

Tags:

-
- - - - -
return:  required extensions
-
-

- -
[ Top ]


-
-
- -

getUploadColumns [line 376]

-
-
-
- array getUploadColumns( -string $scope) -
-

- - Returns an array containing all input columns for the file upload.

Syntax:
array(
string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
string: description, // short descriptive name
string: help, // help ID
string: example, // example value
boolean: required // true, if user must set a value for this column
)




-

Tags:

-
- - - - -
return:  column list
-
-

- -

Parameters

- - - - - - -
string  $scope  account type
-
[ Top ]


-
-
- -

get_ldap_filter [line 88]

-
-
-
- string get_ldap_filter( -string $scope) -
-

- - Returns the LDAP filter used by the account lists



-

Tags:

-
- - - - -
return:  LDAP filter
-
-

- -

Parameters

- - - - - - -
string  $scope  the account type ("user", "group", "host")
-
[ Top ]


-
-
- -

is_base_module [line 77]

-
-
-
- boolean is_base_module( -string $name, string $scope) -
-

- - Returns true if the module is a base module



-

Tags:

-
- - - - -
return:  true if base module
-
-

- -

Parameters

- - - - - - - - - - - -
string  $name  the module name
string  $scope  the account type ("user", "group", "host")
-
[ Top ]


-
-
- -

parseHtml [line 674]

-
-
-
- array parseHtml( -string $module, array $input, array $values, boolean $restricted, &$tabindex, &$tabindexLink, string $scope, integer $tabindex, integer $tabindexLink) -
-

- - Takes a list of meta-HTML elements and prints the equivalent HTML output.

The modules are not allowed to display HTML code directly but return meta HTML code. This allows to have a common design for all module pages.

Meta HTML code is always returned as a three dimensional array[a][b][c] where a is the row number, b is the column number and c is is a data element.

Format of data elements:

A data element is an array which contains the data to display.
All data elements must contail a value "kind" which defines what kind of element should be displayed.

These are the possibilies for kind and what other options have to be added to the array:

  • fieldset: Inserts a fieldset. -
    • legend: The legend of the fieldset.
    • value: A data element. Can be used recursively.
  • help: Adds a help link. -
    • value: The help number for the help entry.
    • scope: The account type for the help entry.
  • input: Adds a HTML input element. -
    • name: The name of the element, will be used later as variable name - when user input is returned.
    • type: allowed values: submit, reset, checkbox, text, password, file, hidden
    • checked: Boolean value, if true a checkbox will be checked. This - value is only needed or checkboxes.
    • disabled: Boolean value, if true the element will be disabled.
    • size: The length of the input element, only used for text, password and file.
    • maxlength: The maximum size of the input element, only used for - text, password and file.
    • value: The element will have this value as default. Button elements will have - this as caption.
  • select: This will add a select field. -
    • name: The name of the element, will be used later as variable name when user input is - returned.
    • multiple: Boolean value, if set to true the user can select more than one entry.
    • options: Array of string. This is the list of option values the user can select.
    • options_selected: Array of string. This is the list of pre selected elements, must contain - values that are also in options.
    • descriptiveOptions: - Boolean value, if set to true then all elements in options must be arrays themselves (array(value, -description)) (default: false)
    • size: The size of the select field, if set to 1 a dropdown box will be displayed.
    • noSorting: If set to true then the entries will not be sorted. Default is false.
    • onchange: onchange event
  • table: Adds a table. Can be used recursively. -
    • value: A data element. Can be used recursively.
  • text: Inserts a text element. -
    • text: The text to display.
  • textarea: Adds a multiline text field. -
    • name: The name of the element, will be used later as variable name when user - input is returned.
    • rows: Number of rows (required)
    • cols: Number of characters for each line (required)
    • readonly: Boolean value, if true the text field will be read only.
  • image: Displays an image. -
    • path: Path to the image
    • width: Width of the image
    • height: Height of the image
    • alt: Alt text of the image

Beneath those values a "td" value may be added. This has to be an array with one or more of these options:

  • colspan: Like the HTML colspan attribute for td elements
  • rowspan: Like the HTML rowspan attribute for td elements
  • align: left/center/right/justify Like the HTML align attribute
  • valign: top/middle/bottom Like the HTML valign attribute
  • width: Like the HTML height attribute for td elements

Input buttons which should load a different subpage of a module must have a special name attribute:

name => 'form_subpage_' . <module name> . '_' . <subpage name> . '_' . <button name>
  • <module name>: name of this account module (e.g. 'posixAccount')
  • <subpage name>: name of next subpage (e.g. 'attributes')
  • <button name>: a name to distinguish buttons (e.g. 'ok'/'cancel'/'back')


Example:
  1.  array(
  2. -
  3.   array(
  4. -
  5.     array("kind" => "text""text" => "This is an example""td" => array("colspan" => 3))
  6. -
  7.   ),
  8. -
  9.   array(
  10. -
  11.     array("kind" => "text""text" => "Input:"),
  12. -
  13.     array("kind" => "input""name" => "myinput""type" => "text"),
  14. -
  15.     array("kind" => "help""value" => "42")
  16. -
  17.   ),
  18. -
  19.   array(
  20. -
  21.     array("kind" => "input""name" => 'form_subpage_myModule_attributes_back'"value" => _("Back"))
  22. -
  23.   )
  24. -
  25. )
  26. -




-

Tags:

-
- - - - -
return:  List of input field names and their type (name => type)
-
-

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string  $module  Name of account module
array  $input  List of meta-HTML elements
array  $values  List of values which override the defaults in $input (name => value)
boolean  $restricted  If true then no buttons will be displayed
integer  $tabindex  Start value of tabulator index for input fields
integer  $tabindexLink  Start value of tabulator index for links
string  $scope  Account type
  &$tabindex  
  &$tabindexLink  
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:41 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/_templates---account---edit.php.html b/lam-web/developers/devel/phpdoc/modules/_templates---account---edit.php.html deleted file mode 100644 index 0d1d52a6..00000000 --- a/lam-web/developers/devel/phpdoc/modules/_templates---account---edit.php.html +++ /dev/null @@ -1,164 +0,0 @@ - - -Docs for page edit.php - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: edit.php

-Source Location: /templates/account/edit.php

- -
-
- - -

Page Details:

-Displays the account detail page.



-

Tags:

-
- - - - -
author:  Tilo Lutz
-
-

-

Includes:

-
-include_once('../../lib/config.inc') [line 36]
-configuration options

include_once("../../lib/security.inc") [line 34]
-security functions

include_once('../../lib/profiles.inc') [line 38]
-functions to load and save profiles

include_once('../../lib/status.inc') [line 40]
-Return error-message

include_once('../../lib/modules.inc') [line 44]
-module functions

include_once('../../lib/pdf.inc') [line 42]
-Return a pdf-file

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/modules/account.html b/lam-web/developers/devel/phpdoc/modules/account.html deleted file mode 100644 index 7cdceb9a..00000000 --- a/lam-web/developers/devel/phpdoc/modules/account.html +++ /dev/null @@ -1,813 +0,0 @@ - - -Docs For Class account - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: account

-Source Location: /lib/modules/account.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --account

-
Manages the object class "account" for users and hosts.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages the object class "account" for users and hosts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 253]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 215]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method getButtonStatus [line 157]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- - Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

-
[ Top ]
-
-
- -

method get_metaData [line 48]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 238]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 134]

-
-
-
- void load_Messages( -) -
-

- - This function fills the message array.



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method module_complete [line 146]

-
-
-
- boolean module_complete( -) -
-

- - This functions returns true if all needed settings are done.



-

Tags:

-
- - - - -
return:  true if LDAP operation can be done
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method process_attributes [line 196]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method save_attributes [line 179]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/accountContainer.html b/lam-web/developers/devel/phpdoc/modules/accountContainer.html deleted file mode 100644 index c5de113d..00000000 --- a/lam-web/developers/devel/phpdoc/modules/accountContainer.html +++ /dev/null @@ -1,761 +0,0 @@ - - -Docs For Class accountContainer - - - - - - - - - - - - - -
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 918]

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

- -

-

$isNewAccount =

-

[line 933]

- True if this is a newly created account

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

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

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

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

-
-
-
- array getAccountModules( -) -
-

- - Returns the included account modules.



-

Tags:

-
- - - - -
return:  modules
-
-

- - -
[ Top ]
-
-
- -

method getParentDN [line 1826]

-
-
-
- String getParentDN( -String -$dn) -
-

- - Returns the parent DN of a given DN.



-

Tags:

-
- - - - -
return:  DN
-
-

- - -

Parameters:

-
- - - - - - -
String  $dn  DN
-

-
[ Top ]
-
-
- -

method getRDN [line 1814]

-
-
-
- String getRDN( -String -$dn) -
-

- - Returns the RDN part of a given DN.



-

Tags:

-
- - - - -
return:  RDN
-
-

- - -

Parameters:

-
- - - - - - -
String  $dn  DN
-

-
[ Top ]
-
-
- -

method get_pdfEntries [line 1738]

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

-
-
-
- string get_type( -) -
-

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



-

Tags:

-
- - - - -
return:  account type
-
-

- - -
[ Top ]
-
-
- -

method load_account [line 1430]

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

-
-
-
- void new_account( -) -
-

- - This function will prepare the object for a new account.



- - -
[ Top ]
-
-
- -

method save_account [line 1592]

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

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

-
-
-
- void sortModules( -) -
-

- - Sorts the module buttons for the account page.



- - -
[ Top ]
-
-
- -

method __sleep [line 1837]

-
-
-
- array __sleep( -) -
-

- - Encrypts sensitive data before storing in session.



-

Tags:

-
- - - - -
return:  list of attributes which are serialized
-
-

- - -
[ Top ]
-
-
- -

method __wakeup [line 1849]

-
-
-
- void __wakeup( -) -
-

- - Decrypts sensitive data after accountContainer was loaded from session.



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:42 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/baseModule.html b/lam-web/developers/devel/phpdoc/modules/baseModule.html deleted file mode 100644 index 8b7d9ae7..00000000 --- a/lam-web/developers/devel/phpdoc/modules/baseModule.html +++ /dev/null @@ -1,2912 +0,0 @@ - - -Docs For Class baseModule - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: baseModule

-Source Location: /lib/baseModule.inc

- - - - - - - - - - -
- -

Class Overview

-

-
Parent class of all account modules.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
account
-
Manages the object class "account" for users and hosts.
-
-
-
ieee802Device
-
Provides MAC addresses for hosts.
-
-
-
inetLocalMailRecipient
-
Provides mail routing for users.
-
-
-
inetOrgPerson
-
This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
-
-
-
kolabUser
-
Manages Kolab user accounts.
-
-
-
ldapPublicKey
-
Manages SSH public keys.
-
-
-
nisMailAlias
-
Provides NIS mail alias management.
-
-
-
posixAccount
-
Manages the object class "posixAccount" for users and hosts.
-
-
-
posixGroup
-
Manages the object class "posixGroup" for groups.
-
-
-
quota
-
Manages quotas for users and groups.
-
-
-
sambaAccount
-
Manages the object class "sambaAccount" for users and hosts.
-
-
-
sambaDomain
-
Manages Samba 3 domain entries.
-
-
-
sambaGroupMapping
-
Manages the object class "sambaGroupMapping" for groups.
-
-
-
sambaSamAccount
-
Manages the object class "sambaSamAccount" for users and hosts.
-
-
-
shadowAccount
-
Manages the object class "shadowAccount" for users.
-
-
-
-
- - -

Class Details

-
-[line 53]
-Parent class of all account modules.

It implements the complete module interface and uses meta-data provided by the account modules for its functions.

Location and naming of modules
All LAM modules are placed in lib/modules/ and are named "<class name>.inc". E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc". The class name of a module must contain only a-z, A-Z, 0-9, -, and _.

You can avoid to override many functions by using get_metaData().

All module classes should extend the baseModule class.




-

Tags:

-
- - - - - - - -
author:  Roland Gruber
abstract:  
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$attributes =

-

[line 71]

- contains all ldap attributes which should be written



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$autoAddObjectClasses =

-

[line 80]

- if true, managed object classes are added when an account is created or loaded (default: true)



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$messages =

-

[line 77]

- contains all error messages of a module



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$meta =

-

[line 56]

- includes all meta data provided by the sub class



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$moduleSettings =

-

[line 62]

- configuration settings of all modules



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$orig =

-

[line 74]

- contains all ldap attributes which are loaded from ldap



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$selfServiceSettings =

-

[line 65]

- self service settings of all modules



-

Tags:

-
- - - - -
access:  protected
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 87]

-
-
-
- baseModule __construct( -string -$scope) -
-

- - Creates a new base module class



-

Tags:

-
- - - - -
access:  public
-
-

- -

Overridden in child classes as:
-

-
kolabUser::__construct()
-
Creates a new kolabUser object.
-
-
-
sambaAccount::__construct()
-
Creates a new sambaAccount object.
-
-
-
sambaGroupMapping::__construct()
-
Creates a new module for Samba 3 groups.
-
-
-
sambaSamAccount::__construct()
-
Creates a new sambaSamAccount object.
-
-

- -

Parameters:

-
- - - - - - -
string  $scope  the account type (user, group, host)
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 854]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP accounts are built.

Calling this method does not require the existence of an enclosing accountContainer.

Returns an array which contains subarrays to generate StatusMessages if any errors occured.




-

Tags:

-
- - - - - - - -
return:  list of error messages if any
access:  public
-
-

- -

Overridden in child classes as:
-

-
account::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
ieee802Device::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
inetLocalMailRecipient::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
inetOrgPerson::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
kolabUser::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
ldapPublicKey::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
nisMailAlias::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
posixAccount::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
posixGroup::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
sambaAccount::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
sambaDomain::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
sambaGroupMapping::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
sambaSamAccount::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-
-
shadowAccount::build_uploadAccounts()
-
In this function the LDAP account is built up.
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  the user input data, contains one subarray for each account.
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method can_manage [line 397]

-
-
-
- boolean can_manage( -) -
-

- - Returns true if this module can manage accounts of the current type, otherwise false.

Calling this method does not require the existence of an enclosing accountContainer.




-

Tags:

-
- - - - - - - - - - -
return:  true if module fits
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method checkSelfServiceOptions [line 1216]

-
-
-
- array checkSelfServiceOptions( -string -$fields, array -$attributes) -
-

- - Checks if all input values are correct and returns the LDAP attributes which should be changed.

Calling this method does not require the existence of an enclosing accountContainer.




-

Tags:

-
- - - - - - - -
return:  messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array()))
access:  public
-
-

- -

Overridden in child classes as:
-

-
inetOrgPerson::checkSelfServiceOptions()
-
Checks if all input values are correct and returns the LDAP commands which should be executed.
-
-
-
posixAccount::checkSelfServiceOptions()
-
Checks if all input values are correct and returns the LDAP commands which should be executed.
-
-
-
sambaSamAccount::checkSelfServiceOptions()
-
Checks if all input values are correct and returns the LDAP commands which should be executed.
-
-

- -

Parameters:

-
- - - - - - - - - - - -
string  $fields  input fields
array  $attributes  LDAP attributes
-

-
[ Top ]
-
-
- -

method checkSelfServiceSettings [line 1252]

-
-
-
- array checkSelfServiceSettings( -array -$options) -
-

- - Checks if the self service settings are valid.

Calling this method does not require the existence of an enclosing accountContainer.

If the input data is invalid the return value is an array that contains arrays to build StatusMessages (message type, message head, message text). If no errors occured the function returns an empty array.




-

Tags:

-
- - - - - - - -
return:  error messages
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
array  $options  hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.
-

-
[ Top ]
-
-
- -

method check_configOptions [line 670]

-
-
-
- array check_configOptions( -array -$scopes, array -$options) -
-

- - Checks input values of module settings.

Calling this method does not require the existence of an enclosing accountContainer.

If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text').
If no errors occured the function returns an empty array.




-

Tags:

-
- - - - - - - - - - -
return:  list of error messages
see:  baseModule::get_metaData()
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::check_configOptions()
-
Checks input values of module settings.
-
-

- -

Parameters:

-
- - - - - - - - - - - -
array  $scopes  list of account types which are used
array  $options  hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.
-

-
[ Top ]
-
-
- -

method check_profileOptions [line 536]

-
-
-
- array check_profileOptions( -array -$options) -
-

- - Checks input values of account profiles.

Calling this method does not require the existence of an enclosing accountContainer.

$options is an hash array (option name => value) that contains the user input. The option values are all arrays containing one or more elements.
If the input data is invalid the return value is an array that contains arrays to build StatusMessages (message type, message head, message text). If no errors occured the function returns an empty array.




-

Tags:

-
- - - - - - - - - - -
return:  list of error messages (array(type, title, text)) to generate StatusMessages, if any
see:  baseModule::get_metaData()
access:  public
-
-

- -

Overridden in child classes as:
-

-
quota::check_profileOptions()
-
Checks input values of account profiles.
-
-

- -

Parameters:

-
- - - - - - -
array  $options  a hash array (name => value) containing the user input
-

-
[ Top ]
-
-
- -

method delete_attributes [line 1054]

-
-
-
- List delete_attributes( -) -
-

- - This function returns an array with the same syntax as save_attributes().

Calling this method requires the existence of an enclosing accountContainer.

It allows additional LDAP changes when an account is deleted.




-

Tags:

-
- - - - - - - -
return:  of LDAP operations, same as for save_attributes()
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::delete_attributes()
-
Additional LDAP operations on delete.
-
-
-
posixGroup::delete_attributes()
-
Checks if the group which should be deleted is still used as primary group.
-
-

- -
[ Top ]
-
-
- -

method display_html_attributes [line 1095]

-
-
-
- meta display_html_attributes( -) -
-

- - This function creates meta HTML code to display the module page.

Calling this method requires the existence of an enclosing accountContainer.




-

Tags:

-
- - - - - - - - - - - - - -
return:  HTML
see:  parseHtml()
abstract:  
access:  public
-
-

- -

Overridden in child classes as:
-

-
account::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
ieee802Device::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
inetLocalMailRecipient::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
inetOrgPerson::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
kolabUser::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
ldapPublicKey::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
nisMailAlias::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
posixAccount::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
posixGroup::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
quota::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
sambaAccount::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
sambaDomain::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
sambaGroupMapping::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
sambaSamAccount::display_html_attributes()
-
Returns the HTML meta data for the main account page.
-
-
-
shadowAccount::display_html_attributes()
-
This function will create the meta HTML code to show a page with all attributes.
-
-

- -
[ Top ]
-
-
- -

method display_html_delete [line 1069]

-
-
-
- meta display_html_delete( -) -
-

- - This function creates meta HTML code which will be displayed when an account should be deleted.

Calling this method requires the existence of an enclosing accountContainer.

This can be used to interact with the user, e.g. should the home directory be deleted? The output of all modules is displayed on a single page.




-

Tags:

-
- - - - - - - - - - -
return:  HTML code
see:  parseHtml()
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::display_html_delete()
-
Displays the delete homedir option for the delete page.
-
-

- -
[ Top ]
-
-
- -

method doUploadPostActions [line 967]

-
-
-
- array doUploadPostActions( -array -$data, array -$ids, array -$failed, -&$temp, array -$temp) -
-

- - This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).

Calling this method does not require the existence of an enclosing accountContainer.

This function is called as long as the returned status is 'finished'. Please make sure that one function call lasts no longer than 3-4 seconds. Otherwise the upload may fail because the time limit is exceeded. You should not make more than one LDAP operation in each call.




-

Tags:

-
- - - - - - - -
return:  current status
array (
'status' => 'finished' | 'inProgress' // defines if all operations are complete
'progress' => 0..100 // the progress of the operations in percent
'errors' => array // list of arrays which are used to generate StatusMessages
)
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::doUploadPostActions()
-
This function executes one post upload action.
-
-
-
quota::doUploadPostActions()
-
This function executes one post upload action.
-
-

- -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
array  $data  array containing one account in each element
array  $ids  maps the column names to keys for the sub arrays (array(<column_name> => <column number>))
array  $failed  list of account numbers which could not be successfully uploaded to LDAP
array  $temp  variable to store temporary data between two post actions
  &$temp  
-

-
[ Top ]
-
-
- -

method getAccountContainer [line 1264]

-
-
-
- accountContainer getAccountContainer( -) -
-

- - Returns the accountContainer object.



-

Tags:

-
- - - - - - - - - - -
return:  accountContainer object
see:  accountContainer
access:  protected
-
-

- - -
[ Top ]
-
-
- -

method getAttributes [line 1278]

-
-
-
- array getAttributes( -) -
-

- - Returns the LDAP attributes which are managed in this module.



-

Tags:

-
- - - - - - - -
return:  attributes
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getButtonStatus [line 942]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.

Calling this method requires the existence of an enclosing accountContainer.

Possible return values:

  • enabled: button is visible and active
  • disabled: button is visible and deactivated (greyed)
  • hidden: no button will be shown




-

Tags:

-
- - - - - - - -
return:  status ("enabled", "disabled", "hidden")
access:  public
-
-

- -

Overridden in child classes as:
-

-
account::getButtonStatus()
-
Controls if the module button the account page is visible and activated.
-
-
-
inetOrgPerson::getButtonStatus()
-
Controls if the module button the account page is visible and activated.
-
-
-
nisMailAlias::getButtonStatus()
-
Controls if the module button the account page is visible and activated.
-
-
-
posixGroup::getButtonStatus()
-
Controls if the module button the account page is visible and activated.
-
-

- -
[ Top ]
-
-
- -

method getIcon [line 1300]

-
-
-
- unknown getIcon( -) -
-

- - Returns the path to the module icon.

The path must be releative to graphics (e.g. key.png). You can also set $this->meta['icon']. The preferred size is 32x32px.




-

Tags:

-
- - - - - - - -
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getLDAPAliases [line 1126]

-
-
-
- array getLDAPAliases( -) -
-

- - Returns a list of aliases for LDAP attributes.

Calling this method does not require the existence of an enclosing accountContainer.

All alias attributes will be renamed to the given attribute names.




-

Tags:

-
- - - - - - - - - - -
return:  list of aliases like array("alias name" => "attribute name")
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getManagedAttributes [line 1139]

-
-
-
- array getManagedAttributes( -) -
-

- - Returns a list of LDAP attributes which are managed by this module.

All attribute names will be renamed to match the given spelling.




-

Tags:

-
- - - - - - - - - - -
return:  list of attributes
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getManagedObjectClasses [line 1110]

-
-
-
- array getManagedObjectClasses( -) -
-

- - Returns a list of managed object classes for this module.

Calling this method does not require the existence of an enclosing accountContainer.

This is used to fix spelling errors in LDAP-Entries (e.g. if "posixACCOUNT" is read instead of "posixAccount" from LDAP).

Example: return array('posixAccount')




-

Tags:

-
- - - - - - - - - - -
return:  list of object classes
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getOriginalAttributes [line 1287]

-
-
-
- array getOriginalAttributes( -) -
-

- - Returns the LDAP attributes which are managed in this module (with unchanged values).



-

Tags:

-
- - - - - - - -
return:  attributes
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getRequiredExtensions [line 1153]

-
-
-
- array getRequiredExtensions( -) -
-

- - This function returns a list of PHP extensions (e.g. mhash) which are needed by this module.

Calling this method does not require the existence of an enclosing accountContainer.




-

Tags:

-
- - - - - - - - - - -
return:  extensions
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getSelfServiceFields [line 1183]

-
-
-
- array getSelfServiceFields( -) -
-

- - Returns a list of possible input fields and their descriptions.

Calling this method does not require the existence of an enclosing accountContainer.

Format: array(<field identifier> => <field description>)




-

Tags:

-
- - - - - - - - - - -
return:  fields
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getSelfServiceOptions [line 1202]

-
-
-
- array getSelfServiceOptions( -array -$fields, array -$attributes) -
-

- - Returns the meta HTML code for each input field.

Calling this method does not require the existence of an enclosing accountContainer.

Format: array(<field1> => array(<META HTML>), ...)
It is not possible to display help links.




-

Tags:

-
- - - - - - - - - - -
return:  meta HTML
see:  parseHtml()
access:  public
-
-

- -

Overridden in child classes as:
-

-
inetOrgPerson::getSelfServiceOptions()
-
Returns the meta HTML code for each input field.
-
-
-
posixAccount::getSelfServiceOptions()
-
Returns the meta HTML code for each input field.
-
-

- -

Parameters:

-
- - - - - - - - - - - -
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)
-

-
[ Top ]
-
-
- -

method getSelfServiceSearchAttributes [line 1167]

-
-
-
- array getSelfServiceSearchAttributes( -) -
-

- - This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.

Calling this method does not require the existence of an enclosing accountContainer.




-

Tags:

-
- - - - - - - - - - -
return:  attributes
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getSelfServiceSettings [line 1235]

-
-
-
- array getSelfServiceSettings( -) -
-

- - Returns a list of self service configuration settings.

Calling this method does not require the existence of an enclosing accountContainer.

The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save settings. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.




-

Tags:

-
- - - - - - - - - - - - - -
return:  meta HTML code
see:  baseModule::get_metaData()
see:  parseHtml()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_alias [line 452]

-
-
-
- string get_alias( -) -
-

- - Returns an alias name for the module.

Calling this method does not require the existence of an enclosing accountContainer.

This function returns a more descriptive string than the class name. Alias names are used for the buttons on the account pages and the module selection in the configuration wizard.
Please take care that your alias name is not too long. It may contain any character but should not include parts that may be interpreted by the browser (e.g. '<' or '>'). If you use different aliases dependent on the account type please make sure that there is a general alias for unknown types.




-

Tags:

-
- - - - - - - - - - -
return:  alias name
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_configOptions [line 647]

-
-
-
- array get_configOptions( -array -$scopes, array -$allScopes) -
-

- - Returns a list of configuration options.

Calling this method does not require the existence of an enclosing accountContainer.

The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save settings. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.




-

Tags:

-
- - - - - - - - - - - - - -
return:  meta HTML code
see:  baseModule::get_metaData()
see:  parseHtml()
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixGroup::get_configOptions()
-
Returns a list of elements for the configuration.
-
-

- -

Parameters:

-
- - - - - - - - - - - -
array  $scopes  account types (user, group, host)
array  $allScopes  list of all active account modules and their scopes (module => array(scopes))
-

-
[ Top ]
-
-
- -

method get_dependencies [line 495]

-
-
-
- array get_dependencies( -) -
-

- - This function returns a list with all depending and conflicting modules.

Calling this method does not require the existence of an enclosing accountContainer.

The return value is an array with two sub arrays, "depends" and "conflicts". All values of the conflict array are string values with module names. All values of the depends array are either string values with module names or arrays which include only string values with module names.
If an element of the depends array is itself an array, this means that your module depends on one of these modules.

Example: return array("depends" => array("posixAccount", array("qmail", "sendmail")), "conflicts" => array("exim"))




-

Tags:

-
- - - - - - - - - - -
return:  list of dependencies and conflicts
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_help [line 884]

-
-
-
- array get_help( -string -$id) -
-

- - This function returns the help entry array for a specific help id.

Calling this method does not require the existence of an enclosing accountContainer.

The result is an hashtable with the following keys:

  • Headline (required)
    - The headline of this help entry. Can consist of any alpha-numeric characters. No HTML/CSS elements are allowed.
  • Text (required)
    - The text of the help entry which may contain any alpha-numeric characters.
  • SeeAlso (optional)
    - A reference to anonther related web site. It must be an array containing a field called "text" with the link text - that should be displayed and a field called "link" which is the link target.

Example:

array('Headline' => 'This is the head line', 'Text' => 'Help content', 'SeeAlso' => array('text' => 'LAM homepage', 'link' => 'http://lam.sf.net'))




-

Tags:

-
- - - - - - - - - - -
return:  The desired help entry.
see:  baseModule::get_metaData()
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $id  The id string for the help entry needed.
-

-
[ Top ]
-
-
- -

method get_ldap_filter [line 434]

-
-
-
- string get_ldap_filter( -) -
-

- - Returns an LDAP filter for the account lists

Calling this method does not require the existence of an enclosing accountContainer.

Returns an array('or' => '...', 'and' => '...') that is used to build the LDAP filter. Usually, this is used to filter object classes. All "or" filter parts of the base modules are combined with OR and then combined with the "and" parts.
The resulting LDAP filter will look like this: (&(|(OR1)(OR2)(OR3))(AND1)(AND2)(AND3))

Example: return array('or' => '(objectClass=posixAccount)', 'and' => '(!(uid=*$))')




-

Tags:

-
- - - - - - - - - - -
return:  LDAP filter
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 375]

-
-
-
- array get_metaData( -) -
-

- - This function provides meta data which is interpreted by baseModule.

Only subclasses will return real data.

The aim of the meta data is to reduce the number of functions in the subclasses. All major data is centralized in one place.

The returned array contains a list of key-value pairs for the different functions.

  • can_manage()
    -
    - Key: account_types
    - Value: array of account types
    -
    - Example: "account_types" => array("user", "host") -

  • is_base_module()
    -
    - Key: is_base
    - Value: boolean
    -
    - Example: "is_base" => true -

  • get_ldap_filter()
    -
    - Key: ldap_filter
    - Value: array of filters
    -
    - Example: "ldap_filter" => array('or' => 'objectClass=posixAccount', 'and' => '(!(uid=*$))') -

  • getManagedObjectClasses()
    -
    - Key: objectClasses
    - Value: array of object classes
    -
    - Example: "objectClasses" => array('posixAccount') -

  • getLDAPAliases()
    -
    - Key: LDAPaliases
    - Value: array of aliases
    -
    - Example: "LDAPaliases" => array('commonName' => 'cn') -

  • get_RDNAttributes()
    -
    - Key: RDN
    - Value: array of RDNs
    -
    - Example: "RDN" => array('uid' => 'normal', 'cn' => 'low') -

  • get_dependencies()
    -
    - Key: dependencies
    - Value: array of dependencies
    -
    - Example: "dependencies" => array("depends" => array("posixAccount", array("qmail", "sendmail")), "conflicts" => array("exim")) -

  • get_profileOptions()
    -
    - Key: profile_options
    - Value: array of profile options
    -
    - The syntax for the value array is the same as for the return value of get_profileOptions(). -

  • check_profileOptions()
    -
    - Key: profile_checks
    - Value: array of checks (array("optionName" => array()))
    -
    - The "optionName" keys of the value array are the names of the option identifiers.
    - Each array element is an array itself containing these values: -
    • type: determines how to check input
      - Possible values: -
      • regex: check with regular expression from regex variable, case sensitive
      • regex_i: check with regular expression from regex variable, case insensitive
      • int_greater: integer value of cmp_name1 must be greater than the integer value from the option cmp_name2
      • int_greaterOrEqual: integer value of cmp_name1 must be greater or equal than the integer value from the option cmp_name2
    • error_message: message that is displayed if input value was syntactically incorrect
      - error_message is an array to build StatusMessages (message type, message head, message text, additional variables)
    • regex: regular expression string (only if type is regex/regex_i)
    • cmp_name1: name of first input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)
    • cmp_name2: name of second input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)
    • required: true or false, if this input field must be filled set to true (optional)
    • required_message: message that is displayed if no input value was given (only if required == true)
      - required_message is an array to build StatusMessages (message type, message head, message text, additional variables)
    -

  • load_profile()
    -
    - Key: profile_mappings
    - Value: array('profile_identifier1' => 'LDAP_attribute1', 'profile_identifier2' => 'LDAP_attribute2')
    -
    - The mapped values are stored directly in $this->attributes. -
    - Example: "profile_mappings" => array('inetOrgPerson_title' => 'title') -

  • get_configOptions()
    -
    - Key: config_options
    - Value: array('user' => array, 'host' => array, 'all' => array)
    -
    - The values from 'all' are always returned, the other values only if they are inside the $scopes array.
    - The syntax for sub arrays is the same as for the return value of get_configOptions(). -

  • check_configOptions()
    -
    - Key: config_checks
    - Value: array('user' => array, 'host' => 'array', 'all' => array)
    -
    - The values from 'all' are always used for checking, the other values only if they are inside the $scopes array. - The syntax for sub arrays is the same as for check_configOptions(). -

  • get_uploadColumns()
    -
    - Key: upload_columns
    - Value: array
    -
    - The syntax for array is the same as for the return value of get_uploadColumns(). -

  • get_uploadPreDepends()
    -
    - Key: upload_preDepends
    - Value: array
    -
    - The syntax for array is the same as for the return value of get_uploadPreDepends(). -

  • getRequiredExtensions()
    -
    - Key: extensions
    - Value: array of extension names
    -
    - Example: "extensions" => array('mhash') -

  • get_help()
    -
    - Key: help
    - Value: hashtable of help entries
    -
    - The hashtable is an array which maps help IDs to help entries.
    -
    - Example: 'help' => array('myEntry' => array('Headline' => 'This is the head line', 'Text' => 'Help content')) -

  • getSelfServiceSearchAttributes()
    -
    - Key: selfServiceSearchAttributes
    - Value: array of attribute names
    -
    - Example: "selfServiceSearchAttributes" => array('uid') -

  • getSelfServiceFields()
    -
    - Key: selfServiceFieldSettings
    - Value: array of self service fields
    -
    - Example: "selfServiceFieldSettings" => array('pwd' => 'Password') -

Example: return array("is_base" => true);




-

Tags:

-
- - - - - - - -
return:  meta data
access:  public
-
-

- -

Overridden in child classes as:
-

-
account::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
ieee802Device::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
inetLocalMailRecipient::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
inetOrgPerson::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
kolabUser::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
ldapPublicKey::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
nisMailAlias::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
posixAccount::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
posixGroup::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
quota::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
sambaAccount::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
sambaDomain::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
sambaGroupMapping::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
sambaSamAccount::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-
-
shadowAccount::get_metaData()
-
Returns meta data that is interpreted by parent class
-
-

- -
[ Top ]
-
-
- -

method get_pdfFields [line 794]

-
-
-
- array get_pdfFields( -string -$scope) -
-

- - Returns a hashtable with all entries that may be printed out in the PDF.

Calling this method does not require the existence of an enclosing accountContainer.

This method must be overwritten in case that there are non static values to be returned. The $this->meta['PDF_fields'] array may be used for static content.

Format of returned hashtable:

This function uses XML formatted commands to define the PDF output. Each part in the PDF document is surrounded by "<block>" and "</block>".
Inside the <block> tags there are different ways to format the output:

  • simple line with attribute name and value: <block><key>attribute name</key><value>attribute value</value></block>
  • table: <block><key>attribute name</key><tr><td>value<td><td>value<td></tr></block><block><tr><td>value</td><td>value<td></tr></block>
Special commands:
  • Alignment in <td>: You can specify the alignment in <td> tags with align=(L|R|C) (e.g. <td align=\"L\">)
  • Cell width: <td> allows an attribute "width" to set the cell width (e.g. <td width=20%> or <td width=30>).
  • Line breaks: Line breaks can be specified by adding a <br> tag. The new line will start at the left border of the PDF document.

Examples:

Simple name+value lines:

In most cases you will just want to display a single line per attribute with its name and value.

'myAttribute' => '<block><key>AttrName</key><value>12345</value></block>'

This will give the following PDF output:

Attribute name: 12345


Multiline values:

Sometimes you have multivalued attributes where it is not applicable to write all values in one line but where you want to list your values one below the other or show a table. This can be done by using the <td> tag.

This example only uses one column but you can just use more <td> tags per <block> tag to display more columns.

'myAttribute' => '<block><key>AttrName</key><tr><td align=\"L\">123</td></tr></block><block><tr><td align=\"L\">456</td></tr></block><block><tr><td align=\"L\">789</td></tr></block>'




-

Tags:

-
- - - - - - - - - - -
return:  PDF entries
see:  baseModule::get_metaData()
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method get_profileOptions [line 515]

-
-
-
- array get_profileOptions( -) -
-

- - This function defines what attributes will be used in the account profiles and their appearance in the profile editor.

Calling this method does not require the existence of an enclosing accountContainer.

The return value is an array that contains meta HTML code.
The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save profiles. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.




-

Tags:

-
- - - - - - - - - - - - - -
return:  meta HTML code
see:  baseModule::get_metaData()
see:  parseHtml()
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::get_profileOptions()
-
Returns a list of elements for the account profiles.
-
-
-
quota::get_profileOptions()
-
Returns a list of elements for the account profiles.
-
-
-
sambaGroupMapping::get_profileOptions()
-
Returns a list of elements for the account profiles.
-
-
-
sambaSamAccount::get_profileOptions()
-
Returns a list of elements for the account profiles.
-
-

- -
[ Top ]
-
-
- -

method get_RDNAttributes [line 472]

-
-
-
- array get_RDNAttributes( -) -
-

- - Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).

Calling this method does not require the existence of an enclosing accountContainer.

The returned elements have this form: <attribute> => <priority>
<attribute> is the name of the LDAP attribute
<priority> defines the priority of the attribute (can be "low", "normal", "high")

Example: return array('uid' => 'normal', 'cn' => 'low')




-

Tags:

-
- - - - - - - - - - -
return:  list of attributes
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_scope [line 384]

-
-
-
- string get_scope( -) -
-

- - Returns the account type of this module (user, group, host)



-

Tags:

-
- - - - - - - -
return:  account type
access:  public
-
-

- - -
[ Top ]
-
-
- -

method get_uploadColumns [line 821]

-
-
-
- array get_uploadColumns( -) -
-

- - Returns an array containing all input columns for the file upload.

Calling this method does not require the existence of an enclosing accountContainer.

This funtion returns an array which contains subarrays which represent an upload column. Syntax of column arrays:

array(
string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
string: description, // short descriptive name
string: help, // help ID
string: example, // example value
string: values, // possible input values (optional)
string: default, // default value (optional)
boolean: required // true, if user must set a value for this column
boolean: unique // true if all values of this column must be different values (optional, default: "false")
)




-

Tags:

-
- - - - - - - - - - -
return:  column list
see:  baseModule::get_metaData()
access:  public
-
-

- -

Overridden in child classes as:
-

-
quota::get_uploadColumns()
-
Returns an array containing all input columns for the file upload.
-
-

- -
[ Top ]
-
-
- -

method get_uploadPreDepends [line 837]

-
-
-
- array get_uploadPreDepends( -) -
-

- - Returns a list of module names which must be processed in building the account befor this module.

Calling this method does not require the existence of an enclosing accountContainer.

The named modules may not be active, LAM will check this automatically.




-

Tags:

-
- - - - - - - - - - -
return:  list of module names
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method init [line 112]

-
-
-
- void init( -string -$base) -
-

- - Initializes the module after it became part of an accountContainer

Calling this method requires the existence of an enclosing accountContainer.




-

Tags:

-
- - - - -
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::init()
-
Initializes the module after it became part of an accountContainer
-
-
-
posixGroup::init()
-
This functin will be called when the module will be loaded *
-
-
-
sambaAccount::init()
-
Initializes the module after it became part of an accountContainer
-
-
-
sambaGroupMapping::init()
-
Initializes the module after it became part of an accountContainer
-
-
-
sambaSamAccount::init()
-
Initializes the module after it became part of an accountContainer
-
-

- -

Parameters:

-
- - - - - - -
string  $base  the name of the accountContainer object ($_SESSION[$base])
-

-
[ Top ]
-
-
- -

method is_base_module [line 414]

-
-
-
- boolean is_base_module( -) -
-

- - Returns true if your module is a base module and otherwise false.

Calling this method does not require the existence of an enclosing accountContainer.

Every account type needs exactly one base module. A base module manages a structural object class. E.g. the inetOrgPerson module is a base module since its object class is structural.




-

Tags:

-
- - - - - - - - - - -
return:  true if base module (defaults to false if no meta data is provided)
see:  baseModule::get_metaData()
access:  public
-
-

- - -
[ Top ]
-
-
- -

method load_attributes [line 140]

-
-
-
- void load_attributes( -array -$attributes) -
-

- - This function loads the LDAP attributes when an account should be loaded.

Calling this method requires the existence of an enclosing accountContainer.

By default this method loads the object classes and accounts which are specified in getManagedObjectClasses() and getManagedAttributes().




-

Tags:

-
- - - - -
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::load_attributes()
-
This function loads all needed LDAP attributes.
-
-
-
sambaAccount::load_attributes()
-
This function loads the LDAP attributes for this module.
-
-
-
sambaSamAccount::load_attributes()
-
This function loads the LDAP attributes for this module.
-
-

- -

Parameters:

-
- - - - - - -
array  $attributes  array like the array returned by get_ldap_attributes(dn of account) but without count indices
-

-
[ Top ]
-
-
- -

method load_Messages [line 102]

-
-
-
- void load_Messages( -) -
-

- - This function fills the $messages variable with output messages from this module.

Calling this method requires the existence of an enclosing accountContainer.




-

Tags:

-
- - - - -
access:  protected
-
-

- -

Overridden in child classes as:
-

-
account::load_Messages()
-
This function fills the message array.
-
-
-
ieee802Device::load_Messages()
-
This function fills the error message array with messages
-
-
-
inetLocalMailRecipient::load_Messages()
-
This function fills the error message array with messages
-
-
-
inetOrgPerson::load_Messages()
-
This function fills the message array.
-
-
-
kolabUser::load_Messages()
-
This function fills the error message array with messages
-
-
-
nisMailAlias::load_Messages()
-
This function fills the error message array with messages
-
-
-
posixAccount::load_Messages()
-
This function fills the error message array with messages.
-
-
-
posixGroup::load_Messages()
-
This function fills the $messages variable with output messages from this module.
-
-
-
quota::load_Messages()
-
this functin fills the error message array with messages
-
-
-
sambaAccount::load_Messages()
-
this functin fills the error message array with messages
-
-
-
sambaDomain::load_Messages()
-
This function fills the error message array with messages
-
-
-
sambaGroupMapping::load_Messages()
-
this functin fills the error message array with messages
-
-
-
sambaSamAccount::load_Messages()
-
this functin fills the error message array with messages
-
-
-
shadowAccount::load_Messages()
-
This function builds up the message array.
-
-

- -
[ Top ]
-
-
- -

method load_profile [line 621]

-
-
-
- void load_profile( -array -$profile) -
-

- - This function loads the values from an account profile to the module's internal data structures.

Calling this method does not require the existence of an enclosing accountContainer.




-

Tags:

-
- - - - - - - -
see:  baseModule::get_metaData()
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::load_profile()
-
Loads the values of an account profile into internal variables.
-
-
-
quota::load_profile()
-
Loads the values of an account profile into internal variables.
-
-
-
sambaAccount::load_profile()
-
Loads the values of an account profile into internal variables.
-
-
-
sambaGroupMapping::load_profile()
-
Loads the values of an account profile into internal variables.
-
-
-
sambaSamAccount::load_profile()
-
Loads the values of an account profile into internal variables.
-
-
-
shadowAccount::load_profile()
-
Loads the values of an account profile into internal variables.
-
-

- -

Parameters:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_complete [line 924]

-
-
-
- boolean module_complete( -) -
-

- - This functions is used to check if all settings for this module have been made.

Calling this method requires the existence of an enclosing accountContainer.

This function tells LAM if it can create/modify the LDAP account. If your module needs any additional input then set this to false. The user will be notified that your module needs more input.
This method's return value defaults to true.




-

Tags:

-
- - - - - - - -
return:  true, if settings are complete
access:  public
-
-

- -

Overridden in child classes as:
-

-
account::module_complete()
-
This functions returns true if all needed settings are done.
-
-
-
inetOrgPerson::module_complete()
-
This functions return true if all needed settings are done.
-
-
-
kolabUser::module_complete()
-
This function returns true if all needed settings are done.
-
-
-
posixAccount::module_complete()
-
This functions is used to check if all settings for this module have been made.
-
-
-
posixGroup::module_complete()
-
This functions is used to check if all settings for this module have been made.
-
-
-
sambaAccount::module_complete()
-
This functions returns true if all needed settings are done
-
-

- -
[ Top ]
-
-
- -

method module_ready [line 908]

-
-
-
- boolean module_ready( -) -
-

- - This function is used to check if this module page can be displayed.

Calling this method requires the existence of an enclosing accountContainer.

Your module might depend on input of other modules. This function determines if the user can change to your module page or not. The return value is true if your module accepts input, otherwise false.
This method's return value defaults to true.




-

Tags:

-
- - - - - - - -
return:  true, if page can be displayed
access:  public
-
-

- -

Overridden in child classes as:
-

-
quota::module_ready()
-
This function is used to check if this module page can be displayed.
-
-
-
sambaAccount::module_ready()
-
This function is used to check if this module page can be displayed.
-
-
-
sambaGroupMapping::module_ready()
-
This function is used to check if this module page can be displayed.
-
-
-
sambaSamAccount::module_ready()
-
This function is used to check if this module page can be displayed.
-
-

- -
[ Top ]
-
-
- -

method postDeleteActions [line 1041]

-
-
-
- void postDeleteActions( -) -
-

- - Allows the module to run commands after the LDAP entry is deleted.

Calling this method requires the existence of an enclosing accountContainer.




-

Tags:

-
- - - - -
access:  public
-
-

- - -
[ Top ]
-
-
- -

method postModifyActions [line 1019]

-
-
-
- void postModifyActions( -boolean -$newAccount) -
-

- - Allows the module to run commands after the LDAP entry is changed or created.

Calling this method requires the existence of an enclosing accountContainer.




-

Tags:

-
- - - - -
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::postModifyActions()
-
Allows the module to run commands after the LDAP entry was changed or created.
-
-
-
quota::postModifyActions()
-
Allows the module to run commands after the LDAP entry is changed or created.
-
-

- -

Parameters:

-
- - - - - - -
boolean  $newAccount  new account
-

-
[ Top ]
-
-
- -

method preDeleteActions [line 1032]

-
-
-
- true, preDeleteActions( -) -
-

- - Allows the module to run commands before the LDAP entry is deleted.

Calling this method requires the existence of an enclosing accountContainer.

An error message should be printed if the function returns false.




-

Tags:

-
- - - - - - - -
return:  if no problems occured
access:  public
-
-

- -

Overridden in child classes as:
-

-
posixAccount::preDeleteActions()
-
Allows the module to run commands before the LDAP entry is deleted.
-
-
-
quota::preDeleteActions()
-
Allows the module to run commands before the LDAP entry is deleted.
-
-

- -
[ Top ]
-
-
- -

method preModifyActions [line 1008]

-
-
-
- true, preModifyActions( -boolean -$newAccount) -
-

- - Allows the module to run commands before the LDAP entry is changed or created.

Calling this method requires the existence of an enclosing accountContainer.

An error message should be printed if the function returns false.




-

Tags:

-
- - - - - - - -
return:  if no problems occured
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
boolean  $newAccount  new account
-

-
[ Top ]
-
-
- -

method process_attributes [line 1084]

-
-
-
- array process_attributes( -) -
-

- - This function processes user input.

Calling this method requires the existence of an enclosing accountContainer.

It checks the user input and saves changes in the module's data structures.

Example: return array(array('ERROR', 'Invalid input!', 'This is not allowed here.'));




-

Tags:

-
- - - - - - - - - - -
return:  Array which contains status messages. Each entry is an array containing the status message parameters.
abstract:  
access:  public
-
-

- -

Overridden in child classes as:
-

-
account::process_attributes()
-
Processes user input of the primary module page.
-
-
-
ieee802Device::process_attributes()
-
Processes user input of the primary module page.
-
-
-
inetLocalMailRecipient::process_attributes()
-
Processes user input of the primary module page.
-
-
-
inetOrgPerson::process_attributes()
-
Processes user input of the primary module page.
-
-
-
kolabUser::process_attributes()
-
Processes user input of the primary module page.
-
-
-
ldapPublicKey::process_attributes()
-
Processes user input of the primary module page.
-
-
-
nisMailAlias::process_attributes()
-
Processes user input of the primary module page.
-
-
-
posixAccount::process_attributes()
-
Processes user input of the primary module page.
-
-
-
posixGroup::process_attributes()
-
Processes user input of the primary module page.
-
-
-
quota::process_attributes()
-
Processes user input of the primary module page.
-
-
-
sambaAccount::process_attributes()
-
Processes user input of the primary module page.
-
-
-
sambaDomain::process_attributes()
-
Processes user input of the primary module page.
-
-
-
sambaGroupMapping::process_attributes()
-
Processes user input of the primary module page.
-
-
-
sambaSamAccount::process_attributes()
-
Processes user input of the primary module page.
-
-
-
shadowAccount::process_attributes()
-
Processes user input of the primary module page.
-
-

- -
[ Top ]
-
-
- -

method save_attributes [line 994]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.

Calling this method requires the existence of an enclosing accountContainer.


This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It is possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)

"add" are attributes which have to be added to the LDAP entry
"remove" are attributes which have to be removed from the LDAP entry
"modify" are attributes which have to be modified in the LDAP entry
"notchanged" are attributes which stay unchanged

This builds the required comands from $this-attributes and $this->orig.




-

Tags:

-
- - - - - - - -
return:  list of modifications
access:  public
-
-

- -

Overridden in child classes as:
-

-
account::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
inetOrgPerson::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
kolabUser::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
nisMailAlias::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
posixAccount::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
posixGroup::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
sambaAccount::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
sambaGroupMapping::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
sambaSamAccount::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-
-
shadowAccount::save_attributes()
-
Returns a list of modifications which have to be made to the LDAP account.
-
-

- -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:18 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/ieee802Device.html b/lam-web/developers/devel/phpdoc/modules/ieee802Device.html deleted file mode 100644 index 8597307c..00000000 --- a/lam-web/developers/devel/phpdoc/modules/ieee802Device.html +++ /dev/null @@ -1,735 +0,0 @@ - - -Docs For Class ieee802Device - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: ieee802Device

-Source Location: /lib/modules/ieee802device.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --ieee802Device

-
Provides MAC addresses for hosts.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Provides MAC addresses for hosts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 165]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 97]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method get_metaData [line 44]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 194]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 87]

-
-
-
- void load_Messages( -) -
-

- - This function fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method process_attributes [line 123]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/inetLocalMailRecipient.html b/lam-web/developers/devel/phpdoc/modules/inetLocalMailRecipient.html deleted file mode 100644 index 99bba353..00000000 --- a/lam-web/developers/devel/phpdoc/modules/inetLocalMailRecipient.html +++ /dev/null @@ -1,735 +0,0 @@ - - -Docs For Class inetLocalMailRecipient - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: inetLocalMailRecipient

-Source Location: /lib/modules/inetLocalMailRecipient.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --inetLocalMailRecipient

-
Provides mail routing for users.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Provides mail routing for users.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 257]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 137]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method get_metaData [line 44]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 310]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 123]

-
-
-
- void load_Messages( -) -
-

- - This function fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method process_attributes [line 179]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:33 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/inetOrgPerson.html b/lam-web/developers/devel/phpdoc/modules/inetOrgPerson.html deleted file mode 100644 index ab6a4bb4..00000000 --- a/lam-web/developers/devel/phpdoc/modules/inetOrgPerson.html +++ /dev/null @@ -1,985 +0,0 @@ - - -Docs For Class inetOrgPerson - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: inetOrgPerson

-Source Location: /lib/modules/inetOrgPerson.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --inetOrgPerson

-
This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 38]
-This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 970]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method checkSelfServiceOptions [line 1353]

-
-
-
- array checkSelfServiceOptions( -string -$fields, array -$attributes) -
-

- - Checks if all input values are correct and returns the LDAP commands which should be executed.



-

Tags:

-
- - - - -
return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))
-
-

- - Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP attributes which should be changed.)

-

Parameters:

-
- - - - - - - - - - - -
string  $fields  input fields
array  $attributes  LDAP attributes
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 639]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method display_html_password [line 879]

-
-
-
- array display_html_password( -) -
-

- - Displays the password changing dialog.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_photo [line 919]

-
-
-
- array display_html_photo( -) -
-

- - Displays the photo upload page.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method getButtonStatus [line 465]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- - Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

-
[ Top ]
-
-
- -

method getSelfServiceOptions [line 1212]

-
-
-
- array getSelfServiceOptions( -array -$fields, array -$attributes) -
-

- - Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.




-

Tags:

-
- - - - -
return:  meta HTML
-
-

- - Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)

-

Parameters:

-
- - - - - - - - - - - -
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)
-

-
[ Top ]
-
-
- -

method get_metaData [line 118]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 938]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 70]

-
-
-
- void load_Messages( -) -
-

- - This function fills the message array.



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method module_complete [line 448]

-
-
-
- boolean module_complete( -) -
-

- - This functions return true if all needed settings are done.



-

Tags:

-
- - - - -
return:  true, if all is ok
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method process_attributes [line 525]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method process_password [line 857]

-
-
-
- void process_password( -) -
-

- - Sets a new password.



- - -
[ Top ]
-
-
- -

method process_photo [line 899]

-
-
-
- void process_photo( -) -
-

- - Sets a new photo.



- - -
[ Top ]
-
-
- -

method save_attributes [line 487]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:34 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/kolabUser.html b/lam-web/developers/devel/phpdoc/modules/kolabUser.html deleted file mode 100644 index b2930b04..00000000 --- a/lam-web/developers/devel/phpdoc/modules/kolabUser.html +++ /dev/null @@ -1,849 +0,0 @@ - - -Docs For Class kolabUser - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: kolabUser

-Source Location: /lib/modules/kolabUser.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --kolabUser

-
Manages Kolab user accounts.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Manages Kolab user accounts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 45]

-
-
-
- kolabUser __construct( -string -$scope) -
-

- - Creates a new kolabUser object.



- - Overrides baseModule::__construct() (Creates a new base module class)

-

Parameters:

-
- - - - - - -
string  $scope  account type (user, group, host)
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 614]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 268]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method display_html_deleteUser [line 564]

-
-
-
- void display_html_deleteUser( -) -
-

- - This function will create the meta HTML code to show a page to delete accounts.



- - -
[ Top ]
-
-
- -

method get_metaData [line 65]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 752]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 227]

-
-
-
- void load_Messages( -) -
-

- - This function fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method module_complete [line 591]

-
-
-
- true, module_complete( -) -
-

- - This function returns true if all needed settings are done.



-

Tags:

-
- - - - -
return:  if account can be saved
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method process_attributes [line 420]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method process_deleteUser [line 579]

-
-
-
- void process_deleteUser( -) -
-

- - Write variables into object and do some regex checks



- - -
[ Top ]
-
-
- -

method save_attributes [line 255]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:35 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/ldapPublicKey.html b/lam-web/developers/devel/phpdoc/modules/ldapPublicKey.html deleted file mode 100644 index 80dba872..00000000 --- a/lam-web/developers/devel/phpdoc/modules/ldapPublicKey.html +++ /dev/null @@ -1,709 +0,0 @@ - - -Docs For Class ldapPublicKey - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: ldapPublicKey

-Source Location: /lib/modules/ldapPublicKey.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --ldapPublicKey

-
Manages SSH public keys.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 36]
-Manages SSH public keys.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 144]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 91]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method get_metaData [line 45]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 164]

-
-
-
- void get_pdfEntries( -) -
-

- - Returns a list of PDF entries



- - -
[ Top ]
-
-
- -

method process_attributes [line 117]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:37 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/nisMailAlias.html b/lam-web/developers/devel/phpdoc/modules/nisMailAlias.html deleted file mode 100644 index 20b0ffc0..00000000 --- a/lam-web/developers/devel/phpdoc/modules/nisMailAlias.html +++ /dev/null @@ -1,787 +0,0 @@ - - -Docs For Class nisMailAlias - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: nisMailAlias

-Source Location: /lib/modules/nisMailAlias.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --nisMailAlias

-
Provides NIS mail alias management.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Provides NIS mail alias management.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 234]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 135]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method getButtonStatus [line 215]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- - Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

-
[ Top ]
-
-
- -

method get_metaData [line 44]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 273]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 104]

-
-
-
- void load_Messages( -) -
-

- - This function fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method process_attributes [line 166]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method save_attributes [line 122]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:42 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/posixAccount.html b/lam-web/developers/devel/phpdoc/modules/posixAccount.html deleted file mode 100644 index fc4980a8..00000000 --- a/lam-web/developers/devel/phpdoc/modules/posixAccount.html +++ /dev/null @@ -1,1412 +0,0 @@ - - -Docs For Class posixAccount - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: posixAccount

-Source Location: /lib/modules/posixAccount.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --posixAccount

-
Manages the object class "posixAccount" for users and hosts.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 40]
-Manages the object class "posixAccount" for users and hosts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 1273]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method checkASCII [line 857]

-
-
-
- string checkASCII( -string -$attribute) -
-

- - Checks if an attribute contains only ASCII charaters and replaces invalid characters.



-

Tags:

-
- - - - -
return:  attribute value with replaced non-ASCII characters
-
-

- - -

Parameters:

-
- - - - - - -
string  $attribute  attribute value
-

-
[ Top ]
-
-
- -

method checkSelfServiceOptions [line 1720]

-
-
-
- array checkSelfServiceOptions( -string -$fields, array -$attributes) -
-

- - Checks if all input values are correct and returns the LDAP commands which should be executed.



-

Tags:

-
- - - - -
return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))
-
-

- - Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP attributes which should be changed.)

-

Parameters:

-
- - - - - - - - - - - -
string  $fields  input fields
array  $attributes  LDAP attributes
-

-
[ Top ]
-
-
- -

method check_configOptions [line 1214]

-
-
-
- array check_configOptions( -array -$scopes, array -$options) -
-

- - Checks input values of module settings.



-

Tags:

-
- - - - -
return:  list of error messages
-
-

- - Overrides baseModule::check_configOptions() (Checks input values of module settings.)

-

Parameters:

-
- - - - - - - - - - - -
array  $scopes  list of account types which are used
array  $options  hash array containing the settings (array('option' => array('value')))
-

-
[ Top ]
-
-
- -

method delete_attributes [line 578]

-
-
-
- List delete_attributes( -) -
-

- - Additional LDAP operations on delete.



-

Tags:

-
- - - - -
return:  of LDAP operations, same as for save_attributes()
-
-

- - Overrides baseModule::delete_attributes() (This function returns an array with the same syntax as save_attributes().)

-
[ Top ]
-
-
- -

method display_html_attributes [line 928]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method display_html_delete [line 1034]

-
-
-
- meta display_html_delete( -) -
-

- - Displays the delete homedir option for the delete page.



-

Tags:

-
- - - - -
return:  HTML code
-
-

- - Overrides baseModule::display_html_delete() (This function creates meta HTML code which will be displayed when an account should be deleted.)

-
[ Top ]
-
-
- -

method display_html_group [line 1049]

-
-
-
- array display_html_group( -) -
-

- - Displays the group selection.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_password [line 1094]

-
-
-
- array display_html_password( -) -
-

- - Displays the password changing dialog.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method doUploadPostActions [line 1525]

-
-
-
- array doUploadPostActions( -array -$data, array -$ids, array -$failed, -&$temp, array -$temp) -
-

- - This function executes one post upload action.



-

Tags:

-
- - - - -
return:  current status
array (
'status' => 'finished' | 'inProgress'
'progress' => 0..100
'errors' => array (<array of parameters for StatusMessage>)
)
-
-

- - Overrides baseModule::doUploadPostActions() (This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
array  $temp  variable to store temporary data between two post actions
  &$temp  
-

-
[ Top ]
-
-
- -

method getClearTextPassword [line 1749]

-
-
-
- string getClearTextPassword( -) -
-

- - Returns the clear text password.



-

Tags:

-
- - - - - - - -
return:  password
access:  public
-
-

- - -
[ Top ]
-
-
- -

method getNextUIDs [line 1634]

-
-
-
- mixed getNextUIDs( -integer -$count, -&$errors, array -$errors) -
-

- - Returns one or more free UID numbers.



-

Tags:

-
- - - - -
return:  Null if no UIDs are free else an array of free UIDs.
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
integer  $count  Number of needed free UIDs.
array  $errors  list of error messages where errors can be added
  &$errors  
-

-
[ Top ]
-
-
- -

method getSelfServiceOptions [line 1700]

-
-
-
- array getSelfServiceOptions( -array -$fields, array -$attributes) -
-

- - Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.




-

Tags:

-
- - - - -
return:  meta HTML
-
-

- - Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)

-

Parameters:

-
- - - - - - - - - - - -
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)
-

-
[ Top ]
-
-
- -

method get_metaData [line 104]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 1189]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method get_profileOptions [line 1125]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- - Overrides baseModule::get_profileOptions() (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)

-
[ Top ]
-
-
- -

method init [line 432]

-
-
-
- void init( -string -$base) -
-

- - Initializes the module after it became part of an accountContainer



- - Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

-

Parameters:

-
- - - - - - -
string  $base  the name of the accountContainer object ($_SESSION[$base])
-

-
[ Top ]
-
-
- -

method load_attributes [line 464]

-
-
-
- void load_attributes( -array -$attr) -
-

- - This function loads all needed LDAP attributes.



- - Overrides baseModule::load_attributes() (This function loads the LDAP attributes when an account should be loaded.)

-

Parameters:

-
- - - - - - -
array  $attr  list of attributes
-

-
[ Top ]
-
-
- -

method load_Messages [line 54]

-
-
-
- void load_Messages( -) -
-

- - This function fills the error message array with messages.



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method load_profile [line 1167]

-
-
-
- void load_profile( -array -$profile) -
-

- - Loads the values of an account profile into internal variables.



- - Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.)

-

Parameters:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_complete [line 450]

-
-
-
- boolean module_complete( -) -
-

- - This functions is used to check if all settings for this module have been made.



-

Tags:

-
- - - - -
return:  true, if settings are complete
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method postModifyActions [line 540]

-
-
-
- void postModifyActions( -boolean -$newAccount) -
-

- - Allows the module to run commands after the LDAP entry was changed or created.



- - Overrides baseModule::postModifyActions() (Allows the module to run commands after the LDAP entry is changed or created.)

-

Parameters:

-
- - - - - - -
boolean  $newAccount  new account
-

-
[ Top ]
-
-
- -

method preDeleteActions [line 596]

-
-
-
- true, preDeleteActions( -) -
-

- - Allows the module to run commands before the LDAP entry is deleted.

An error message should be printed if the function returns false.




-

Tags:

-
- - - - -
return:  if no problems occured
-
-

- - Overrides baseModule::preDeleteActions() (Allows the module to run commands before the LDAP entry is deleted.)

-
[ Top ]
-
-
- -

method process_attributes [line 630]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method process_group [line 882]

-
-
-
- array process_group( -) -
-

- - Processes user input of the group selection page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method process_password [line 899]

-
-
-
- array process_password( -) -
-

- - Processes user input of the password page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 491]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:44 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/posixGroup.html b/lam-web/developers/devel/phpdoc/modules/posixGroup.html deleted file mode 100644 index 0851f356..00000000 --- a/lam-web/developers/devel/phpdoc/modules/posixGroup.html +++ /dev/null @@ -1,1063 +0,0 @@ - - -Docs For Class posixGroup - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: posixGroup

-Source Location: /lib/modules/posixGroup.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --posixGroup

-
Manages the object class "posixGroup" for groups.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages the object class "posixGroup" for groups.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 53]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method delete_attributes [line 130]

-
-
-
- List delete_attributes( -) -
-

- - Checks if the group which should be deleted is still used as primary group.



-

Tags:

-
- - - - -
return:  of LDAP operations, same as for save_attributes()
-
-

- - Overrides baseModule::delete_attributes() (This function returns an array with the same syntax as save_attributes().)

-
[ Top ]
-
-
- -

method display_html_attributes [line 154]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - - - - -
return:  HTML meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method display_html_password [line 257]

-
-
-
- array display_html_password( -) -
-

- - Displays the password changing dialog.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_user [line 210]

-
-
-
- array display_html_user( -) -
-

- - Displays selections to add or remove users from current group.



-

Tags:

-
- - - - -
return:  meta HTML output
-
-

- - -
[ Top ]
-
-
- -

method getButtonStatus [line 505]

-
-
-
- string getButtonStatus( -) -
-

- - Controls if the module button the account page is visible and activated.



-

Tags:

-
- - - - -
return:  status ("enabled", "disabled", "hidden")
-
-

- - Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)

-
[ Top ]
-
-
- -

method getNextGIDs [line 724]

-
-
-
- mixed getNextGIDs( -integer -$count, -&$errors, array -$errors) -
-

- - Returns one or more free GID numbers.



-

Tags:

-
- - - - -
return:  Null if no GIDs are free else an array of free GIDs.
-
-

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
integer  $count  Number of needed free GIDs.
array  $errors  list of error messages where errors can be added
  &$errors  
-

-
[ Top ]
-
-
- -

method get_configOptions [line 420]

-
-
-
- array get_configOptions( -array -$scopes, array -$allScopes) -
-

- - Returns a list of elements for the configuration.



-

Tags:

-
- - - - -
return:  configuration elements
-
-

- - Overrides baseModule::get_configOptions() (Returns a list of configuration options.)

-

Parameters:

-
- - - - - - - - - - - -
array  $scopes  account types (user, group, host)
array  $allScopes  list of all modules and active scopes
-

-
[ Top ]
-
-
- -

method get_metaData [line 279]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - -
return:  array with meta data
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 441]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method init [line 451]

-
-
-
- void init( - -$base) -
-

- - This functin will be called when the module will be loaded *



- - Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

-

Parameters:

-
- - - - - - -
  $base  
-

-
[ Top ]
-
-
- -

method load_Messages [line 461]

-
-
-
- void load_Messages( -) -
-

- - This function fills the $messages variable with output messages from this module.



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method module_complete [line 486]

-
-
-
- boolean module_complete( -) -
-

- - This functions is used to check if all settings for this module have been made.



-

Tags:

-
- - - - -
return:  true, if settings are complete
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method process_attributes [line 523]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method process_password [line 669]

-
-
-
- array process_password( -) -
-

- - Processes user input of the password page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method process_user [line 650]

-
-
-
- array process_user( -) -
-

- - Processes user input of the user selection page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 694]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:45 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/quota.html b/lam-web/developers/devel/phpdoc/modules/quota.html deleted file mode 100644 index 51e8d1ea..00000000 --- a/lam-web/developers/devel/phpdoc/modules/quota.html +++ /dev/null @@ -1,992 +0,0 @@ - - -Docs For Class quota - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: quota

-Source Location: /lib/modules/quota.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --quota

-
Manages quotas for users and groups.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages quotas for users and groups.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method check_profileOptions [line 477]

-
-
-
- array check_profileOptions( -array -$options) -
-

- - Checks input values of account profiles.



-

Tags:

-
- - - - -
return:  list of error messages (array(type, title, text)) to generate StatusMessages, if any
-
-

- - Overrides baseModule::check_profileOptions() (Checks input values of account profiles.)

-

Parameters:

-
- - - - - - -
array  $options  a hash array (name => value) containing the options
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 337]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method doUploadPostActions [line 631]

-
-
-
- array doUploadPostActions( -array -$data, array -$ids, array -$failed, -&$temp, array -$temp) -
-

- - This function executes one post upload action.



-

Tags:

-
- - - - -
return:  current status
array (
'status' => 'finished' | 'inProgress'
'progress' => 0..100
'errors' => array (<array of parameters for StatusMessage>)
)
-
-

- - Overrides baseModule::doUploadPostActions() (This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
array  $temp  variable to store temporary data between two post actions
  &$temp  
-

-
[ Top ]
-
-
- -

method get_metaData [line 67]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 533]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method get_profileOptions [line 420]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- - Overrides baseModule::get_profileOptions() (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)

-
[ Top ]
-
-
- -

method get_uploadColumns [line 587]

-
-
-
- array get_uploadColumns( -) -
-

- - Returns an array containing all input columns for the file upload.

Syntax:
array(
string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
string: description, // short descriptive name
string: help, // help ID
string: example, // example value
boolean: required // true, if user must set a value for this column
)




-

Tags:

-
- - - - -
return:  column list
-
-

- - Overrides baseModule::get_uploadColumns() (Returns an array containing all input columns for the file upload.)

-
[ Top ]
-
-
- -

method initQuotas [line 154]

-
-
-
- void initQuotas( -) -
-

- - Initializes the quota values.



- - -
[ Top ]
-
-
- -

method load_Messages [line 43]

-
-
-
- void load_Messages( -) -
-

- - this functin fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method load_profile [line 511]

-
-
-
- void load_profile( -array -$profile) -
-

- - Loads the values of an account profile into internal variables.



- - Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.)

-

Parameters:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_ready [line 193]

-
-
-
- boolean module_ready( -) -
-

- - This function is used to check if this module page can be displayed.

It returns false if a module depends on data from other modules which was not yet entered.




-

Tags:

-
- - - - -
return:  true, if page can be displayed
-
-

- - Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

-
[ Top ]
-
-
- -

method postModifyActions [line 210]

-
-
-
- void postModifyActions( -boolean -$newAccount) -
-

- - Allows the module to run commands after the LDAP entry is changed or created.



- - Overrides baseModule::postModifyActions() (Allows the module to run commands after the LDAP entry is changed or created.)

-

Parameters:

-
- - - - - - -
boolean  $newAccount  new account
-

-
[ Top ]
-
-
- -

method preDeleteActions [line 249]

-
-
-
- true, preDeleteActions( -) -
-

- - Allows the module to run commands before the LDAP entry is deleted.

An error message should be printed if the function returns false.




-

Tags:

-
- - - - -
return:  if no problems occured
-
-

- - Overrides baseModule::preDeleteActions() (Allows the module to run commands before the LDAP entry is deleted.)

-
[ Top ]
-
-
- -

method process_attributes [line 290]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method replaceSpecialChars [line 410]

-
-
-
- string replaceSpecialChars( -string -$input) -
-

- - Replaces special characters in HTML name values.



-

Tags:

-
- - - - -
return:  output string
-
-

- - -

Parameters:

-
- - - - - - -
string  $input  input string
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/samba3domain.html b/lam-web/developers/devel/phpdoc/modules/samba3domain.html deleted file mode 100644 index ad20a5fd..00000000 --- a/lam-web/developers/devel/phpdoc/modules/samba3domain.html +++ /dev/null @@ -1,363 +0,0 @@ - - -Docs For Class samba3domain - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: samba3domain

-Source Location: /lib/account.inc

- - - - - - - - - -
- -

Class Overview

-

-
Represents a Samba 3 domain entry


- - - - - - - -
-

Variables

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 354]
-Represents a Samba 3 domain entry



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$dn =

-

[line 357]

- DN



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$name =

-

[line 360]

- Domain name



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$nextGroupRID =

-

[line 372]

- Next group RID



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$nextRID =

-

[line 366]

- Next RID



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$nextUserRID =

-

[line 369]

- Next user RID



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$RIDbase =  1000

-

[line 375]

- RID base to calculate RIDs, default 1000



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$SID =

-

[line 363]

- Domain SID



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- - - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:16 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/sambaAccount.html b/lam-web/developers/devel/phpdoc/modules/sambaAccount.html deleted file mode 100644 index 8e6b4fff..00000000 --- a/lam-web/developers/devel/phpdoc/modules/sambaAccount.html +++ /dev/null @@ -1,992 +0,0 @@ - - -Docs For Class sambaAccount - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaAccount

-Source Location: /lib/modules/sambaAccount.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --sambaAccount

-
Manages the object class "sambaAccount" for users and hosts.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 38]
-Manages the object class "sambaAccount" for users and hosts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 45]

-
-
-
- sambaAccount __construct( -string -$scope) -
-

- - Creates a new sambaAccount object.



-

Tags:

-
- - - - -
access:  public
-
-

- - Overrides baseModule::__construct() (Creates a new base module class)

-

Parameters:

-
- - - - - - -
string  $scope  account type (user, group, host)
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 909]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 726]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method display_html_userWorkstations [line 856]

-
-
-
- array display_html_userWorkstations( -) -
-

- - This function will create the HTML page to edit the allowed workstations.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 98]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 890]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method init [line 420]

-
-
-
- void init( -string -$base) -
-

- - Initializes the module after it became part of an accountContainer



- - Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

-

Parameters:

-
- - - - - - -
string  $base  the name of the accountContainer object ($_SESSION[$base])
-

-
[ Top ]
-
-
- -

method load_attributes [line 471]

-
-
-
- void load_attributes( - -$attr, array -$attributes) -
-

- - This function loads the LDAP attributes for this module.



- - Overrides baseModule::load_attributes() (This function loads the LDAP attributes when an account should be loaded.)

-

Parameters:

-
- - - - - - - - - - - -
array  $attributes  attribute list
  $attr  
-

-
[ Top ]
-
-
- -

method load_Messages [line 59]

-
-
-
- void load_Messages( -) -
-

- - this functin fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method load_profile [line 1159]

-
-
-
- void load_profile( -array -$profile) -
-

- - Loads the values of an account profile into internal variables.



- - Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.)

-

Parameters:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_complete [line 460]

-
-
-
- boolean module_complete( -) -
-

- - This functions returns true if all needed settings are done



-

Tags:

-
- - - - -
return:  true if ready to save account
-
-

- - Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)

-
[ Top ]
-
-
- -

method module_ready [line 448]

-
-
-
- boolean module_ready( -) -
-

- - This function is used to check if this module page can be displayed.

It returns false if a module depends on data from other modules which was not yet entered.




-

Tags:

-
- - - - -
return:  true, if page can be displayed
-
-

- - Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

-
[ Top ]
-
-
- -

method process_attributes [line 526]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method process_userWorkstations [line 677]

-
-
-
- array process_userWorkstations( -) -
-

- - Processes user input of the workstation selection page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 494]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:48 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/sambaDomain.html b/lam-web/developers/devel/phpdoc/modules/sambaDomain.html deleted file mode 100644 index a6dbbf7b..00000000 --- a/lam-web/developers/devel/phpdoc/modules/sambaDomain.html +++ /dev/null @@ -1,735 +0,0 @@ - - -Docs For Class sambaDomain - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaDomain

-Source Location: /lib/modules/sambaDomain.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --sambaDomain

-
Manages Samba 3 domain entries.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 35]
-Manages Samba 3 domain entries.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 551]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 213]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method get_metaData [line 44]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 630]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 187]

-
-
-
- void load_Messages( -) -
-

- - This function fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method process_attributes [line 395]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:49 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/sambaGroupMapping.html b/lam-web/developers/devel/phpdoc/modules/sambaGroupMapping.html deleted file mode 100644 index 7c643bd3..00000000 --- a/lam-web/developers/devel/phpdoc/modules/sambaGroupMapping.html +++ /dev/null @@ -1,897 +0,0 @@ - - -Docs For Class sambaGroupMapping - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaGroupMapping

-Source Location: /lib/modules/sambaGroupMapping.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --sambaGroupMapping

-
Manages the object class "sambaGroupMapping" for groups.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages the object class "sambaGroupMapping" for groups.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 52]

-
-
-
- sambaGroupMapping __construct( -string -$scope) -
-

- - Creates a new module for Samba 3 groups.



- - Overrides baseModule::__construct() (Creates a new base module class)

-

Parameters:

-
- - - - - - -
string  $scope  account type
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 102]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 172]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method get_metaData [line 252]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 344]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method get_profileOptions [line 358]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- - Overrides baseModule::get_profileOptions() (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)

-
[ Top ]
-
-
- -

method init [line 84]

-
-
-
- void init( -string -$base) -
-

- - Initializes the module after it became part of an accountContainer



- - Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

-

Parameters:

-
- - - - - - -
string  $base  the name of the accountContainer object ($_SESSION[$base])
-

-
[ Top ]
-
-
- -

method load_Messages [line 396]

-
-
-
- void load_Messages( -) -
-

- - this functin fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method load_profile [line 381]

-
-
-
- void load_profile( -array -$profile) -
-

- - Loads the values of an account profile into internal variables.



- - Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.)

-

Parameters:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_ready [line 409]

-
-
-
- boolean module_ready( -) -
-

- - This function is used to check if this module page can be displayed.

It returns false if a module depends on data from other modules which was not yet entered.




-

Tags:

-
- - - - -
return:  true, if page can be displayed
-
-

- - Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

-
[ Top ]
-
-
- -

method process_attributes [line 422]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method save_attributes [line 482]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:50 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/sambaMungedDial.html b/lam-web/developers/devel/phpdoc/modules/sambaMungedDial.html deleted file mode 100644 index 9775745f..00000000 --- a/lam-web/developers/devel/phpdoc/modules/sambaMungedDial.html +++ /dev/null @@ -1,1138 +0,0 @@ - - -Docs For Class sambaMungedDial - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaMungedDial

-Source Location: /lib/modules/sambaSamAccount/sambaMungedDial.inc

- - - - - - - - - - -
- -

Class Overview

-

-
Manages terminal server settings for Samba 3.


-

Author(s):

-
    -
  • Cajus Pollmeier
  • -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 57]
-Manages terminal server settings for Samba 3.



-

Tags:

-
- - - - -
author:  Cajus Pollmeier
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$ctx = array(
-     'CtxCfgPresent' =>              '551e0bb0',
-     'CtxCfgFlags1' =>                '00e00010',
-     'CtxCallback' =>                '',
-     'CtxShadow' =>                   '01000000',
-     'CtxMaxConnectionTime' =>      '',
-     'CtxMaxDisconnectionTime' =>   '',
-     'CtxMaxIdleTime' =>             '',
-     'CtxKeyboardLayout' =>           '',
-     'CtxMinEncryptionLevel' =>     '00',
-     'CtxWorkDirectory' =>            '',
-     'CtxNWLogonServer' =>            '',  
-     'CtxWFHomeDir' =>                 '',
-     'CtxWFHomeDirDrive' =>          '',
-     'CtxWFProfilePath' =>            '',
-     'CtxInitialProgram' =>           '',
-     'CtxCallbackNumber' =>          '')

-

[line 60]

-

-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$ctxattributes = array("CtxCfgPresent", "CtxCfgFlags1", "CtxCallback",
-        "CtxShadow", "CtxMaxConnectionTime", "CtxMaxDisconnectionTime",
-        "CtxMaxIdleTime", "CtxKeyboardLayout", "CtxMinEncryptionLevel",
-        "CtxWorkDirectory", "CtxNWLogonServer", "CtxWFHomeDir",
-        "CtxWFHomeDirDrive", "CtxWFProfilePath", "CtxInitialProgram",
-        "CtxCallbackNumber")

-

[line 79]

-

-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

method decode_munged [line 250]

-
-
-
- void decode_munged( - -$munge) -
-

- - Takes a base64-encoded MungedDial-String and returns an array of included parameters and values



- - -

Parameters:

-
- - - - - - -
  $munge  
-

-
[ Top ]
-
-
- -

method encode_munged [line 176]

-
-
-
- void encode_munged( - -$params) -
-

- - Encode full MungedDial-String



- - -

Parameters:

-
- - - - - - -
  $params  
-

-
[ Top ]
-
-
- -

method endian [line 121]

-
-
-
- void endian( - -$src) -
-

- - endian



- - -

Parameters:

-
- - - - - - -
  $src  
-

-
[ Top ]
-
-
- -

method genTime [line 127]

-
-
-
- void genTime( - -$minutes) -
-

- - genTime



- - -

Parameters:

-
- - - - - - -
  $minutes  
-

-
[ Top ]
-
-
- -

method getBrokenConn [line 383]

-
-
-
- void getBrokenConn( -) -
-

- - gets Broken-Connection value: disconnect/reset



- - -
[ Top ]
-
-
- -

method getConnectClientDrives [line 488]

-
-
-
- void getConnectClientDrives( -) -
-

- - gets connect-client-drive-at-logon value: enabled/disabled



- - -
[ Top ]
-
-
- -

method getConnectClientPrinters [line 514]

-
-
-
- void getConnectClientPrinters( -) -
-

- - gets connect-client-printers-at-logon value: enabled/disabled



- - -
[ Top ]
-
-
- -

method getCtxMaxConnectionTimeF [line 568]

-
-
-
- void getCtxMaxConnectionTimeF( -) -
-

- - SMARTY: gets the checkbox state of "Connection"



- - -
[ Top ]
-
-
- -

method getCtxMaxDisconnectionTimeF [line 589]

-
-
-
- void getCtxMaxDisconnectionTimeF( -) -
-

- - SMARTY: gets the checkbox state of "Disconnection"



- - -
[ Top ]
-
-
- -

method getCtxMaxIdleTimeF [line 610]

-
-
-
- void getCtxMaxIdleTimeF( -) -
-

- - SMARTY: gets the checkbox state of "Idle"



- - -
[ Top ]
-
-
- -

method getDefaultPrinter [line 541]

-
-
-
- void getDefaultPrinter( -) -
-

- - gets set-client-printer-to-default value: enabled/disabled



- - -
[ Top ]
-
-
- -

method getInheritMode [line 437]

-
-
-
- void getInheritMode( -) -
-

- - gets Inherit-config-from-client value: enabled/disabled



- - -
[ Top ]
-
-
- -

method getMunged [line 311]

-
-
-
- void getMunged( -) -
-

- - Returns ready-to-run mungedDialString to be filled into ldap



- - -
[ Top ]
-
-
- -

method getOnDemandFlags [line 325]

-
-
-
- void getOnDemandFlags( -) -
-

- - Returns array of flags, which can be set on-demand with activated java-script



- - -
[ Top ]
-
-
- -

method getReConn [line 410]

-
-
-
- void getReConn( -) -
-

- - gets Reconnection value: from any client/from previous client only



- - -
[ Top ]
-
-
- -

method getShadow [line 465]

-
-
-
- void getShadow( -) -
-

- - gets shadow value (enum): 0-4



- - -
[ Top ]
-
-
- -

method getTsLogin [line 355]

-
-
-
- void getTsLogin( -) -
-

- - Gets Terminal-Server-Login value: enabled/disabled



- - -
[ Top ]
-
-
- -

method hexstr [line 109]

-
-
-
- void hexstr( - -$hex) -
-

- - hexstr



- - -

Parameters:

-
- - - - - - -
  $hex  
-

-
[ Top ]
-
-
- -

method is_samba_path [line 162]

-
-
-
- void is_samba_path( - -$path) -
-

- - Checks if this is a valid Samba path.



- - -

Parameters:

-
- - - - - - -
  $path  
-

-
[ Top ]
-
-
- -

method load [line 305]

-
-
-
- void load( - -$mungedDial) -
-

- - function takes a base64-encoded sambaMungedDial



- - -

Parameters:

-
- - - - - - -
  $mungedDial  
-

-
[ Top ]
-
-
- -

method munge [line 212]

-
-
-
- void munge( - -$paramName, -$paramValue, -$isString) -
-

- - Setup parameter given by paramName to MungedDial-Format



- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
  $paramName  
  $paramValue  
  $isString  
-

-
[ Top ]
-
-
- -

method readTime [line 135]

-
-
-
- void readTime( - -$time) -
-

- - readTime



- - -

Parameters:

-
- - - - - - -
  $time  
-

-
[ Top ]
-
-
- -

method setBrokenConn [line 396]

-
-
-
- void setBrokenConn( - -$checked) -
-

- - sets Broken-Connection value: disconnect/reset



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setConnectClientDrives [line 501]

-
-
-
- void setConnectClientDrives( - -$checked) -
-

- - sets connect-client-drive-at-logon value: enabled/disabled



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setConnectClientPrinters [line 527]

-
-
-
- void setConnectClientPrinters( - -$checked) -
-

- - sets connect-client-printers-at-logon value: enabled/disabled



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setCtxMaxConnectionTimeF [line 581]

-
-
-
- void setCtxMaxConnectionTimeF( - -$checked) -
-

- - SMARTY: sets the checkbox "Connection" to unchecked



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setCtxMaxDisconnectionTimeF [line 602]

-
-
-
- void setCtxMaxDisconnectionTimeF( - -$checked) -
-

- - SMARTY: sets the checkbox "Disconnection" to unchecked



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setCtxMaxIdleTimeF [line 623]

-
-
-
- void setCtxMaxIdleTimeF( - -$checked) -
-

- - SMARTY: sets the checkbox "Idle" to unchecked



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setDefaultPrinter [line 554]

-
-
-
- void setDefaultPrinter( - -$checked) -
-

- - sets set-client-printer-to-default value: enabled/disabled



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setInheritMode [line 449]

-
-
-
- void setInheritMode( - -$checked) -
-

- - sets Inherit-config-from-client value: enabled/disabled



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setReConn [line 423]

-
-
-
- void setReConn( - -$checked) -
-

- - sets Reconnection value: from any client/from previous client only



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method setShadow [line 476]

-
-
-
- void setShadow( - -$checked, -$value) -
-

- - sets shadow value



- - -

Parameters:

-
- - - - - - - - - - - -
  $checked  
  $value  
-

-
[ Top ]
-
-
- -

method setTsLogin [line 369]

-
-
-
- void setTsLogin( - -$checked) -
-

- - Sets Terminal-Server-Login value: enabled/disabled



- - -

Parameters:

-
- - - - - - -
  $checked  
-

-
[ Top ]
-
-
- -

method strhex [line 97]

-
-
-
- void strhex( - -$string) -
-

- - strhex



- - -

Parameters:

-
- - - - - - -
  $string  
-

-
[ Top ]
-
-
- -

method to8bit [line 147]

-
-
-
- void to8bit( - -$string) -
-

- - to8bit



- - -

Parameters:

-
- - - - - - -
  $string  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:51 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/sambaSamAccount.html b/lam-web/developers/devel/phpdoc/modules/sambaSamAccount.html deleted file mode 100644 index cceffbdf..00000000 --- a/lam-web/developers/devel/phpdoc/modules/sambaSamAccount.html +++ /dev/null @@ -1,1182 +0,0 @@ - - -Docs For Class sambaSamAccount - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: sambaSamAccount

-Source Location: /lib/modules/sambaSamAccount.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --sambaSamAccount

-
Manages the object class "sambaSamAccount" for users and hosts.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 42]
-Manages the object class "sambaSamAccount" for users and hosts.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

constructor __construct [line 66]

-
-
-
- sambaSamAccount __construct( -string -$scope) -
-

- - Creates a new sambaSamAccount object.



- - Overrides baseModule::__construct() (Creates a new base module class)

-

Parameters:

-
- - - - - - -
string  $scope  account type (user, group, host)
-

-
[ Top ]
-
-
- -

method build_uploadAccounts [line 1736]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method checkSelfServiceOptions [line 2070]

-
-
-
- array checkSelfServiceOptions( -string -$fields, array -$attributes) -
-

- - Checks if all input values are correct and returns the LDAP commands which should be executed.



-

Tags:

-
- - - - -
return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))
-
-

- - Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP attributes which should be changed.)

-

Parameters:

-
- - - - - - - - - - - -
string  $fields  input fields
array  $attributes  LDAP attributes
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 909]

-
-
-
- array display_html_attributes( -) -
-

- - Returns the HTML meta data for the main account page.



-

Tags:

-
- - - - -
return:  HTML meta data
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method display_html_logonHours [line 1183]

-
-
-
- array display_html_logonHours( -) -
-

- - This function will create the HTML page to edit logon hours.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_sambaUserWorkstations [line 1149]

-
-
-
- array display_html_sambaUserWorkstations( -) -
-

- - This function will create the HTML page to edit the allowed workstations.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_terminalServer [line 1296]

-
-
-
- array display_html_terminalServer( -) -
-

- - This function will create the HTML page to edit the terminal server options.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method display_html_time [line 1246]

-
-
-
- array display_html_time( -) -
-

- - This function will create the meta HTML code to show a page to change time values.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 120]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 1634]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method get_profileOptions [line 1417]

-
-
-
- profile get_profileOptions( -) -
-

- - Returns a list of elements for the account profiles.



-

Tags:

-
- - - - -
return:  elements
-
-

- - Overrides baseModule::get_profileOptions() (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)

-
[ Top ]
-
-
- -

method init [line 516]

-
-
-
- void init( -string -$base) -
-

- - Initializes the module after it became part of an accountContainer



- - Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)

-

Parameters:

-
- - - - - - -
string  $base  the name of the accountContainer object ($_SESSION[$base])
-

-
[ Top ]
-
-
- -

method load_attributes [line 549]

-
-
-
- void load_attributes( - -$attr, array -$attributes) -
-

- - This function loads the LDAP attributes for this module.



- - Overrides baseModule::load_attributes() (This function loads the LDAP attributes when an account should be loaded.)

-

Parameters:

-
- - - - - - - - - - - -
array  $attributes  attribute list
  $attr  
-

-
[ Top ]
-
-
- -

method load_Messages [line 79]

-
-
-
- void load_Messages( -) -
-

- - this functin fills the error message array with messages



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method load_profile [line 1542]

-
-
-
- void load_profile( -array -$profile) -
-

- - Loads the values of an account profile into internal variables.



- - Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.)

-

Parameters:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method module_ready [line 536]

-
-
-
- boolean module_ready( -) -
-

- - This function is used to check if this module page can be displayed.

It returns false if a module depends on data from other modules which was not yet entered.




-

Tags:

-
- - - - -
return:  true, if page can be displayed
-
-

- - Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)

-
[ Top ]
-
-
- -

method process_attributes [line 586]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method process_logonHours [line 810]

-
-
-
- array process_logonHours( -) -
-

- - Processes user input of the logon hours page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method process_sambaUserWorkstations [line 760]

-
-
-
- array process_sambaUserWorkstations( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method process_terminalServer [line 878]

-
-
-
- array process_terminalServer( -) -
-

- - Processes user input of the terminal server page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method process_time [line 836]

-
-
-
- array process_time( -) -
-

- - Processes user input of the time selection page.



-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 572]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:51 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/shadowAccount.html b/lam-web/developers/devel/phpdoc/modules/shadowAccount.html deleted file mode 100644 index 03284710..00000000 --- a/lam-web/developers/devel/phpdoc/modules/shadowAccount.html +++ /dev/null @@ -1,841 +0,0 @@ - - -Docs For Class shadowAccount - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: shadowAccount

-Source Location: /lib/modules/shadowAccount.inc

- - - - - - - - - -
- -

Class Overview

-
baseModule
-   |
-   --shadowAccount

-
Manages the object class "shadowAccount" for users.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

- -
-

Inherited Methods

-
-

Class: baseModule

-
-
- baseModule::__construct() -
-
- Creates a new base module class -
-
- baseModule::build_uploadAccounts() -
-
- In this function the LDAP accounts are built. -
-
- baseModule::can_manage() -
-
- Returns true if this module can manage accounts of the current type, otherwise false. -
-
- baseModule::checkSelfServiceOptions() -
-
- Checks if all input values are correct and returns the LDAP attributes which should be changed. -
-
- baseModule::checkSelfServiceSettings() -
-
- Checks if the self service settings are valid. -
-
- baseModule::check_configOptions() -
-
- Checks input values of module settings. -
-
- baseModule::check_profileOptions() -
-
- Checks input values of account profiles. -
-
- baseModule::delete_attributes() -
-
- This function returns an array with the same syntax as save_attributes(). -
-
- baseModule::display_html_attributes() -
-
- This function creates meta HTML code to display the module page. -
-
- baseModule::display_html_delete() -
-
- This function creates meta HTML code which will be displayed when an account should be deleted. -
-
- baseModule::doUploadPostActions() -
-
- This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..). -
-
- baseModule::getAccountContainer() -
-
- Returns the accountContainer object. -
-
- baseModule::getAttributes() -
-
- Returns the LDAP attributes which are managed in this module. -
-
- baseModule::getButtonStatus() -
-
- Controls if the module button the account page is visible and activated. -
-
- baseModule::getIcon() -
-
- Returns the path to the module icon. -
-
- baseModule::getLDAPAliases() -
-
- Returns a list of aliases for LDAP attributes. -
-
- baseModule::getManagedAttributes() -
-
- Returns a list of LDAP attributes which are managed by this module. -
-
- baseModule::getManagedObjectClasses() -
-
- Returns a list of managed object classes for this module. -
-
- baseModule::getOriginalAttributes() -
-
- Returns the LDAP attributes which are managed in this module (with unchanged values). -
-
- baseModule::getRequiredExtensions() -
-
- This function returns a list of PHP extensions (e.g. mhash) which are needed by this module. -
-
- baseModule::getSelfServiceFields() -
-
- Returns a list of possible input fields and their descriptions. -
-
- baseModule::getSelfServiceOptions() -
-
- Returns the meta HTML code for each input field. -
-
- baseModule::getSelfServiceSearchAttributes() -
-
- This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects. -
-
- baseModule::getSelfServiceSettings() -
-
- Returns a list of self service configuration settings. -
-
- baseModule::get_alias() -
-
- Returns an alias name for the module. -
-
- baseModule::get_configOptions() -
-
- Returns a list of configuration options. -
-
- baseModule::get_dependencies() -
-
- This function returns a list with all depending and conflicting modules. -
-
- baseModule::get_help() -
-
- This function returns the help entry array for a specific help id. -
-
- baseModule::get_ldap_filter() -
-
- Returns an LDAP filter for the account lists -
-
- baseModule::get_metaData() -
-
- This function provides meta data which is interpreted by baseModule. -
-
- baseModule::get_pdfFields() -
-
- Returns a hashtable with all entries that may be printed out in the PDF. -
-
- baseModule::get_profileOptions() -
-
- This function defines what attributes will be used in the account profiles and their appearance in the profile editor. -
-
- baseModule::get_RDNAttributes() -
-
- Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name). -
-
- baseModule::get_scope() -
-
- Returns the account type of this module (user, group, host) -
-
- baseModule::get_uploadColumns() -
-
- Returns an array containing all input columns for the file upload. -
-
- baseModule::get_uploadPreDepends() -
-
- Returns a list of module names which must be processed in building the account befor this module. -
-
- baseModule::init() -
-
- Initializes the module after it became part of an accountContainer -
-
- baseModule::is_base_module() -
-
- Returns true if your module is a base module and otherwise false. -
-
- baseModule::load_attributes() -
-
- This function loads the LDAP attributes when an account should be loaded. -
-
- baseModule::load_Messages() -
-
- This function fills the $messages variable with output messages from this module. -
-
- baseModule::load_profile() -
-
- This function loads the values from an account profile to the module's internal data structures. -
-
- baseModule::module_complete() -
-
- This functions is used to check if all settings for this module have been made. -
-
- baseModule::module_ready() -
-
- This function is used to check if this module page can be displayed. -
-
- baseModule::postDeleteActions() -
-
- Allows the module to run commands after the LDAP entry is deleted. -
-
- baseModule::postModifyActions() -
-
- Allows the module to run commands after the LDAP entry is changed or created. -
-
- baseModule::preDeleteActions() -
-
- Allows the module to run commands before the LDAP entry is deleted. -
-
- baseModule::preModifyActions() -
-
- Allows the module to run commands before the LDAP entry is changed or created. -
-
- baseModule::process_attributes() -
-
- This function processes user input. -
-
- baseModule::save_attributes() -
-
- Returns a list of modifications which have to be made to the LDAP account. -
-
-
-
-
- - -

Class Details

-
-[line 39]
-Manages the object class "shadowAccount" for users.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method build_uploadAccounts [line 379]

-
-
-
- array build_uploadAccounts( -array -$rawAccounts, array -$ids, -&$partialAccounts, array -$partialAccounts) -
-

- - In this function the LDAP account is built up.



-

Tags:

-
- - - - -
return:  list of error messages if any
-
-

- - Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)

-

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)
  &$partialAccounts  
-

-
[ Top ]
-
-
- -

method display_html_attributes [line 263]

-
-
-
- array display_html_attributes( -) -
-

- - This function will create the meta HTML code to show a page with all attributes.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)

-
[ Top ]
-
-
- -

method display_html_expire [line 329]

-
-
-
- array display_html_expire( -) -
-

- - This function will create the meta HTML code to show a page with the expiration date.



-

Tags:

-
- - - - -
return:  meta HTML code
-
-

- - -
[ Top ]
-
-
- -

method get_metaData [line 66]

-
-
-
- array get_metaData( -) -
-

- - Returns meta data that is interpreted by parent class



-

Tags:

-
- - - - - - - -
return:  array with meta data
see:  baseModule::get_metaData()
-
-

- - Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)

-
[ Top ]
-
-
- -

method get_pdfEntries [line 364]

-
-
-
- array get_pdfEntries( -) -
-

- - Returns the PDF entries for this module.



-

Tags:

-
- - - - -
return:  list of possible PDF entries
-
-

- - -
[ Top ]
-
-
- -

method load_Messages [line 44]

-
-
-
- void load_Messages( -) -
-

- - This function builds up the message array.



- - Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)

-
[ Top ]
-
-
- -

method load_profile [line 459]

-
-
-
- void load_profile( -array -$profile) -
-

- - Loads the values of an account profile into internal variables.



- - Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.)

-

Parameters:

-
- - - - - - -
array  $profile  hash array with profile values (identifier => value)
-

-
[ Top ]
-
-
- -

method process_attributes [line 243]

-
-
-
- array process_attributes( -) -
-

- - Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - Overrides baseModule::process_attributes() (This function processes user input.)

-
[ Top ]
-
-
- -

method process_expire [line 310]

-
-
-
- array process_expire( -) -
-

- - Processes user input of the expiration page.

It checks if all input values are correct and updates the associated LDAP attributes.




-

Tags:

-
- - - - -
return:  list of info/error messages
-
-

- - -
[ Top ]
-
-
- -

method save_attributes [line 225]

-
-
-
- array save_attributes( -) -
-

- - Returns a list of modifications which have to be made to the LDAP account.



-

Tags:

-
- - - - -
return:  list of modifications
This function returns an array with 3 entries:
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
"add" are attributes which have to be added to LDAP entry
"remove" are attributes which have to be removed from LDAP entry
"modify" are attributes which have to been modified in LDAP entry
-
-

- - Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:56 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/modules/smbHash.html b/lam-web/developers/devel/phpdoc/modules/smbHash.html deleted file mode 100644 index 23eaf421..00000000 --- a/lam-web/developers/devel/phpdoc/modules/smbHash.html +++ /dev/null @@ -1,309 +0,0 @@ - - -Docs For Class smbHash - - - - - - - - - - - - - -
modules
- - - [ class tree: modules ] - [ index: modules ] - [ all elements ] -
- - - - - - -
-
- -

Class: smbHash

-Source Location: /lib/createntlm.inc

- - - - - - - - - -
- -

Class Overview

-

-
Calculates NT and LM hashes.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 41]
-Calculates NT and LM hashes.

The important functions are lmhash($password) and nthash($password).




-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method doHash [line 189]

-
-
-
- array doHash( -array -$in, array -$key, boolean -$forw) -
-

- -

- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
array  $in  
array  $key  
boolean  $forw  
-

-
[ Top ]
-
-
- -

method lmhash [line 334]

-
-
-
- string lmhash( -[string -$password = ""]) -
-

- - Calculates the LM hash of a given password.



-

Tags:

-
- - - - - - - -
return:  hash value
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $password  password
-

-
[ Top ]
-
-
- -

method nthash [line 351]

-
-
-
- string nthash( -[string -$password = ""]) -
-

- - Calculates the NT hash of a given password.



-

Tags:

-
- - - - - - - -
return:  hash value
access:  public
-
-

- - -

Parameters:

-
- - - - - - -
string  $password  password
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:24 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/profiles/_lib---profiles.inc.html b/lam-web/developers/devel/phpdoc/profiles/_lib---profiles.inc.html deleted file mode 100644 index 7bee24f0..00000000 --- a/lam-web/developers/devel/phpdoc/profiles/_lib---profiles.inc.html +++ /dev/null @@ -1,245 +0,0 @@ - - -Docs for page profiles.inc - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: profiles.inc

-Source Location: /lib/profiles.inc

- -
-
- - -

Page Details:

-This file provides functions to load and save account profiles.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
-
- -

delAccountProfile [line 147]

-
-
-
- boolean delAccountProfile( -string $file, string $scope) -
-

- - Deletes an account profile



-

Tags:

-
- - - - -
return:  true if profile was deleted
-
-

- -

Parameters

- - - - - - - - - - - -
string  $file  name of profile (Without .<scope> extension)
string  $scope  account type
-
[ Top ]


-
-
- -

getAccountProfiles [line 38]

-
-
-
- array getAccountProfiles( -string $scope) -
-

- - Returns an array of string with all available profiles for the given account type



-

Tags:

-
- - - - -
return:  profile names
-
-

- -

Parameters

- - - - - - -
string  $scope  account type
-
[ Top ]


-
-
- -

loadAccountProfile [line 66]

-
-
-
- array loadAccountProfile( -string $profile, string $scope) -
-

- - Loads an profile of the given account type



-

Tags:

-
- - - - -
return:  hash array (attribute => value)
-
-

- -

Parameters

- - - - - - - - - - - -
string  $profile  name of the profile (without .<scope> extension)
string  $scope  account type
-
[ Top ]


-
-
- -

saveAccountProfile [line 110]

-
-
-
- boolean saveAccountProfile( -array $attributes, string $profile, string $scope) -
-

- - Saves an hash array (attribute => value) to an account profile

file is created, if needed




-

Tags:

-
- - - - -
return:  true, if saving succeeded
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $profile  name of the account profile (without .<scope> extension)
array  $attributes  hash array (attribute => value)
string  $scope  account type
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profiledelete.php.html b/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profiledelete.php.html deleted file mode 100644 index ff790dc4..00000000 --- a/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profiledelete.php.html +++ /dev/null @@ -1,104 +0,0 @@ - - -Docs for page profiledelete.php - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: profiledelete.php

-Source Location: /templates/profedit/profiledelete.php

- -
-
- - -

Page Details:

-Manages deletion of profiles.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 32]
-security functions

include_once("../../lib/profiles.inc") [line 34]
-helper functions for profiles

include_once("../../lib/ldap.inc") [line 36]
-access to LDAP server

include_once("../../lib/config.inc") [line 38]
-access to configuration options

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profilemain.php.html b/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profilemain.php.html deleted file mode 100644 index 2b3221d3..00000000 --- a/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profilemain.php.html +++ /dev/null @@ -1,104 +0,0 @@ - - -Docs for page profilemain.php - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: profilemain.php

-Source Location: /templates/profedit/profilemain.php

- -
-
- - -

Page Details:

-This is the main window of the profile editor.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 32]
-security functions

include_once("../../lib/profiles.inc") [line 34]
-helper functions for profiles

include_once("../../lib/ldap.inc") [line 36]
-access to LDAP server

include_once("../../lib/config.inc") [line 38]
-access to configuration options

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profilepage.php.html b/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profilepage.php.html deleted file mode 100644 index 0b686bd8..00000000 --- a/lam-web/developers/devel/phpdoc/profiles/_templates---profedit---profilepage.php.html +++ /dev/null @@ -1,106 +0,0 @@ - - -Docs for page profilepage.php - - - - - - - - - - - - - -
profiles
- - - [ class tree: profiles ] - [ index: profiles ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: profilepage.php

-Source Location: /templates/profedit/profilepage.php

- -
-
- - -

Page Details:

-Manages creating/changing of profiles.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/profiles.inc") [line 34]
-helper functions for profiles

include_once("../../lib/security.inc") [line 32]
-security functions

include_once("../../lib/ldap.inc") [line 36]
-access to LDAP server

include_once("../../lib/config.inc") [line 38]
-access to configuration options

include_once("../../lib/status.inc") [line 42]
-Used to display status messages

include_once("../../lib/modules.inc") [line 40]
-access to account modules

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:47 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/ric_INSTALL.html b/lam-web/developers/devel/phpdoc/ric_INSTALL.html deleted file mode 100644 index acbcc136..00000000 --- a/lam-web/developers/devel/phpdoc/ric_INSTALL.html +++ /dev/null @@ -1,128 +0,0 @@ - - -INSTALL - - - - - - - - - - - - - -
default
- - [ all elements ] -
- - - - - - -
-
- -

INSTALL

-
-
-Installation Instructions for LAM
----------------------------------
-
-
-1. Requirements
-
-   - Apache webserver (SSL optional) with PHP module (PHP 5 (>= 5.1) with
-     ldap, gettext, xml and optional mcrypt)
-   - some LAM plugins may require additional PHP extensions (you will get a
-     note on the login page if something is missing)
-   - Perl (optional, needed only for lamdaemon)
-   - OpenLDAP (>2.0)
-   - A web browser :-)
-
-   MHash is only needed for Samba password hashes.
-   MCrypt will be used to store your LDAP password encrypted in the session file.
-
-
-   See docs/README.schema.txt for information about used LDAP schema files.
-
-
-2. Installation
-
-   1. Extract package with:
-      tar xzf ldap-account-manager-<version>.tar.gz
-
-
-   2. Install the files
-
-   2a. Copy the files into the html-file scope of the webserver. For example
-       /apache/htdocs.
-
-       Set appropriate file permissions:
-        - lam/sess: write permission for apache user
-        - lam/tmp: write permission for apache user
-        - lam/config (with subdirectories): write permission for apache user
-        - lam/lib: lamdaemon.pl must be set executable (See also
-          docs/readme.lamdeamon.txt)
-
-   2b. You can also use the included configure script to install LAM. See
-       "./configure --help" for a list of install options.
-
-
-   3. Configure config.cfg and create a configuration profile.
-      Copy config.cfg_sample to config.cfg and set the master password and default
-      profile.
-
-      Open the index.html in your web browser:
-       - Follow the link "Configuration Login" from the start page.
-        (The default password to edit the options is "lam")
-       - Select the default lam profile or create a new profile.
-       - Change the settings to fit your environment.
-
-
-
-3. Setting up PHP
-
-   LAM runs with PHP5 (>= 5.1).
-
-   Needed changes in your php.ini:
-
-    * memory_limit = 64M
-
-
-
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/ric_README.html b/lam-web/developers/devel/phpdoc/ric_README.html deleted file mode 100644 index 620363c1..00000000 --- a/lam-web/developers/devel/phpdoc/ric_README.html +++ /dev/null @@ -1,142 +0,0 @@ - - -README - - - - - - - - - - - - - -
default
- - [ all elements ] -
- - - - - - -
-
- -

README

-
-
-LAM - Readme
-============
-
-  LDAP Account Manager (LAM) manages user, group and host accounts in an LDAP
-  directory. LAM runs on any webserver with PHP5 support and connects to your
-  LDAP server unencrypted or via SSL/TLS.
-  Currently LAM supports these account types: Samba 2 and 3, Unix, Kolab 2,
-  address book entries, NIS mail aliases and MAC addresses. There is a tree
-  viewer included to allow access to the raw LDAP attributes. You can use
-  templates for account creation and use multiple configuration profiles.
-  LAM is translated to Catalan, Chinese (Traditional + Simplified), Czech,
-  Dutch, English, French, German, Hungarian, Italian, Japanese, Portuguese,
-  Russian and Spanish.
-
-  http://sourceforge.net/projects/lam/
-
-    Copyright (C) 2003 - 2007 Michael Duergner <michael@duergner.com>
-                              Roland Gruber <post@rolandgruber.de>
-                              Tilo Lutz <tilolutz@gmx.de>
-
-  Requirements:
-    PHP5 (>= 5.1)
-    Openldap (2.0 or greater)
-    A web-browser that supports CSS
-
-  Summary:
-    With LAM you can easily manage user, group and machine accounts stored in
-    an LDAP directory over a web interface. At the moment it supports:
-
-      - managing user/group/host/domain entries
-      - filtering and sorting
-      - account profiles
-      - multiple configuration profiles
-      - tree viwer
-      - schema browser
-      - OU Editor
-      - account creation via file upload
-      - PDF export for all accounts
-      - manage user/group Quota and create home directories
-
-  Important:
-    The default password to edit the configuration options is "lam".
-
-  Installation:
-    Please see the INSTALL file.
-
-  Documentation:
-    Basic documentation is available in the directory "docs".
-
-  Upgrade from older versions:
-    See docs/README.upgrade.txt for upgrade instructions.
-
-  Internationalisation:
-    If you want to use a translated version of LAM be sure to install the
-    needed locales. See the LAM "locale" directory for a list of supported locales and languages.
-    You can get a list of all installed locales on your sysem by executing: locale -a
-    Debian users can add locales with "dpkg-reconfigure locales".
-
-  Security:
-    It is strongly recommended to use a SSL connection to your web server.
-
-    LAM needs to store your LDAP user name + password in the session. The session
-    files are saved in sess/ and are accessible only by the web server. To increase
-    security username and password are encrypted with MCrypt/AES if available.
-    The key and IV are generated at random when you log in. They are stored in two
-    cookies.
- 
-  Download:
-    You can get the newest version at http://lam.sourceforge.net/.
-
-  License:
-    LAM is published under the GNU General Public License.
-    The complete list of licenses can be found in the copyright file.
-
-
-    Have fun!
-        The LAM devel team
-
-
-
-
- Documentation generated on Thu, 07 Feb 2008 20:26:14 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/selfService/_lib---selfService.inc.html b/lam-web/developers/devel/phpdoc/selfService/_lib---selfService.inc.html deleted file mode 100644 index 7fb91194..00000000 --- a/lam-web/developers/devel/phpdoc/selfService/_lib---selfService.inc.html +++ /dev/null @@ -1,450 +0,0 @@ - - -Docs for page selfService.inc - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: selfService.inc

-Source Location: /lib/selfService.inc

- -
-
- -
-

Classes:

-
selfServiceProfile
-
Includes all settings of a self service profile.
-


- -

Page Details:

-Interface between modules and self service pages.

This file also includes the self service profile class and helper functions.




-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("modules.inc") [line 34]
-modules

include_once("types.inc") [line 36]
-account types

-

-

-
-
- -

checkSelfServiceOptions [line 116]

-
-
-
- array checkSelfServiceOptions( -string $scope, string $fields, array $attributes) -
-

- - Checks if all input values are correct and returns the LDAP commands which should be executed.



-

Tags:

-
- - - - -
return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $scope  account type
string  $fields  input fields (array(<moduleName> => array(<field1>, <field2>, ...)))
array  $attributes  LDAP attributes
-
[ Top ]


-
-
- -

checkSelfServiceSettings [line 238]

-
-
-
- array checkSelfServiceSettings( -string $scope, array $options) -
-

- - Checks if the self service settings are valid



-

Tags:

-
- - - - -
return:  list of error messages
-
-

- -

Parameters

- - - - - - - - - - - -
string  $scope  account type
array  $options  hash array containing all options (name => array(...))
-
[ Top ]


-
-
- -

getSelfServiceFieldSettings [line 75]

-
-
-
- array getSelfServiceFieldSettings( -string $scope) -
-

- - Returns the field settings for the self service.



-

Tags:

-
- - - - -
return:  settings
-
-

- -

Parameters

- - - - - - -
string  $scope  account type
-
[ Top ]


-
-
- -

getSelfServiceOptions [line 95]

-
-
-
- array getSelfServiceOptions( -string $scope, array $fields, array $attributes) -
-

- - Returns meta HTML code for each self service field.



-

Tags:

-
- - - - -
return:  meta HTML code (array(<moduleName> => array(<field1> => array(<meta HTML>))))
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $scope  account type
array  $fields  input fields (array(<moduleName> => array(<field1>, <field2>, ...)))
array  $attributes  LDAP attributes (attribute names in lower case)
-
[ Top ]


-
-
- -

getSelfServiceProfiles [line 137]

-
-
-
- array getSelfServiceProfiles( -) -
-

- - Returns a list of all available self service profiles (without .conf)



-

Tags:

-
- - - - -
return:  profile names (array(<account type> => array(<profile1>, <profile2>, ...)))
-
-

- -
[ Top ]


-
-
- -

getSelfServiceSearchAttributes [line 55]

-
-
-
- array getSelfServiceSearchAttributes( -string $scope) -
-

- - Returns a list of possible search attributes for the self service.



-

Tags:

-
- - - - -
return:  attributes
-
-

- -

Parameters

- - - - - - -
string  $scope  account type
-
[ Top ]


-
-
- -

getSelfServiceSettings [line 221]

-
-
-
- array getSelfServiceSettings( -string $scope) -
-

- - Returns a hash array (module name => elements) of all module options for the configuration page.



-

Tags:

-
- - - - -
return:  configuration options
-
-

- -

Parameters

- - - - - - -
string  $scope  account type
-
[ Top ]


-
-
- -

isLAMProVersion [line 43]

-
-
-
- boolean isLAMProVersion( -) -
-

- - Returns if this is a LAM Pro installation.



-

Tags:

-
- - - - -
return:  LAM Pro installation
-
-

- -
[ Top ]


-
-
- -

loadSelfServiceProfile [line 161]

-
-
-
- selfServiceProfile loadSelfServiceProfile( -string $name, string $scope) -
-

- - Loads all settings of a self service profile.



-

Tags:

-
- - - - -
return:  true if file was readable
-
-

- -

Parameters

- - - - - - - - - - - -
string  $name  profile name
string  $scope  account type
-
[ Top ]


-
-
- -

saveSelfServiceProfile [line 194]

-
-
-
- boolean saveSelfServiceProfile( -string $name, string $scope, selfServiceProfile $profile) -
-

- - Saves a self service profile.

File is created, if needed




-

Tags:

-
- - - - -
return:  true, if saving succeeded
-
-

- -

Parameters

- - - - - - - - - - - - - - - - -
string  $name  name of the account profile
string  $scope  account type
selfServiceProfile  $profile  self service profile
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:55 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/selfService/selfServiceProfile.html b/lam-web/developers/devel/phpdoc/selfService/selfServiceProfile.html deleted file mode 100644 index b74a12a8..00000000 --- a/lam-web/developers/devel/phpdoc/selfService/selfServiceProfile.html +++ /dev/null @@ -1,407 +0,0 @@ - - -Docs For Class selfServiceProfile - - - - - - - - - - - - - -
selfService
- - - [ class tree: selfService ] - [ index: selfService ] - [ all elements ] -
- - - - - - -
-
- -

Class: selfServiceProfile

-Source Location: /lib/selfService.inc

- - - - - - - - - - -
- -

Class Overview

-

-
Includes all settings of a self service profile.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 255]
-Includes all settings of a self service profile.



-
[ Top ]

- -
- -

Class Variables

-
- -

-

$inputFields =

-

[line 285]

- input fields

Format: array(<module> => array(array('name' => <group name>, 'fields' => array(<field1>, <field2>))))




-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$LDAPPassword =

-

[line 267]

- LDAP password



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$LDAPSuffix =

-

[line 261]

- LDAP suffix



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$LDAPUser =

-

[line 264]

- LDAP user DN



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$loginAttributeText =

-

[line 276]

- describing text for search attribute



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$loginCaption =

-

[line 273]

- describing text for user login



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$mainPageText =

-

[line 279]

- describing text for self service main page



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$moduleSettings =

-

[line 288]

- configuration settings of modules



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$searchAttribute =

-

[line 270]

- LDAP search attribute



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$serverURL =

-

[line 258]

- server address



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor __construct [line 295]

-
-
-
- selfServiceProfile __construct( -) -
-

- - Constructor



- - -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:55 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tests/_tests---conf-main-test.php.html b/lam-web/developers/devel/phpdoc/tests/_tests---conf-main-test.php.html deleted file mode 100644 index cf9691bd..00000000 --- a/lam-web/developers/devel/phpdoc/tests/_tests---conf-main-test.php.html +++ /dev/null @@ -1,99 +0,0 @@ - - -Docs for page conf-main-test.php - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: conf-main-test.php

-Source Location: /tests/conf-main-test.php

- -
-
- - -

Page Details:

-This test reads all preferences from config.cfg. Then it writes new values and verifies if they were written. At last the old values are restored.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include("../lib/config.inc") [line 33]
-configuration interface

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:21 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tests/_tests---conf-test.php.html b/lam-web/developers/devel/phpdoc/tests/_tests---conf-test.php.html deleted file mode 100644 index cd18920a..00000000 --- a/lam-web/developers/devel/phpdoc/tests/_tests---conf-test.php.html +++ /dev/null @@ -1,99 +0,0 @@ - - -Docs for page conf-test.php - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: conf-test.php

-Source Location: /tests/conf-test.php

- -
-
- - -

Page Details:

-This test reads all preferences from lam.conf. Then it writes new values and verifies if they were written. At last the old values are restored.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include("../lib/config.inc") [line 33]
-access to configuration functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:21 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tests/_tests---status-test.php.html b/lam-web/developers/devel/phpdoc/tests/_tests---status-test.php.html deleted file mode 100644 index 8cd600db..00000000 --- a/lam-web/developers/devel/phpdoc/tests/_tests---status-test.php.html +++ /dev/null @@ -1,99 +0,0 @@ - - -Docs for page status-test.php - - - - - - - - - - - - - -
tests
- - - [ class tree: tests ] - [ index: tests ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: status-test.php

-Source Location: /tests/status-test.php

- -
-
- - -

Page Details:

-LDAP Account Manager status messages.



-

Tags:

-
- - - - -
author:  Michael Duergner
-
-

-

Includes:

-
-include_once("../lib/status.inc") [line 32]
-message displaying

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/LAMTool.html b/lam-web/developers/devel/phpdoc/tools/LAMTool.html deleted file mode 100644 index cc5bb39e..00000000 --- a/lam-web/developers/devel/phpdoc/tools/LAMTool.html +++ /dev/null @@ -1,294 +0,0 @@ - - -Docs For Class LAMTool - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: LAMTool

-Source Location: /templates/tools.php

- - - - - - - - - -
- -

Class Overview

-

-
Represents a tool.


-

Author(s):

-
    -
  • Roland Gruber
  • -
- - - - - - - -
-

Variables

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 140]
-Represents a tool.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$description =

-

[line 146]

- description text



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$link =

-

[line 149]

- link to tool page (relative to templates/)



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$name =

-

[line 143]

- name of the tool



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$requiresPasswordChanges =  false

-

[line 155]

- tool requires password change rights



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$requiresWriteAccess =  false

-

[line 152]

- tool requires write access to LDAP



-

Tags:

-
- - - - -
access:  public
-
- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- - - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/LdapExportInfo.html b/lam-web/developers/devel/phpdoc/tools/LdapExportInfo.html deleted file mode 100644 index 59e436b2..00000000 --- a/lam-web/developers/devel/phpdoc/tools/LdapExportInfo.html +++ /dev/null @@ -1,255 +0,0 @@ - - -Docs For Class LdapExportInfo - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: LdapExportInfo

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-

-
This class encapsulate informations about the ldap server from which the export is done.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - -
-
- - -

Class Details

-
-[line 84]
-This class encapsulate informations about the ldap server from which the export is done.

The following info are provided within this class:

$base_dn: if the source of the export is the ldap server, it indicates the base dn of the search. $query_filter: if the source of the export is the ldap server, it indicates the query filter for the search. $scope: if the source of the export is the ldap server, it indicates the scope of the search.




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$base_dn =

-

[line 86]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$query_filter =

-

[line 87]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$scope =

-

[line 88]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor LdapExportInfo [line 98]

-
-
-
- LdapExportInfo LdapExportInfo( -[String -$base_dn = NULL], [String -$query_filter = NULL], [String -$scope = NULL]) -
-

- - Create a new LdapExportInfo object



- - -

Parameters:

-
- - - - - - - - - - - - - - - - -
String  $base_dn  the base_dn for the search in a ldap server
String  $query_filter  the query filter for the search
String  $scope  the scope of the search in a ldap server
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/MyCustomExporter.html b/lam-web/developers/devel/phpdoc/tools/MyCustomExporter.html deleted file mode 100644 index 00acde04..00000000 --- a/lam-web/developers/devel/phpdoc/tools/MyCustomExporter.html +++ /dev/null @@ -1,321 +0,0 @@ - - -Docs For Class MyCustomExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: MyCustomExporter

-Source Location: /lib/export.inc

- - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --MyCustomExporter

-


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

-
-
- PlaExporter::PlaExporter() -
-
- Constructor -
-
- PlaExporter::export() -
-
- Abstract method use to export data. -
-
- PlaExporter::is_safe_ascii() -
-
- Helper method to check if the attribute value should be base 64 encoded. -
-
- PlaExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaExporter::pla_num_entries() -
-
- Return the number of entries -
-
- PlaExporter::setOutputFormat() -
-
- Set the carriage return /linefeed for the export -
-
-

Class: PlaAbstractExporter

-
-
- PlaAbstractExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaAbstractExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaAbstractExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaAbstractExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaAbstractExporter::pla_num_entries() -
-
- Return the number of entries -
-
-
-
-
- - -

Class Details

-
-[line 792]
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method export [line 804]

-
-
-
- void export( -) -
-

- - When doing an exporter, the method export need to be overriden.

A basic implementation is provided here. Customize to your need




- - Overrides PlaExporter::export() (Abstract method use to export data.)

-
[ Top ]
-
-
- -

method MyCutsomExporter [line 794]

-
-
-
- void MyCutsomExporter( - -$exporter) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $exporter  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/PlaAbstractExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaAbstractExporter.html deleted file mode 100644 index 731cbf98..00000000 --- a/lam-web/developers/devel/phpdoc/tools/PlaAbstractExporter.html +++ /dev/null @@ -1,362 +0,0 @@ - - -Docs For Class PlaAbstractExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaAbstractExporter

-Source Location: /lib/export.inc

- - - - - - - - - -
- -

Class Overview

-

-
This class represents the base class of all exporters


-

Author(s):

-
    -
- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
PlaExporter
-
PlaExporter acts a wrapper around another exporter.
-
-
-
PlaLdapExporter
-
Export data from a ldap server
-
-
-
-
- - -

Class Details

-
-[line 119]
-This class represents the base class of all exporters

It can be subclassed directly if your intend is to write a source exporter(ie. it will act only as a decoree which will be wrapped by an another exporter.) If you consider writting an exporter for filtering data or directly display entries, please consider subclass the PlaExporter




-

Tags:

-
- - - - -
see:  PlaExporter
-
-


-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method pla_fetch_entry_array [line 137]

-
-
-
- array pla_fetch_entry_array( -) -
-

- - Return the entry as an array



-

Tags:

-
- - - - -
return:  an entry as an array
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_fetch_entry_array()
-
Return the entry as an array
-
-
-
PlaLdapExporter::pla_fetch_entry_array()
-
Return the entry as an array
-
-

- -
[ Top ]
-
-
- -

method pla_fetch_entry_object [line 143]

-
-
-
- Entry pla_fetch_entry_object( -) -
-

- - Return the entry as an Entry object



-

Tags:

-
- - - - -
return:  an entry as an Entry Object
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_fetch_entry_object()
-
Return the entry as an Entry object
-
-
-
PlaLdapExporter::pla_fetch_entry_object()
-
Return the entry as an Entry object
-
-

- -
[ Top ]
-
-
- -

method pla_get_ldap_info [line 149]

-
-
-
- LdapInfo pla_get_ldap_info( -) -
-

- - Return a PlaLdapInfo Object



-

Tags:

-
- - - - -
return:  Object with info from the ldap serveur
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_get_ldap_info()
-
Return a PlaLdapInfo Object
-
-
-
PlaLdapExporter::pla_get_ldap_info()
-
Return a PlaLdapInfo Object
-
-

- -
[ Top ]
-
-
- -

method pla_has_entry [line 131]

-
-
-
- bool pla_has_entry( -) -
-

- - Return true if there is some more entries to be processed



-

Tags:

-
- - - - -
return:  if there is some more entries to be processed
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_has_entry()
-
Return true if there is some more entries to be processed
-
-
-
PlaLdapExporter::pla_has_entry()
-
Return true if there is some more entries to be processed
-
-

- -
[ Top ]
-
-
- -

method pla_num_entries [line 125]

-
-
-
- int pla_num_entries( -) -
-

- - Return the number of entries



-

Tags:

-
- - - - -
return:  the number of entries to be exported
-
-

- -

Overridden in child classes as:
-

-
PlaExporter::pla_num_entries()
-
Return the number of entries
-
-
-
PlaLdapExporter::pla_num_entries()
-
Return the number of entries
-
-

- -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:27 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/PlaCSVExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaCSVExporter.html deleted file mode 100644 index 866d0fb6..00000000 --- a/lam-web/developers/devel/phpdoc/tools/PlaCSVExporter.html +++ /dev/null @@ -1,436 +0,0 @@ - - -Docs For Class PlaCSVExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaCSVExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --PlaCSVExporter

-
Export to cvs format


-

Author(s):

-
    -
  • Glen Ogilvie
  • -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

-
-
- PlaExporter::PlaExporter() -
-
- Constructor -
-
- PlaExporter::export() -
-
- Abstract method use to export data. -
-
- PlaExporter::is_safe_ascii() -
-
- Helper method to check if the attribute value should be base 64 encoded. -
-
- PlaExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaExporter::pla_num_entries() -
-
- Return the number of entries -
-
- PlaExporter::setOutputFormat() -
-
- Set the carriage return /linefeed for the export -
-
-

Class: PlaAbstractExporter

-
-
- PlaAbstractExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaAbstractExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaAbstractExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaAbstractExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaAbstractExporter::pla_num_entries() -
-
- Return the number of entries -
-
-
-
-
- - -

Class Details

-
-[line 684]
-Export to cvs format



-

Tags:

-
- - - - -
author:  Glen Ogilvie
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$escapeCode =  '"'

-

[line 698]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$multivalue_separator =  " | "

-

[line 697]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$qualifier =  '"'

-

[line 696]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$separator =  ","

-

[line 695]

- When doing an exporter, the method export need to be overriden.

A basic implementation is provided here. Customize to your need


-
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaCSVExporter [line 686]

-
-
-
- PlaCSVExporter PlaCSVExporter( - -$exporter) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $exporter  
-

-
[ Top ]
-
-
- -

method export [line 700]

-
-
-
- void export( -) -
-

- -

- - Overrides PlaExporter::export() (Abstract method use to export data.)

-
[ Top ]
-
-
- -

method LdapEscape [line 780]

-
-
-
- void LdapEscape( - -$var) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $var  
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:27 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/PlaDsmlExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaDsmlExporter.html deleted file mode 100644 index 886eab5b..00000000 --- a/lam-web/developers/devel/phpdoc/tools/PlaDsmlExporter.html +++ /dev/null @@ -1,375 +0,0 @@ - - -Docs For Class PlaDsmlExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaDsmlExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --PlaDsmlExporter

-
Export entries to DSML v.1


-

Author(s):

-
    -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

-
-
- PlaExporter::PlaExporter() -
-
- Constructor -
-
- PlaExporter::export() -
-
- Abstract method use to export data. -
-
- PlaExporter::is_safe_ascii() -
-
- Helper method to check if the attribute value should be base 64 encoded. -
-
- PlaExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaExporter::pla_num_entries() -
-
- Return the number of entries -
-
- PlaExporter::setOutputFormat() -
-
- Set the carriage return /linefeed for the export -
-
-

Class: PlaAbstractExporter

-
-
- PlaAbstractExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaAbstractExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaAbstractExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaAbstractExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaAbstractExporter::pla_num_entries() -
-
- Return the number of entries -
-
-
-
-
- - -

Class Details

-
-[line 478]
-Export entries to DSML v.1



-

Tags:

-
- - - - -
extends:  PlaExporter
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$counter =  0

-

[line 482]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$indent_step =  2

-

[line 481]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaDsmlExporter [line 488]

-
-
-
- PlaDsmlExporter PlaDsmlExporter( -PlaAbstractExporter -$exporter) -
-

- - Create a PlaDsmlExporter object



- - -

Parameters:

-
- - - - - - -
PlaAbstractExporter  $exporter  the decoree exporter
-

-
[ Top ]
-
-
- -

method export [line 495]

-
-
-
- void export( -) -
-

- - Export the entries to DSML



- - Overrides PlaExporter::export() (Abstract method use to export data.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:27 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/PlaExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaExporter.html deleted file mode 100644 index d01ef54b..00000000 --- a/lam-web/developers/devel/phpdoc/tools/PlaExporter.html +++ /dev/null @@ -1,526 +0,0 @@ - - -Docs For Class PlaExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter

-
PlaExporter acts a wrapper around another exporter.


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Child classes:

-
-
-
PlaLdifExporter
-
Export entries to ldif format
-
-
-
PlaDsmlExporter
-
Export entries to DSML v.1
-
-
-
PlaVcardExporter
-
-
-
-
PlaCSVExporter
-
Export to cvs format
-
-
-
MyCustomExporter
-
-
-
-
-

Inherited Methods

-
-

Class: PlaAbstractExporter

-
-
- PlaAbstractExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaAbstractExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaAbstractExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaAbstractExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaAbstractExporter::pla_num_entries() -
-
- Return the number of entries -
-
-
-
-
- - -

Class Details

-
-[line 161]
-PlaExporter acts a wrapper around another exporter.

In other words, it will act as a decorator for another decorator




-
[ Top ]

- -
- -

Class Variables

-
- -

-

$br = "\n"

-

[line 163]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$exporter =

-

[line 165]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaExporter [line 171]

-
-
-
- PlaExporter PlaExporter( -source -$source) -
-

- - Constructor



- - -

Parameters:

-
- - - - - - -
source  $source  the decoree for this exporter
-

-
[ Top ]
-
-
- -

method export [line 233]

-
-
-
- void export( -) -
-

- - Abstract method use to export data.

Must be implemented in a sub-class if you write an exporter which export data. Leave it empty if you write a sub-class which do only some filtering.




- -

Overridden in child classes as:
-

-
PlaLdifExporter::export()
-
Export entries to ldif format
-
-
-
PlaDsmlExporter::export()
-
Export the entries to DSML
-
-
-
PlaVcardExporter::export()
-
When doing an exporter, the method export need to be overriden.
-
-
-
PlaCSVExporter::export()
-
-
-
-
MyCustomExporter::export()
-
When doing an exporter, the method export need to be overriden.
-
-

- -
[ Top ]
-
-
- -

method is_safe_ascii [line 220]

-
-
-
- bool is_safe_ascii( -String -$str) -
-

- - Helper method to check if the attribute value should be base 64 encoded.



-

Tags:

-
- - - - -
return:  true if the string is safe ascii, false otherwise.
-
-

- - -

Parameters:

-
- - - - - - -
String  $str  the string to check.
-

-
[ Top ]
-
-
- -

method pla_fetch_entry_array [line 195]

-
-
-
- array pla_fetch_entry_array( -) -
-

- - Return the entry as an array



-

Tags:

-
- - - - -
return:  an entry as an array
-
-

- - Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)

-
[ Top ]
-
-
- -

method pla_fetch_entry_object [line 203]

-
-
-
- Entry pla_fetch_entry_object( -) -
-

- - Return the entry as an Entry object



-

Tags:

-
- - - - -
return:  an entry as an Entry Object
-
-

- - Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)

-
[ Top ]
-
-
- -

method pla_get_ldap_info [line 211]

-
-
-
- LdapInfo pla_get_ldap_info( -) -
-

- - Return a PlaLdapInfo Object



-

Tags:

-
- - - - -
return:  Object with info from the ldap serveur
-
-

- - Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

-
[ Top ]
-
-
- -

method pla_has_entry [line 187]

-
-
-
- bool pla_has_entry( -) -
-

- - Return true if there is some more entries to be processed



-

Tags:

-
- - - - -
return:  if there is some more entries to be processed
-
-

- - Overrides PlaAbstractExporter::pla_has_entry() (Return true if there is some more entries to be processed)

-
[ Top ]
-
-
- -

method pla_num_entries [line 179]

-
-
-
- int pla_num_entries( -) -
-

- - Return the number of entries



-

Tags:

-
- - - - -
return:  the number of entries to be exported
-
-

- - Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)

-
[ Top ]
-
-
- -

method setOutputFormat [line 239]

-
-
-
- void setOutputFormat( -String -$br) -
-

- - Set the carriage return /linefeed for the export



- - -

Parameters:

-
- - - - - - -
String  $br  the CRLF to be set
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:28 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/PlaLdapExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaLdapExporter.html deleted file mode 100644 index 5bf0324e..00000000 --- a/lam-web/developers/devel/phpdoc/tools/PlaLdapExporter.html +++ /dev/null @@ -1,539 +0,0 @@ - - -Docs For Class PlaLdapExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaLdapExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaLdapExporter

-
Export data from a ldap server


-

Author(s):

-
    -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: PlaAbstractExporter

-
-
- PlaAbstractExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaAbstractExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaAbstractExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaAbstractExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaAbstractExporter::pla_num_entries() -
-
- Return the number of entries -
-
-
-
-
- - -

Class Details

-
-[line 252]
-Export data from a ldap server



-

Tags:

-
- - - - -
extends:  PlaAbstractExporter
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$attributes =

-

[line 261]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$entry_array =

-

[line 256]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$entry_id =

-

[line 253]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$hasNext =

-

[line 260]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$ldap_info =

-

[line 258]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$num_entries =

-

[line 257]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$queryFilter =

-

[line 259]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$results =

-

[line 254]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$scope =

-

[line 255]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaLdapExporter [line 268]

-
-
-
- PlaLdapExporter PlaLdapExporter( -String -$queryFilter, String -$base_dn, String -$scope, -$attributes) -
-

- - Create a PlaLdapExporter object.



- - -

Parameters:

-
- - - - - - - - - - - - - - - - - - - - - -
String  $queryFilter  the queryFilter for the export
String  $base_dn  the base_dn for the data to export
String  $scope  the scope for export
  $attributes  
-

-
[ Top ]
-
-
- -

method pla_fetch_entry_array [line 306]

-
-
-
- array pla_fetch_entry_array( -) -
-

- - Return the entry as an array



-

Tags:

-
- - - - -
return:  an entry as an array
-
-

- - Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)

-
[ Top ]
-
-
- -

method pla_fetch_entry_object [line 314]

-
-
-
- Entry pla_fetch_entry_object( -) -
-

- - Return the entry as an Entry object



-

Tags:

-
- - - - -
return:  an entry as an Entry Object
-
-

- - Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)

-
[ Top ]
-
-
- -

method pla_get_ldap_info [line 322]

-
-
-
- LdapInfo pla_get_ldap_info( -) -
-

- - Return a PlaLdapInfo Object



-

Tags:

-
- - - - -
return:  Object with info from the ldap serveur
-
-

- - Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)

-
[ Top ]
-
-
- -

method pla_has_entry [line 338]

-
-
-
- bool pla_has_entry( -) -
-

- - Return true if there is some more entries to be processed



-

Tags:

-
- - - - -
return:  if there is some more entries to be processed
-
-

- - Overrides PlaAbstractExporter::pla_has_entry() (Return true if there is some more entries to be processed)

-
[ Top ]
-
-
- -

method pla_num_entries [line 330]

-
-
-
- int pla_num_entries( -) -
-

- - Return the number of entries



-

Tags:

-
- - - - -
return:  the number of entries to be exported
-
-

- - Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:28 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/PlaLdifExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaLdifExporter.html deleted file mode 100644 index d2f31711..00000000 --- a/lam-web/developers/devel/phpdoc/tools/PlaLdifExporter.html +++ /dev/null @@ -1,431 +0,0 @@ - - -Docs For Class PlaLdifExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaLdifExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --PlaLdifExporter

-
Export entries to ldif format


-

Author(s):

-
    -
- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

-
-
- PlaExporter::PlaExporter() -
-
- Constructor -
-
- PlaExporter::export() -
-
- Abstract method use to export data. -
-
- PlaExporter::is_safe_ascii() -
-
- Helper method to check if the attribute value should be base 64 encoded. -
-
- PlaExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaExporter::pla_num_entries() -
-
- Return the number of entries -
-
- PlaExporter::setOutputFormat() -
-
- Set the carriage return /linefeed for the export -
-
-

Class: PlaAbstractExporter

-
-
- PlaAbstractExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaAbstractExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaAbstractExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaAbstractExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaAbstractExporter::pla_num_entries() -
-
- Return the number of entries -
-
-
-
-
- - -

Class Details

-
-[line 378]
-Export entries to ldif format



-

Tags:

-
- - - - -
extends:  PlaExporter
-
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$counter =  0

-

[line 381]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$MAX_LDIF_LINE_LENGTH =  76

-

[line 384]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaLdifExporter [line 390]

-
-
-
- PlaLdifExporter PlaLdifExporter( -PlaAbstractExporter -$exporter) -
-

- - Create a PlaLdifExporter object



- - -

Parameters:

-
- - - - - - -
PlaAbstractExporter  $exporter  the source exporter
-

-
[ Top ]
-
-
- -

method displayExportInfo [line 439]

-
-
-
- void displayExportInfo( - -$pla_ldap_info) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $pla_ldap_info  
-

-
[ Top ]
-
-
- -

method export [line 397]

-
-
-
- void export( -) -
-

- - Export entries to ldif format



- - Overrides PlaExporter::export() (Abstract method use to export data.)

-
[ Top ]
-
-
- -

method multi_lines_display [line 452]

-
-
-
- void multi_lines_display( -String -$str) -
-

- - Helper method to wrap ldif lines



- - -

Parameters:

-
- - - - - - -
String  $str  the line to be wrapped if needed.
-

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:28 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/PlaVcardExporter.html b/lam-web/developers/devel/phpdoc/tools/PlaVcardExporter.html deleted file mode 100644 index 2855d345..00000000 --- a/lam-web/developers/devel/phpdoc/tools/PlaVcardExporter.html +++ /dev/null @@ -1,380 +0,0 @@ - - -Docs For Class PlaVcardExporter - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Class: PlaVcardExporter

-Source Location: /lib/export.inc

- - - - - - - - - - -
- -

Class Overview

-
PlaAbstractExporter
-   |
-   --PlaExporter
-      |
-      --PlaVcardExporter

-


- - - - - - - -
-

Variables

- -
-

Methods

- -
-
- - - - - - - - - - -
-

Inherited Variables

-
-

Class: PlaExporter

-
-
- PlaExporter::$br -
-
- -
-
- PlaExporter::$exporter -
-
- -
-
-
-
-

Inherited Methods

-
-

Class: PlaExporter

-
-
- PlaExporter::PlaExporter() -
-
- Constructor -
-
- PlaExporter::export() -
-
- Abstract method use to export data. -
-
- PlaExporter::is_safe_ascii() -
-
- Helper method to check if the attribute value should be base 64 encoded. -
-
- PlaExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaExporter::pla_num_entries() -
-
- Return the number of entries -
-
- PlaExporter::setOutputFormat() -
-
- Set the carriage return /linefeed for the export -
-
-

Class: PlaAbstractExporter

-
-
- PlaAbstractExporter::pla_fetch_entry_array() -
-
- Return the entry as an array -
-
- PlaAbstractExporter::pla_fetch_entry_object() -
-
- Return the entry as an Entry object -
-
- PlaAbstractExporter::pla_get_ldap_info() -
-
- Return a PlaLdapInfo Object -
-
- PlaAbstractExporter::pla_has_entry() -
-
- Return true if there is some more entries to be processed -
-
- PlaAbstractExporter::pla_num_entries() -
-
- Return the number of entries -
-
-
-
-
- - -

Class Details

-
-[line 565]
-


-
[ Top ]

- -
- -

Class Variables

-
- -

-

$deliveryAddress = array("postOfficeBox",
-            "street",
-            "l",
-            "st",
-            "postalCode",
-            "c")

-

[line 582]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

- -

-

$vcardMapping = array('cn' => 'FN',
-             'title' => 'TITLE',
-             'homePhone' => 'TEL;HOME',
-             'mobile' => 'TEL;CELL',
-             'mail' => 'EMAIL;Internet',
-             'labeledURI' =>'URL',
-             'o' => 'ORG',
-             'audio' => 'SOUND',
-             'facsmileTelephoneNumber' =>'TEL;WORK;HOME;VOICE;FAX',
-             'jpegPhoto' => 'PHOTO;ENCODING=BASE64',
-             'businessCategory' => 'ROLE',
-             'description' => 'NOTE'
-             )

-

[line 568]

- -
-
- - - - - -
Type:  mixed
-


-
[ Top ]

-

- -
- -

Class Methods

-
- -
- -

constructor PlaVcardExporter [line 589]

-
-
-
- PlaVcardExporter PlaVcardExporter( - -$exporter) -
-

- -

- - -

Parameters:

-
- - - - - - -
  $exporter  
-

-
[ Top ]
-
-
- -

method export [line 598]

-
-
-
- void export( -) -
-

- - When doing an exporter, the method export need to be overriden.

A basic implementation is provided here. Customize to your need




- - Overrides PlaExporter::export() (Abstract method use to export data.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:29 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/tools/_lib---export.inc.html b/lam-web/developers/devel/phpdoc/tools/_lib---export.inc.html deleted file mode 100644 index 4e954888..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_lib---export.inc.html +++ /dev/null @@ -1,247 +0,0 @@ - - -Docs for page export.inc - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: export.inc

-Source Location: /lib/export.inc

- -
-
- -
-

Classes:

-
LdapExportInfo
-
This class encapsulate informations about the ldap server from which the export is done.
-
PlaAbstractExporter
-
This class represents the base class of all exporters
-
PlaExporter
-
PlaExporter acts a wrapper around another exporter.
-
PlaLdapExporter
-
Export data from a ldap server
-
PlaLdifExporter
-
Export entries to ldif format
-
PlaDsmlExporter
-
Export entries to DSML v.1
-
PlaVcardExporter
-
-
PlaCSVExporter
-
Export to cvs format
-
MyCustomExporter
-
-


- -

Page Details:

-Functions and classes for exporting LDAP entries to others formats (LDIF,DSML,..) An example is provided at the bottom of this file if you want implement yours.



-

Tags:

-
- - - - - - - -
author:  The phpLDAPadmin development team
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('status.inc') [line 40]
-used to print status messages

-

-

-
-
- -

get_user_agent_string [line 847]

-
-
-
- String get_user_agent_string( -) -
-

- - Gets the USER_AGENT string from the $_SERVER array, all in lower case in an E_NOTICE safe manner.



-

Tags:

-
- - - - -
return:  The user agent string as reported by the browser.
-
-

- -
[ Top ]


-
-
- -

is_browser_os_mac [line 947]

-
-
-
- boolean is_browser_os_mac( -) -
-

- - Determines whether the browser's operating system is Macintosh.



-

Tags:

-
- - - - -
return:  True if the brower's OS is mac, false otherwise.
-
-

- -
[ Top ]


-
-
- -

is_browser_os_unix [line 859]

-
-
-
- boolean is_browser_os_unix( -) -
-

- - Determines whether the browser's operating system is UNIX (or something like UNIX).



-

Tags:

-
- - - - -
return:  True if the brower's OS is UNIX, false otherwise.
-
-

- -
[ Top ]


-
-
- -

is_browser_os_windows [line 910]

-
-
-
- boolean is_browser_os_windows( -) -
-

- - Determines whether the browser's operating system is Windows.



-

Tags:

-
- - - - -
return:  True if the brower's OS is Windows, false otherwise.
-
-

- -
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:26 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---massBuildAccounts.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---massBuildAccounts.php.html deleted file mode 100644 index 662b3fd1..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---massBuildAccounts.php.html +++ /dev/null @@ -1,130 +0,0 @@ - - -Docs for page massBuildAccounts.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: massBuildAccounts.php

-Source Location: /templates/massBuildAccounts.php

- -
-
- - -

Page Details:

-Creates the accounts by parsing the uploaded file.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../lib/security.inc") [line 32]
-security functions

include_once('../lib/config.inc') [line 34]
-access to configuration

include_once('../lib/status.inc') [line 36]
-status messages

include_once('../lib/modules.inc') [line 38]
-account modules

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:41 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---massDoUpload.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---massDoUpload.php.html deleted file mode 100644 index c7a9e50d..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---massDoUpload.php.html +++ /dev/null @@ -1,132 +0,0 @@ - - -Docs for page massDoUpload.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: massDoUpload.php

-Source Location: /templates/massDoUpload.php

- -
-
- - -

Page Details:

-Creates LDAP accounts for file upload.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../lib/config.inc') [line 34]
-access to configuration

include_once("../lib/security.inc") [line 32]
-security functions

include_once('../lib/ldap.inc') [line 36]
-LDAP handle

include_once('../lib/status.inc') [line 38]
-status messages

include_once('../lib/cache.inc') [line 42]
-LAM cache

include_once('../lib/modules.inc') [line 40]
-account modules

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:41 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---masscreate.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---masscreate.php.html deleted file mode 100644 index 1e788613..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---masscreate.php.html +++ /dev/null @@ -1,186 +0,0 @@ - - -Docs for page masscreate.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: masscreate.php

-Source Location: /templates/masscreate.php

- -
-
- - -

Page Details:

-Start page of file upload



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once('../lib/config.inc') [line 34]
-access to configuration

include_once('../lib/status.inc') [line 36]
-status messages

include_once("../lib/security.inc") [line 32]
-security functions

include_once('../lib/modules.inc') [line 38]
-account modules

-

-

-
-
- -

showColumnData [line 295]

-
-
-
- void showColumnData( -string $module, array $data, string $scope) -
-

- - Prints the properties of one input field.



- -

Parameters

- - - - - - - - - - - - - - - - -
string  $module  account module name
array  $data  field data from modules
string  $scope  account type
-
[ Top ]


-
-
- -

showMainPage [line 123]

-
-
-
- void showMainPage( -string $scope) -
-

- - Displays the acount type specific main page of the upload.



- -

Parameters

- - - - - - -
string  $scope  account type
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:41 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---ou_edit.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---ou_edit.php.html deleted file mode 100644 index b091903a..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---ou_edit.php.html +++ /dev/null @@ -1,145 +0,0 @@ - - -Docs for page ou_edit.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: ou_edit.php

-Source Location: /templates/ou_edit.php

- -
-
- - -

Page Details:

-This is an editor for organizational units.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../lib/security.inc") [line 32]
-security functions

include_once("../lib/config.inc") [line 34]
-access to configuration data

include_once("../lib/ldap.inc") [line 36]
-access LDAP server

include_once("../lib/status.inc") [line 38]
-used to print status messages

-

-

-
-
- -

display_main [line 144]

-
-
-
- void display_main( -) -
-

- -

- -
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:43 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---schema---schema.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---schema---schema.php.html deleted file mode 100644 index 5991d6a5..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---schema---schema.php.html +++ /dev/null @@ -1,133 +0,0 @@ - - -Docs for page schema.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: schema.php

-Source Location: /templates/schema/schema.php

- -
-
- - -

Page Details:

-Displays the LDAP schema of the server



-

Tags:

-
- - - - - - - -
author:  David Smith
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 35]
-security functions

include_once("../../lib/ldap.inc") [line 37]
-access to LDAP server

include_once("../../lib/config.inc") [line 39]
-access to configuration options

require_once("../../lib/schema.inc") [line 41]
-schema functions

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:55 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---tests---index.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---tests---index.php.html deleted file mode 100644 index 00f3accb..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---tests---index.php.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Docs for page index.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: index.php

-Source Location: /templates/tests/index.php

- -
-
- - -

Page Details:

-Provides a list of LAM tests.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 32]
-security functions

include_once("../../lib/config.inc") [line 34]
-access to configuration options

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:33 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---tests---lamdaemonTest.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---tests---lamdaemonTest.php.html deleted file mode 100644 index 0131b6c9..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---tests---lamdaemonTest.php.html +++ /dev/null @@ -1,211 +0,0 @@ - - -Docs for page lamdaemonTest.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: lamdaemonTest.php

-Source Location: /templates/tests/lamdaemonTest.php

- -
-
- - -

Page Details:

-Tests the lamdaemon script.



-

Tags:

-
- - - - - - - -
author:  Roland Gruber
author:  Thomas Manninger
-
-

-

Includes:

-
-include_once("../../lib/config.inc") [line 35]
-access to configuration options

include_once("../../lib/security.inc") [line 33]
-security functions

-

-

-
-
- -

lamRunLamdaemonTestSuite [line 193]

-
-
-
- void lamRunLamdaemonTestSuite( -String $serverName, String $serverTitle, boolean $testQuota) -
-

- - Runs all tests for a given server.



- -

Parameters

- - - - - - - - - - - - - - - - -
String  $serverName  server ID
String  $serverTitle  server name
boolean  $testQuota  true, if Quotas should be checked
-
[ Top ]


-
-
- -

lamTestLamdaemon [line 131]

-
-
-
- boolean lamTestLamdaemon( -string $command, boolean $stopTest, connection $handle, string $testText) -
-

- - Runs a test case of lamdaemon.



-

Tags:

-
- - - - -
return:  true, if errors occured
-
-

- -

Parameters

- - - - - - - - - - - - - - - - - - - - - -
string  $command  test command
boolean  $stopTest  specifies if test should be run
connection  $handle  SSH connection
string  $testText  describing text
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:36 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---tests---schemaTest.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---tests---schemaTest.php.html deleted file mode 100644 index b63eafd4..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---tests---schemaTest.php.html +++ /dev/null @@ -1,199 +0,0 @@ - - -Docs for page schemaTest.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: schemaTest.php

-Source Location: /templates/tests/schemaTest.php

- -
-
- - -

Page Details:

-Tests the lamdaemon script.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../../lib/security.inc") [line 32]
-security functions

include_once("../../lib/config.inc") [line 34]
-access to configuration options

include_once("../../lib/schema.inc") [line 38]
-LDAP schema

include_once("../../lib/modules.inc") [line 36]
-account modules

-

-

-
-
- -

checkSchemaForModule [line 109]

-
-
-
- String checkSchemaForModule( -String $name, String $type) -
-

- - Checks if the object classes and attributes for this module are available.



-

Tags:

-
- - - - -
return:  error message or null
-
-

- -

Parameters

- - - - - - - - - - - -
String  $name  module name
String  $type  type (user, group, ...)
-
[ Top ]


-
-
- -

getRecursiveAttributesFromObjectClass [line 145]

-
-
-
- array getRecursiveAttributesFromObjectClass( -ObjectClass $oClass) -
-

- - Returns the names of all attributes which are managed by the given object class and its parents.



-

Tags:

-
- - - - -
return:  list of attribute names
-
-

- -

Parameters

- - - - - - -
ObjectClass  $oClass  object class
-
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:55 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/tools/_templates---tools.php.html b/lam-web/developers/devel/phpdoc/tools/_templates---tools.php.html deleted file mode 100644 index 72f33f2f..00000000 --- a/lam-web/developers/devel/phpdoc/tools/_templates---tools.php.html +++ /dev/null @@ -1,133 +0,0 @@ - - -Docs for page tools.php - - - - - - - - - - - - - -
tools
- - - [ class tree: tools ] - [ index: tools ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: tools.php

-Source Location: /templates/tools.php

- -
-
- -
-

Classes:

-
LAMTool
-
Represents a tool.
-


- -

Page Details:

-Provides a list of tools like file upload or profile editor.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("../lib/security.inc") [line 32]
-security functions

include_once("../lib/config.inc") [line 34]
-access to configuration options

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/types/_lib---baseType.inc.html b/lam-web/developers/devel/phpdoc/types/_lib---baseType.inc.html deleted file mode 100644 index ede672c0..00000000 --- a/lam-web/developers/devel/phpdoc/types/_lib---baseType.inc.html +++ /dev/null @@ -1,118 +0,0 @@ - - -Docs for page baseType.inc - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: baseType.inc

-Source Location: /lib/baseType.inc

- -
-
- -
-

Classes:

-
baseType
-
This is the parent class of all account types.
-


- -

Page Details:

-This is the parent class of all account types.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:20 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/types/_lib---types---group.inc.html b/lam-web/developers/devel/phpdoc/types/_lib---types---group.inc.html deleted file mode 100644 index cf32297a..00000000 --- a/lam-web/developers/devel/phpdoc/types/_lib---types---group.inc.html +++ /dev/null @@ -1,123 +0,0 @@ - - -Docs for page group.inc - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: group.inc

-Source Location: /lib/types/group.inc

- -
-
- -
-

Classes:

-
group
-
The account type for group accounts (e.g. Unix and Samba).
-
lamGroupList
-
Generates the list view.
-


- -

Page Details:

-The account type for group accounts (e.g. Unix and Samba).



-

Tags:

-
- - - - - - - -
author:  Roland Gruber
author:  Ludek Finstrle
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:30 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/types/_lib---types---host.inc.html b/lam-web/developers/devel/phpdoc/types/_lib---types---host.inc.html deleted file mode 100644 index ee2d5ea6..00000000 --- a/lam-web/developers/devel/phpdoc/types/_lib---types---host.inc.html +++ /dev/null @@ -1,120 +0,0 @@ - - -Docs for page host.inc - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: host.inc

-Source Location: /lib/types/host.inc

- -
-
- -
-

Classes:

-
host
-
The account type for host accounts (e.g. Samba).
-
lamHostList
-
Generates the list view.
-


- -

Page Details:

-The account type for host accounts (e.g. Samba).



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/types/_lib---types---mailAlias.inc.html b/lam-web/developers/devel/phpdoc/types/_lib---types---mailAlias.inc.html deleted file mode 100644 index 7e184d01..00000000 --- a/lam-web/developers/devel/phpdoc/types/_lib---types---mailAlias.inc.html +++ /dev/null @@ -1,120 +0,0 @@ - - -Docs for page mailAlias.inc - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: mailAlias.inc

-Source Location: /lib/types/mailAlias.inc

- -
-
- -
-

Classes:

-
mailAlias
-
The account type for mail aliases.
-
lamMailAliasList
-
Generates the list view.
-


- -

Page Details:

-The account type for mail aliases.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/types/_lib---types---smbDomain.inc.html b/lam-web/developers/devel/phpdoc/types/_lib---types---smbDomain.inc.html deleted file mode 100644 index 3ac4b9a3..00000000 --- a/lam-web/developers/devel/phpdoc/types/_lib---types---smbDomain.inc.html +++ /dev/null @@ -1,120 +0,0 @@ - - -Docs for page smbDomain.inc - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: smbDomain.inc

-Source Location: /lib/types/smbDomain.inc

- -
-
- -
-

Classes:

-
smbDomain
-
The account type for Samba domains.
-
lamSmbDomainList
-
Generates the list view.
-


- -

Page Details:

-The account type for Samba domains.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/types/_lib---types---user.inc.html b/lam-web/developers/devel/phpdoc/types/_lib---types---user.inc.html deleted file mode 100644 index a470b70b..00000000 --- a/lam-web/developers/devel/phpdoc/types/_lib---types---user.inc.html +++ /dev/null @@ -1,120 +0,0 @@ - - -Docs for page user.inc - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: user.inc

-Source Location: /lib/types/user.inc

- -
-
- -
-

Classes:

-
user
-
The account type for user accounts (e.g. Unix, Samba and Kolab).
-
lamUserList
-
Generates the list view.
-


- -

Page Details:

-The account type for user accounts (e.g. Unix, Samba and Kolab).



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

-

-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/types/_lib---types.inc.html b/lam-web/developers/devel/phpdoc/types/_lib---types.inc.html deleted file mode 100644 index fe69ca1c..00000000 --- a/lam-web/developers/devel/phpdoc/types/_lib---types.inc.html +++ /dev/null @@ -1,304 +0,0 @@ - - -Docs for page types.inc - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Procedural File: types.inc

-Source Location: /lib/types.inc

- -
-
- - -

Page Details:

-This file is the interface to the different account types.



-

Tags:

-
- - - - -
author:  Roland Gruber
-
-

-

Includes:

-
-include_once("baseType.inc") [line 32]
-parent class of account types

include_once($typesINC_dirname.'/'.$entry) [line 47]
-This includes all type definitions.

include_once("selfService.inc") [line 36]
-Used to check if this is a LAM Pro release.

include_once("lists.inc") [line 34]
-parent class of list views

-

-

-
-
- -

getDefaultListAttributes [line 109]

-
-
-
- string getDefaultListAttributes( -string $type) -
-

- - Returns the default attribute list for an account type.

It is used as default value for the configuration editor.




-

Tags:

-
- - - - -
return:  attribute list
-
-

- -

Parameters

- - - - - - -
string  $type  account type
-
[ Top ]


-
-
- -

getListAttributeDescriptions [line 121]

-
-
-
- array getListAttributeDescriptions( -string $type) -
-

- - Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




-

Tags:

-
- - - - -
return:  list of descriptions
-
-

- -

Parameters

- - - - - - -
string  $type  account type
-
[ Top ]


-
-
- -

getListClassName [line 97]

-
-
-
- string getListClassName( -string $type) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- -

Parameters

- - - - - - -
string  $type  account type
-
[ Top ]


-
-
- -

getTypeAlias [line 75]

-
-
-
- string getTypeAlias( -string $type) -
-

- - Returns the alias name of an account type.



-

Tags:

-
- - - - -
return:  type alias
-
-

- -

Parameters

- - - - - - -
string  $type  type name
-
[ Top ]


-
-
- -

getTypeDescription [line 86]

-
-
-
- string getTypeDescription( -string $type) -
-

- - Returns the description of an account type.



-

Tags:

-
- - - - -
return:  type description
-
-

- -

Parameters

- - - - - - -
string  $type  type name
-
[ Top ]


-
-
- -

getTypes [line 56]

-
-
-
- array getTypes( -) -
-

- - Returns a list of available account types.



-

Tags:

-
- - - - -
return:  list of types
-
-

- -
[ Top ]


-
- -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:01 +0100 by phpDocumentor 1.4.0 -
-
-
- - - diff --git a/lam-web/developers/devel/phpdoc/types/baseType.html b/lam-web/developers/devel/phpdoc/types/baseType.html deleted file mode 100644 index c29799a0..00000000 --- a/lam-web/developers/devel/phpdoc/types/baseType.html +++ /dev/null @@ -1,412 +0,0 @@ - - -Docs For Class baseType - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: baseType

-Source Location: /lib/baseType.inc

- - - - - - - - - -
- -

Class Overview

-

-
This is the parent class of all account types.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Child classes:

-
-
-
group
-
The account type for group accounts (e.g. Unix and Samba).
-
-
-
host
-
The account type for host accounts (e.g. Samba).
-
-
-
mailAlias
-
The account type for mail aliases.
-
-
-
smbDomain
-
The account type for Samba domains.
-
-
-
user
-
The account type for user accounts (e.g. Unix, Samba and Kolab).
-
-
-
-
- - -

Class Details

-
-[line 36]
-This is the parent class of all account types.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 44]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.

This function must be overwritten by the child classes.




-

Tags:

-
- - - - -
return:  alias name
-
-

- -

Overridden in child classes as:
-

-
group::getAlias()
-
Returns the alias name of this account type.
-
-
-
host::getAlias()
-
Returns the alias name of this account type.
-
-
-
mailAlias::getAlias()
-
Returns the alias name of this account type.
-
-
-
smbDomain::getAlias()
-
Returns the alias name of this account type.
-
-
-
user::getAlias()
-
Returns the alias name of this account type.
-
-

- -
[ Top ]
-
-
- -

method getDefaultListAttributes [line 73]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.

This function must be overwritten by the child classes.




-

Tags:

-
- - - - -
return:  attribute list
-
-

- -

Overridden in child classes as:
-

-
group::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-
-
host::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-
-
mailAlias::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-
-
smbDomain::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-
-
user::getDefaultListAttributes()
-
Returns the default attribute list for this account type.
-
-

- -
[ Top ]
-
-
- -

method getDescription [line 54]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.

This function must be overwritten by the child classes.




-

Tags:

-
- - - - -
return:  description
-
-

- -

Overridden in child classes as:
-

-
group::getDescription()
-
Returns the description of this account type.
-
-
-
host::getDescription()
-
Returns the description of this account type.
-
-
-
mailAlias::getDescription()
-
Returns the description of this account type.
-
-
-
smbDomain::getDescription()
-
Returns the description of this account type.
-
-
-
user::getDescription()
-
Returns the description of this account type.
-
-

- -
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 83]

-
-
-
- array getListAttributeDescriptions( -) -
-

- - Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




-

Tags:

-
- - - - -
return:  list of descriptions
-
-

- -

Overridden in child classes as:
-

-
group::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-
-
host::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-
-
mailAlias::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-
-
smbDomain::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-
-
user::getListAttributeDescriptions()
-
Returns a list of attributes which have a translated description.
-
-

- -
[ Top ]
-
-
- -

method getListClassName [line 63]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- -

Overridden in child classes as:
-

-
group::getListClassName()
-
Returns the class name for the list object.
-
-
-
host::getListClassName()
-
Returns the class name for the list object.
-
-
-
mailAlias::getListClassName()
-
Returns the class name for the list object.
-
-
-
smbDomain::getListClassName()
-
Returns the class name for the list object.
-
-
-
user::getListClassName()
-
Returns the class name for the list object.
-
-

- -
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:20 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/types/group.html b/lam-web/developers/devel/phpdoc/types/group.html deleted file mode 100644 index 04ebd3e4..00000000 --- a/lam-web/developers/devel/phpdoc/types/group.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class group - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: group

-Source Location: /lib/types/group.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --group

-
The account type for group accounts (e.g. Unix and Samba).


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

-
-
- baseType::getAlias() -
-
- Returns the alias name of this account type. -
-
- baseType::getDefaultListAttributes() -
-
- Returns the default attribute list for this account type. -
-
- baseType::getDescription() -
-
- Returns the description of this account type. -
-
- baseType::getListAttributeDescriptions() -
-
- Returns a list of attributes which have a translated description. -
-
- baseType::getListClassName() -
-
- Returns the class name for the list object. -
-
-
-
-
- - -

Class Details

-
-[line 37]
-The account type for group accounts (e.g. Unix and Samba).



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 44]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 71]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 53]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 81]

-
-
-
- array getListAttributeDescriptions( -) -
-

- - Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




-

Tags:

-
- - - - -
return:  list of descriptions
-
-

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 62]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:30 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/types/host.html b/lam-web/developers/devel/phpdoc/types/host.html deleted file mode 100644 index db3ac1f5..00000000 --- a/lam-web/developers/devel/phpdoc/types/host.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class host - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: host

-Source Location: /lib/types/host.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --host

-
The account type for host accounts (e.g. Samba).


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

-
-
- baseType::getAlias() -
-
- Returns the alias name of this account type. -
-
- baseType::getDefaultListAttributes() -
-
- Returns the default attribute list for this account type. -
-
- baseType::getDescription() -
-
- Returns the description of this account type. -
-
- baseType::getListAttributeDescriptions() -
-
- Returns a list of attributes which have a translated description. -
-
- baseType::getListClassName() -
-
- Returns the class name for the list object. -
-
-
-
-
- - -

Class Details

-
-[line 36]
-The account type for host accounts (e.g. Samba).



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 43]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 70]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 52]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 80]

-
-
-
- array getListAttributeDescriptions( -) -
-

- - Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




-

Tags:

-
- - - - -
return:  list of descriptions
-
-

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 61]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:32 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/types/mailAlias.html b/lam-web/developers/devel/phpdoc/types/mailAlias.html deleted file mode 100644 index 46d44df0..00000000 --- a/lam-web/developers/devel/phpdoc/types/mailAlias.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class mailAlias - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: mailAlias

-Source Location: /lib/types/mailAlias.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --mailAlias

-
The account type for mail aliases.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

-
-
- baseType::getAlias() -
-
- Returns the alias name of this account type. -
-
- baseType::getDefaultListAttributes() -
-
- Returns the default attribute list for this account type. -
-
- baseType::getDescription() -
-
- Returns the description of this account type. -
-
- baseType::getListAttributeDescriptions() -
-
- Returns a list of attributes which have a translated description. -
-
- baseType::getListClassName() -
-
- Returns the class name for the list object. -
-
-
-
-
- - -

Class Details

-
-[line 36]
-The account type for mail aliases.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 43]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 70]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 52]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 80]

-
-
-
- array getListAttributeDescriptions( -) -
-

- - Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




-

Tags:

-
- - - - -
return:  list of descriptions
-
-

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 61]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:40 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/types/smbDomain.html b/lam-web/developers/devel/phpdoc/types/smbDomain.html deleted file mode 100644 index 6316823c..00000000 --- a/lam-web/developers/devel/phpdoc/types/smbDomain.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class smbDomain - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: smbDomain

-Source Location: /lib/types/smbDomain.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --smbDomain

-
The account type for Samba domains.


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

-
-
- baseType::getAlias() -
-
- Returns the alias name of this account type. -
-
- baseType::getDefaultListAttributes() -
-
- Returns the default attribute list for this account type. -
-
- baseType::getDescription() -
-
- Returns the description of this account type. -
-
- baseType::getListAttributeDescriptions() -
-
- Returns a list of attributes which have a translated description. -
-
- baseType::getListClassName() -
-
- Returns the class name for the list object. -
-
-
-
-
- - -

Class Details

-
-[line 36]
-The account type for Samba domains.



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 43]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 70]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 52]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 80]

-
-
-
- array getListAttributeDescriptions( -) -
-

- - Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




-

Tags:

-
- - - - -
return:  list of descriptions
-
-

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 61]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:26:57 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/phpdoc/types/user.html b/lam-web/developers/devel/phpdoc/types/user.html deleted file mode 100644 index 204cda92..00000000 --- a/lam-web/developers/devel/phpdoc/types/user.html +++ /dev/null @@ -1,317 +0,0 @@ - - -Docs For Class user - - - - - - - - - - - - - -
types
- - - [ class tree: types ] - [ index: types ] - [ all elements ] -
- - - - - - -
-
- -

Class: user

-Source Location: /lib/types/user.inc

- - - - - - - - - -
- -

Class Overview

-
baseType
-   |
-   --user

-
The account type for user accounts (e.g. Unix, Samba and Kolab).


- - - - - - - -
-

Methods

- -
-
- - - - - - - - - -
-

Inherited Methods

-
-

Class: baseType

-
-
- baseType::getAlias() -
-
- Returns the alias name of this account type. -
-
- baseType::getDefaultListAttributes() -
-
- Returns the default attribute list for this account type. -
-
- baseType::getDescription() -
-
- Returns the description of this account type. -
-
- baseType::getListAttributeDescriptions() -
-
- Returns a list of attributes which have a translated description. -
-
- baseType::getListClassName() -
-
- Returns the class name for the list object. -
-
-
-
-
- - -

Class Details

-
-[line 36]
-The account type for user accounts (e.g. Unix, Samba and Kolab).



-
[ Top ]

- - -
- -

Class Methods

-
- -
- -

method getAlias [line 43]

-
-
-
- string getAlias( -) -
-

- - Returns the alias name of this account type.



-

Tags:

-
- - - - -
return:  alias name
-
-

- - Overrides baseType::getAlias() (Returns the alias name of this account type.)

-
[ Top ]
-
-
- -

method getDefaultListAttributes [line 70]

-
-
-
- string getDefaultListAttributes( -) -
-

- - Returns the default attribute list for this account type.



-

Tags:

-
- - - - -
return:  attribute list
-
-

- - Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)

-
[ Top ]
-
-
- -

method getDescription [line 52]

-
-
-
- string getDescription( -) -
-

- - Returns the description of this account type.



-

Tags:

-
- - - - -
return:  description
-
-

- - Overrides baseType::getDescription() (Returns the description of this account type.)

-
[ Top ]
-
-
- -

method getListAttributeDescriptions [line 80]

-
-
-
- array getListAttributeDescriptions( -) -
-

- - Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




-

Tags:

-
- - - - -
return:  list of descriptions
-
-

- - Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)

-
[ Top ]
-
-
- -

method getListClassName [line 61]

-
-
-
- string getListClassName( -) -
-

- - Returns the class name for the list object.



-

Tags:

-
- - - - -
return:  class name
-
-

- - Overrides baseType::getListClassName() (Returns the class name for the list object.)

-
[ Top ]
-
-

- - -
-
- Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by phpDocumentor 1.4.0 -
-
-
- - - \ No newline at end of file diff --git a/lam-web/developers/devel/profile_editor.htm b/lam-web/developers/devel/profile_editor.htm deleted file mode 100644 index 19cc6038..00000000 --- a/lam-web/developers/devel/profile_editor.htm +++ /dev/null @@ -1,72 +0,0 @@ - - - - - Profile editor - - - -

Profile editor
-

-

-
-

-
The profile -editor allows the user to set default values for new accounts.
-These defaults are saved as files in config/profiles.
-
-

Profilemain.php
-

-This is the start page of the profile -editor. The user can select to add/modify/remove selected -account profiles.
-
-The list of existing account profiles is returned by getAccountProfiles() in modules.inc. It includes all -profile names without file extensions.
-
-

Profilepage.php
-

-This script is used to display the account profile to the user.
-
-The profile options include the LDAP OU suffix and options provided by -the account modules.
-
-The values for the OU selection are read with search_units().
-
-The account modules provide -all other profile options. The profile editor displays a separate -fieldset for each module containing its options.
-The function print_option() -manages the display of the different option types (checkbox, select, -...). The type of each option is saved in $_SESSION['profile_types'].
-See the modules specification -for a complete list of supported types.
-
-The profiles have unique names under which they are saved. If a profile -with the same name already exists it will be overwritten.
-
-When the user selects to save the profile then -profilepage.php will check the input for correctness.
-First the values are converted to the correct type (checkbox -> -Boolean) by checking $_SESSION['profile_types']. -Then LAM will replace all "\'" with  "'" if magic_quotes_gpc is on. Now the -input data is checked for correctness by calling checkProfileOptions().
-The account modules return a -list of -error messages if one or more options are incorrect. If there are -errors they will be displayed, otherwise the profile is -saved by calling saveAccountProfile().
-
-

Profiledelete.php

-When the user selected to delete a profile in profilemain.php he is redirected to -this page.
-
-LAM will ask once again if the user is sure to delete the profile. If -this is the case the profile will be deleted with delAccountProfile() from profiles.inc.
-
-
-
-
-
-
- \ No newline at end of file diff --git a/lam-web/developers/devel/profile_files.htm b/lam-web/developers/devel/profile_files.htm deleted file mode 100644 index 41825e89..00000000 --- a/lam-web/developers/devel/profile_files.htm +++ /dev/null @@ -1,37 +0,0 @@ - - - - - Account profiles - - - - -

Account profiles

-
-Every account profile is saved as single file in config/profiles. The -file extension is the account type (user, group, ...).
-In contrast to the configuration profiles the account profiles are not -designed to be editable by hand. They do not allow to add comments and -have a simpler format.
-
-

Format

-There is one option per line which is formated: <identifier>: -<value>
-
-Identifier is the option's name, value is the rest of the line after -the first ": ".
-Some options are multi-valued, the sub-values are separated by "+::+".
-
-
-Examples:
-
-posixAccount_primaryGroup: group1
-posixAccount_additionalGroup: group3+::+group4+::+group5+::+group6
-
- - diff --git a/lam-web/developers/devel/profiles.htm b/lam-web/developers/devel/profiles.htm deleted file mode 100644 index 42eac39b..00000000 --- a/lam-web/developers/devel/profiles.htm +++ /dev/null @@ -1,26 +0,0 @@ - - - - - Account profiles - - - - -

profiles.inc

-
-This file includes all functions to manage account -profiles. You can read/store/list/delete profiles.
-
-Profile names may contain letters, numbers, "_" and "-". All functions -which have a profile name as parameter check this.
-Functions which modify the filesystem (saveAccountProfile, -delAccountProfile) also check if the user is logged in to LAM -for security reasons. This is done by reading $_SESSION['logedIn'].
-
-
-
- - diff --git a/lam-web/developers/devel/samba_domains.htm b/lam-web/developers/devel/samba_domains.htm deleted file mode 100644 index 58cdc66e..00000000 --- a/lam-web/developers/devel/samba_domains.htm +++ /dev/null @@ -1,36 +0,0 @@ - - - - - Samba 3 domains - - - - -

Samba 3 domains
-

-

-
-

-
The Samba -3 domain list is based on the other account lists. The -difference is that there are no filter boxes and the displayed -attributes are fixed (name, SID, DN).
-
-If the user selects to edit or create a domain he will be redirected to -domain.php which manages the -domain objects in LDAP.
-
-
-

domain.php

-This script manages domain objects. It allows the user to create -domains or to modify values.
-The domain name, SID and RIDbase cannot be changed by the user because -this could cause trouble on the clients.
-
-
-
-
- - diff --git a/lam-web/developers/devel/style/layout.css b/lam-web/developers/devel/style/layout.css deleted file mode 100644 index 61a0fb85..00000000 --- a/lam-web/developers/devel/style/layout.css +++ /dev/null @@ -1,57 +0,0 @@ - /* -$Id$ - - This code is part of LDAP Account Manager (http://www.sourceforge.net/projects/lam) - Copyright (C) 2004 - 2006 Roland Gruber - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more detaexils. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -*/ - -/* CSS layout for LAM development documentation */ - - - -h1,h2,h3,h4 { - color:#0c12b7; -} - -/* links */ -a { - color:blue; - text-decoration:none; -} - -a:visited { - color:blue; - text-decoration:none; -} - -a:hover { - color:red; - text-decoration:none; -} - -a:active { - color:red; - text-decoration:none; -} - - -/* module HowTo */ - -table.mod-code { - background-color:#fffde2; -} diff --git a/lam-web/developers/devel/tree_schema.htm b/lam-web/developers/devel/tree_schema.htm deleted file mode 100644 index a4cebc88..00000000 --- a/lam-web/developers/devel/tree_schema.htm +++ /dev/null @@ -1,22 +0,0 @@ - - - - - Tree view and schema browser - - - - -

Tree view and schema browser
-

-
-
-These parts are based on phpLDAPadmin.
-The two tools are located in templates/schema -and templates/tree.
-
- - diff --git a/lam-web/developers/devel/type_basics.htm b/lam-web/developers/devel/type_basics.htm deleted file mode 100644 index 35b155c7..00000000 --- a/lam-web/developers/devel/type_basics.htm +++ /dev/null @@ -1,71 +0,0 @@ - - - - Type HowTo - Basic concepts - - - - -
-

Type HowTo - Basic concepts
-

-
-
-

-

1. Licensing

-LAM is licensed under the GNU -General Public License. This means your plugins need a compatible -license.
-LAM is distributed with a copy of the GPL license.
-
-
-

2. Naming and position in directory structure

-Type names are usually named after the group of accounts they manage. -However, you can use any name you want, it should be short and -containing only a-z and 0-9. The type name is only shown in the -configuration dialog, on all other pages LAM will show a provided alias name.
-All type modules are stored in lib/types. -The filename must end with .inc -and the file must have the same name as its inside class.
-
-Example: -Our example module will provide the class -smbDomain, -therefore the file will be called lib/types/smbDomain.inc.
-
-
-

3. Defining the class

-All type classes have baseType -as parent class. This provides common functionality and dummy functions -for all required class functions.
-
-Example:
-
- - - - - - -
/**
-* The account type for Samba domains.
-*
-* @package types
-*/
-class
smbDomain extends baseType {
-
-}
-
-
-
-

-
-
- - diff --git a/lam-web/developers/devel/type_css.htm b/lam-web/developers/devel/type_css.htm deleted file mode 100644 index b14b2517..00000000 --- a/lam-web/developers/devel/type_css.htm +++ /dev/null @@ -1,40 +0,0 @@ - - - - Type HowTo - CSS file - - - - -
-

Type HowTo - CSS file

-
-

-Every account type has its own style sheet where it can define colors -and fonts.
-
-
-

1. File name

-The CSS files are saved in style/. -Your file must be named type_<your -type>.css.
-
-Example:
-
-The smbDomain type has the -CSS file style/type_smbDomain.css.
-
-
-

2. Contents

-Take the type_user.css file as template. It is well documented.
-You have to replace all occurrences of "user" with your account type.
-
-Example:
-
-Take a look at type_user.css and type_smbDomain.css.
-
-
- - diff --git a/lam-web/developers/devel/type_general.htm b/lam-web/developers/devel/type_general.htm deleted file mode 100644 index 73f8774f..00000000 --- a/lam-web/developers/devel/type_general.htm +++ /dev/null @@ -1,91 +0,0 @@ - - - - Type HowTo - General type options - - - - -
-

Type HowTo - General type options
-

-
-
-

-

1. Alias name

-The type name is very limited, therefore every type has an alias name. This alias name has no limitations and -can be translated. It may contain special characters but make sure that -it does not contain HTML special characters like "<".
-
-The alias name is specified -with getAlias().
-
-Example:
-
-Our smbDomain type will get -the alias "Samba domains".
-
- - - - - - -
    /**
-    * Returns the alias name of this account type.
-    *
-    * @return string alias name
-    */
-    function - getAlias() {
-        return _("Samba domains");
-    }
-
-
-
-

2. Description
-

-Each type has a description so that the user knows what accounts he can -manage with that type. The description is displayed in the LAM -configuration editor.
-
-The description is specified with getDescription().
-
-Example:
-
-Our smbDomain type has the -description "Samba 3 domain entries".
-
- - - - - - -
    /**
-    * Returns the description of this account type.
-    *
-    * @return string description
-    */
-    function - getDescription() {
-        return _("Samba 3 domain -entries");
-    }
-
-
-
- -

-
-
- - diff --git a/lam-web/developers/devel/type_icon.htm b/lam-web/developers/devel/type_icon.htm deleted file mode 100644 index a614b4d0..00000000 --- a/lam-web/developers/devel/type_icon.htm +++ /dev/null @@ -1,32 +0,0 @@ - - - - Type HowTo - Icon - - - - -
-

Type HowTo - Icon

-
-

-You have to provide an icon for your account type. This icon is -displayed in the upper frame next to the link to your account list.
-The format of the image must be PNG -and the size should be between 20x20 -and 25x25 pixels.
-
-The file is stored in graphics/ -with the file name <your -type>.png.
-
-
-Example:
-
-The smbDomain type has the -icon graphics/smbDomain.png.
-
-
- - diff --git a/lam-web/developers/devel/type_index.htm b/lam-web/developers/devel/type_index.htm deleted file mode 100644 index efe3d204..00000000 --- a/lam-web/developers/devel/type_index.htm +++ /dev/null @@ -1,37 +0,0 @@ - - - - LAM type HowTo - - - - -
-

Type HowTo

-
-
If you write new account modules they -may not fit in the existing group of account types (user, group, host, -...). In this case you can easily create a new account type.
-This document provides a step-by-step description to build a type -module. The smbDomain -module which handles Samba domains is used as example.
-
-
-
-

1. Defining the type
-

-

1. Basic concepts
-

-

2. General type options

-

3. Custom list view

-
-
-

2. The default profile

-
-

3. List icon

-
-

4. Type specific CSS file

-
-
- - diff --git a/lam-web/developers/devel/type_list.htm b/lam-web/developers/devel/type_list.htm deleted file mode 100644 index e3a861f0..00000000 --- a/lam-web/developers/devel/type_list.htm +++ /dev/null @@ -1,182 +0,0 @@ - - - - Type HowTo - Custom list view - - - - -
-

Type HowTo - Custom list view
-

-
-
-

-

1. Default list attributes
-

-Here you can specify what attributes are shown as default in the list -view.
-
-The default attributes are -specified -with getDefaultListAttributes().
-
-Example:
-
-Our smbDomain type will show -the attributes "#sambaDomainName;#sambaSID" by default.
-
- - - - - - -
    /**
-    * Returns the default attribute list for this -account type.
-    *
-    * @return string attribute list
-    */
-    function getDefaultListAttributes() {
-        return -"#sambaDomainName;#sambaSID";
-    }
-
-
-
-

2. Pretranslated attribute descriptions
-

-You can provide translated descriptions for common attributes. This way -the user only specifies the attributes and LAM will show a description -for each language.
-
-The descriptions are specified with getListAttributeDescriptions().
-
-Example:
-
-Our smbDomain type has -descriptions for sambaSID and sambaDomainName.
-
- - - - - - -
    /**
-    * Returns a list of attributes which have a -translated description.
-    * This is used for the head row in the list view.
-    *
-    * @return array list of descriptions
-    */
-    function getListAttributeDescriptions() {
-        return array(
-            "sambaSID" -=> _("Domain SID"),
-            -"sambaDomainName" => _("Domain name")
-            );
-    }
-
-
-
-
-

3. Specifying a custom list view

-The default list view has only very generic labels for the buttons and -navigation bar. So you should at least provide some new labels which -fit to your type.
-
-The class name of your list view is specified with getListClassName().
-
-Example:
-
-Our smbDomain type sets the -list view class to lamSmbDomainList. -The list class is defined in the same file as your type class -(smbDomain.inc in this case).
-The labels are set in the constructor. Do not forget to call the parent -constructor first.
-
-If you want to change more than just the labels, take a look at lib/lists.inc and lib/types/user.inc. When a list is -displayed then the showPage() -function is called. You can overwrite this function to display a -completly new list or just one of the other functions.
-
- - - - - - -
/**
-* Returns the class name for the list object.
-*
-* @return string class name
-*/
-function getListClassName() -{
-    return "lamSmbDomainList";
-}
-
-
-/**
- * Generates the list view.
- *
- * @package lists
- * @author Roland Gruber
- *
- */
-class lamSmbDomainList -extends lamList {
-
-    /**
-     * Constructor
-     *
-     * @param string $type account type
-     * @return lamList list object
-     */
-    function lamSmbDomainList($type) {
-        parent::lamList($type);
-        $this->labels = array(
-            'nav' => -_("%s domain(s) found"),
-            -'error_noneFound' => _("No domains found!"),
-            'newEntry' -=> _("New domain"),
-            'deleteEntry' -=> _("Delete domain"),
-            'createPDF' -=> _("Create PDF for selected domain(s)"),
-            'createPDFAll' -=> _("Create PDF for all domains"));
-    }
-
-}
-
-
-
-
-
- -

-
-
- - diff --git a/lam-web/developers/devel/type_profile.htm b/lam-web/developers/devel/type_profile.htm deleted file mode 100644 index a0daf8a5..00000000 --- a/lam-web/developers/devel/type_profile.htm +++ /dev/null @@ -1,28 +0,0 @@ - - - - Type HowTo - Default profile - - - - -
-

Type HowTo - Default profile

-
-

-You have to provide a default profile for your account type. If you do -not want to specify default values then just provide an empty file.
-Save your profile as default.<your -type> in config/profiles.
-
-
-Example:
-
-The smbDomain type has only -an empty default profile. It is saved as config/profiles/default.smbDomain.
-
-
- - diff --git a/lam-web/developers/devel/types-specification.htm b/lam-web/developers/devel/types-specification.htm deleted file mode 100644 index e6f8658d..00000000 --- a/lam-web/developers/devel/types-specification.htm +++ /dev/null @@ -1,145 +0,0 @@ - - - - - Type specification - - - - -

This document describes the type -interface for LDAP Account Manager

-
-Account types are used to manage a group of accounts by grouping one or -more account modules. Examples for account types are user, group, host -and smbDomain.
-
-

1. Location and naming of types
-

-All LAM types are placed in lib/types/ and are named "<class -name>.inc".
-E.g. if you create a new type and its class name is "myUser" then the -filename would be "myUser.inc".
-
-The class name of a type must contain only a-z, A-Z, 0-9, -, and _.
-All type classes should extend the baseType class.
-
-

2. Functions

-

2.1. getAlias
-

-
- - - - - - -
function getAlias()
-
-
-Returns the alias name for -this type. E.g. the alias for smbDomain is "Samba domains".
-
-

2.2. getDescription
-

-
- - - - - - -
function getDescription()
-
-
-Returns a description for the -account type. This should be a short sentence describing the account -type.
-
-

2.3. getListClassName
-

-
- - - - - - -
function getListClassName()
-
-
-Here you can specify your own class to handle the list view. The class -must be a subclass of lamList.
-
-

2.4. getDefaultListAttributes
-

-
- - - - - - -
function getDefaultListAttributes()
-
-
-Returns the default setting -for the displayed list attributes. It is used as default for config and -the syntax is equal to the config setting.
-
-

2.5. getListAttributeDescriptions
-

-
- - - - - - -
function getListAttributeDescriptions()
-
-
-Returns a hash array which contains predefined, translated descriptions -of LDAP attributes.
-
-
-Example:

-
-return array(
-    "sambaSID" => _("Domain SID"),
-    "sambaDomainName" => _("Domain name")
-    );
-
-
-
-
-
- - - diff --git a/lam-web/developers/devel/upgrade.htm b/lam-web/developers/devel/upgrade.htm deleted file mode 100644 index dc84d995..00000000 --- a/lam-web/developers/devel/upgrade.htm +++ /dev/null @@ -1,179 +0,0 @@ - -Upgrade notes - - - - - - - - - - - - - - - -
-

Upgrade notes

- - -

2.1.0 -> 2.2.0

-

Account lists

-Account lists now support to define tools. These are displayed as linked images like the edit and delete links in the list.
- -Overwrite lamList::getAdditionalTools() to use this feature.
- -
- -The definition of account list options changed. The function lamList::getAdditionalTools() is no longer available. Use these functions instead: lamList::listGetAllConfigOptions() and lamList::listConfigurationChanged().
- -All options are now saved in cookies for one year.
- -
-

Base module

- - -The baseModule class has a new protected option: $autoAddObjectClasses You can set it to false if you do not want that your module's object classes are added when creating or loading an account.
- -
- -Account modules can now have icons. See baseModule->getIcon().
- - -
-

Constructors

-LAM now uses the PHP5 syntax for constructors: __construct()
-
-
-

Extended security model

-Each server profile now defines an access level.
-
-Currently these are:
-
    -
  • write access
  • -
  • password changes
  • -
  • read access
    -
  • -
- Please check your code and prohibit any actions which do not fit the current access level.
-There are two new functions in security.inc: checkIfWriteAccessIsAllowed() and checkIfPasswordChangeIsAllowed()
-Only LAM Pro allows to change the access level from write access to a smaller level.
-
-
- - -

2.0.0 -> 2.1.0

- -Style changes:
- -
    - -
  • "fieldset.<type>edit fieldset" and "fieldset.<type>edit fieldset fieldset" were removed.
  • -
  • "table.<type>list input" changed to "table.<type>list input,select"
  • -
- -baseModule:
- -  The class variable $base is no longer visible in child classes. Please use $this->getAccountContainer() to access the accountContainer object.
- -
- -Several other class variables in accountContainer etc. are now private. Use the new access methods.
- -
- -
- -

1.3.0 -> 2.0.0

- -LAM is now PHP5 only. Several variables are now private and need to be accessed via functions.
- -
- -
- -

1.2.0 -> 1.3.0

- -New lamList function:
- -
    - -
  • listPrintTableCellContent(): -This function allows you to control how the LDAP attributes are -displayed in the table. This can be used to display links or binary -data.
  • -
  • listPrintAdditionalOptions(): -If you want to display additional conrols for a list please use this -function. The controls will be placed under the account table.
    -
  • -
- -No more lamdaemon commands via delete_attributes() and save_attributes() in account modules.
- -Please use these new functions to call lamdaemon directly:
- -
    - -
  • preModifyActions()
  • -
  • postModifyActions()
  • -
  • preDeleteActions()
  • -
  • postDeleteActions()
  • -
- -
- -

1.1.x -> 1.2.0

- -API changes:
- -
    - -
  • removed get_configDescription() from module interface
  • -
- -
- -

1.0.4 -> 1.1.0

- -API changes:
- -
    - -
  • removed $post parameters from module functions (delete_attributes(), process_...(), display_html_...()). Use $_POST instead.
  • -
  • process_...() -functions: returned messages are no longer grouped (e.g. return: -array(array('INFO', 'headline', 'text'), array('INFO', 'headline2', -'text2')))
  • -
- -
- -

1.0.0 -> 1.0.2

- - - -New module functions:
- -
    - -
  • getRequiredExtensions: Allows to define required PHP extensions
  • -
  • getManagedObjectClasses: Definition of managed object classes for this module
  • -
  • getLDAPAliases: list of LDAP alias names which are replaced by LAM
  • -
  • getManagedAttributes: list of LDAP attributes which are managed by this module
  • -
- -The LDAP attributes are no longer loaded by reading the LDAP schema. If -your module does not implement the load_attributes() function then you -have to use getManagedAttributes() or the meta data to specify them.
- -
- -The class variable "triggered_messages" in baseModule was removed.
- - - - -
- \ No newline at end of file diff --git a/lam-web/developers/devel/upload.htm b/lam-web/developers/devel/upload.htm deleted file mode 100644 index 95be92be..00000000 --- a/lam-web/developers/devel/upload.htm +++ /dev/null @@ -1,103 +0,0 @@ - - - - - File upload - - - - -

File upload
-

-
-
upload
-

-

Account selection (masscreate.php)
-

-This is the initial page of the file upload. The user selects the -account type for the new upload.
-
-
-

Attribute overview (masscreate.php)

-After the account selection LAM will display an overview of the -possible and required input columns.
-The DN attributes (DN suffix and RDN) are static and are always -displayed. The default suffix is read from config with getAccountSuffix() and the list of -RDN possibilities is taken from modules.inc - getRDNAttributes().
-The next attributes are read from modules.inc - getUploadColumns(). LAM will display -all attributes of one module in a separate fieldset. The getUploadColumns() function also -returns if an attribute is required and additional information like an -example value.
-
-After clicking the upload button the user will be forwarded to the -account building page.
-
-
-

Account building (massBuildAccounts.php)
-

-This part takes the submitted CSV file -and generates the LDAP accounts.
-
-The scripts separates the head row from the data rows in the CSV file. -The head array is used to find the position of the input values. The -data array contains one subarray for each account.
-
-After the data has been extracted there are some basic checks done, -e.g. checking required and unique columns. The modules provide the -necessary information for this.
-
-Then all data is given to the modules with buildUploadAccounts() in -modules.inc. They return a list of accounts which can be uploaded with ldap-add() and generate possible -error messages.
-
-If the accounts are built the script will give the user the possibility -to check the result with an LDIF-file -or to do the upload.
-
-
-

LDIF export (massBuildAccounts.php)
-

-LAM simply takes the built accounts and generates an LDIF-file from them. This is passed -to the user's browser.
-The LDIF-file will only -contain the accounts itself. If modules do additional tasks after the -upload (e.g. adding users to groups) this will not be covered.
-
-
-

Account creation (massDoUpload.php)
-

-This script finally uploads the LDAP accounts with ldap_add().
-
-The upload can last longer than the maximum execution time of PHP. -Therefore the script will check regulary how much time is left and -pause the upload. This is resumed with a meta refresh which loads the -script again.
-
-After all accounts were created in LDAP the modules may do additional -tasks. LAM will call doUploadPostActions() -and also provide a list of failed accounts which can be ignored. The -function is called as long the returned status is "inProgress". The script uses again -a -meta refresh to handle the maximum execution time.
-Typical post actions are setting quotas or adding an user to groups.
-
-A progress bar is shown for the LDAP adding and the module actions to -give the user a hint how long it will still take.
-
-
- - diff --git a/lam-web/developers/docs.htm b/lam-web/developers/docs.htm deleted file mode 100644 index 80322358..00000000 --- a/lam-web/developers/docs.htm +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Developer documentation

-
-

Code overview

-

These pages describe the architecture of LAM and how the different parts work together.

-
- -

Module interface

-

The interface definition of the account modules.

-
- -

HowTo for writing account modules

-

A step-by-step HowTo for writing your own account modules.

-
- -

FAQ

-

Answers to the most important questions.

-
- -

Function and class reference (PHPDoc)

-

All classes and functions have PHPDoc comments. Here you find descriptions for each class and function including their parameters.

-
- - -
- - - - diff --git a/lam-web/documentation/LAMPro-HowTo/ch01.html b/lam-web/documentation/LAMPro-HowTo/ch01.html deleted file mode 100644 index a5d40088..00000000 --- a/lam-web/documentation/LAMPro-HowTo/ch01.html +++ /dev/null @@ -1,10 +0,0 @@ -Chapter 1. Self service

Chapter 1. Self service

Preparations

OpenLDAP ACLs

By default only a few administrative users have write access to - the LDAP database. Before your users may change their settings you - must allow them to change their LDAP data.

This can be done by adding an ACL to your slapd.conf which looks - like this:

access to

- attrs=mail,sn,givenName,telephoneNumber,mobile,facsimileTelephoneNumber,street,postalAddress,postOfficeBox,postalCode,password

by self write

If you do not want them to change all attributes then reduce the - list to fit your needs. Some modules may require additional LDAP - attributes.

Usually, the slapd.conf file is located in /etc/ldap or - /etc/openldap.

Other LDAP servers

There exist many LDAP implementations. If you do not use - OpenLDAP you need to write your own ACLs. Please check the manual of - your LDAP server for instructions.

diff --git a/lam-web/documentation/LAMPro-HowTo/ch01s02.html b/lam-web/documentation/LAMPro-HowTo/ch01s02.html deleted file mode 100644 index 7c3751f1..00000000 --- a/lam-web/documentation/LAMPro-HowTo/ch01s02.html +++ /dev/null @@ -1,7 +0,0 @@ -Creating a self service profile

Creating a self service profile

A self service profile defines what input fields your users see - and some other general settings like the login caption.

When you go to the LAM configuration page you will see the self - service link at the bottom. This will lead you to the self service - configuration pages

Now we need to create a new self service profile. Click on the - link to manage the self service profiles.

Specify a name for the new profile and enter you master - configuration password (default is "lam") to save the profile.

Now go back to the profile login and enter your master - configuration password to edit your new profile.

diff --git a/lam-web/documentation/LAMPro-HowTo/ch01s03.html b/lam-web/documentation/LAMPro-HowTo/ch01s03.html deleted file mode 100644 index a2a326b0..00000000 --- a/lam-web/documentation/LAMPro-HowTo/ch01s03.html +++ /dev/null @@ -1,11 +0,0 @@ -Edit your new profile

Edit your new profile

On top of the page you see the link to the user login page. Copy - this link address and give it to your users.

Below the link you can specify several options.

Table 1.1. General options

Server addressThe address of your LDAP server
LDAP suffixThe part of the LDAP tree where LAM should search for - users
LDAP user + passwordThe DN and password which is used to search for users in - the LDAP database. It is sufficient if this DN has only read - rights. If you leave these fields empty LAM will try to connect - anonymously.
LDAP search attributeHere you can specify if your users can login with user - name + password, email + password or other attributes.
Login attribute labelThis is the description for the LDAP search attribute. - Set it to something which your users are familiar with.
Login captionThis text is displayed at the login page. You can input - HTML, too.
Main page captionThis text is displayed at self service main page where - your users change their data. You can input HTML, too.

On the bottom you can specify what input fields your users can - see. It is also possible to group several input fields.

diff --git a/lam-web/documentation/LAMPro-HowTo/ch02.html b/lam-web/documentation/LAMPro-HowTo/ch02.html deleted file mode 100644 index e764dbc1..00000000 --- a/lam-web/documentation/LAMPro-HowTo/ch02.html +++ /dev/null @@ -1,6 +0,0 @@ -Chapter 2. Additional account modules

Chapter 2. Additional account modules

LAM Pro provides some more account modules to support additional - LDAP object classes.

Currently these are:

  • groupOfNames

  • groupOfUniqueNames

These classes can be used to represent group relations. Since they - allow DNs as members you can also use them to represent nested - groups.

Managing group of (unique) names

Group of (unique) names have four basic attributes:

  • Name: a unique name for the group

  • Description: optional description

  • Owner: the account which owns this group (optional)

  • Members: the members of the group (at least one is - required)

You can add any accounts as members. This includes other groups - which leads to nested groups.

diff --git a/lam-web/documentation/LAMPro-HowTo/ch03.html b/lam-web/documentation/LAMPro-HowTo/ch03.html deleted file mode 100644 index 4b66b7a5..00000000 --- a/lam-web/documentation/LAMPro-HowTo/ch03.html +++ /dev/null @@ -1,6 +0,0 @@ -Chapter 3. Access levels and passwort reset

Chapter 3. Access levels and passwort reset

You can define different access levels for each profile to allow or - disallow write access. The password reset page helps your deskside support - staff to reset user passwords.

Access levels

There are three access levels:

  • Write access (default)

    There are no restrictions. LAM admin users can manage account, - create profiles and set passwords.

  • Change passwords

    Similar to "Read only" except that the password reset page is available.

  • Read only

    No write access to the LDAP database is allowed. It is also - impossible to manage account and PDF profiles.

    Accounts may be viewed but no changes can be saved.

The access level can be set on the server configuration - page:

diff --git a/lam-web/documentation/LAMPro-HowTo/ch03s02.html b/lam-web/documentation/LAMPro-HowTo/ch03s02.html deleted file mode 100644 index 226a3fba..00000000 --- a/lam-web/documentation/LAMPro-HowTo/ch03s02.html +++ /dev/null @@ -1,19 +0,0 @@ -Password reset page

Password reset page

This special page allows your deskside support staff to reset the - Unix and Samba passwords of your users. If you set the access level to "Change passwords" then - LAM will not allow any changes to the LDAP database except password - changes via this page. The account pages will be still available in - read-only mode.

You can open the password reset page by clicking on the key symbol - on each user account:

There are three different options to set a new - password:

  • set random password and display it on - screen

    This will set the user's password to a random value. The - password will be 11 characters long with a random combination of - letters, digits and ".-_".

    You may want to use this method to tell users their new - passwords via phone.

  • set random password and mail it to - user

    If the user account has set the mail attribute then LAM can - send your user a mail with the new password. You can change the mail - template to fit your needs. See the help link for further - details.

    Using this method will prevent that your support staff knows - the new password.

  • set specific password

    Here you can specify your own password.

LAM will display contact information about the user like the - user's name, email address and telephone number. This will help your - deskside support to easily contact your users.

If a user account has Samba passwords set then LAM will offer to - synchronize the passwords.

diff --git a/lam-web/documentation/LAMPro-HowTo/images/accessLevel.png b/lam-web/documentation/LAMPro-HowTo/images/accessLevel.png deleted file mode 100644 index 246a2722..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/accessLevel.png and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/images/conf1.jpg b/lam-web/documentation/LAMPro-HowTo/images/conf1.jpg deleted file mode 100644 index 60c6b4ab..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/conf1.jpg and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/images/conf2.jpg b/lam-web/documentation/LAMPro-HowTo/images/conf2.jpg deleted file mode 100644 index 398c98d7..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/conf2.jpg and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/images/conf3.jpg b/lam-web/documentation/LAMPro-HowTo/images/conf3.jpg deleted file mode 100644 index 07568fd8..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/conf3.jpg and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/images/conf4.jpg b/lam-web/documentation/LAMPro-HowTo/images/conf4.jpg deleted file mode 100644 index f58c5784..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/conf4.jpg and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/images/conf5.jpg b/lam-web/documentation/LAMPro-HowTo/images/conf5.jpg deleted file mode 100644 index feefc67a..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/conf5.jpg and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/images/groupOfNames1.png b/lam-web/documentation/LAMPro-HowTo/images/groupOfNames1.png deleted file mode 100644 index 9392f565..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/groupOfNames1.png and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/images/passwordReset1.png b/lam-web/documentation/LAMPro-HowTo/images/passwordReset1.png deleted file mode 100644 index 5a764253..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/passwordReset1.png and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/images/passwordReset2.png b/lam-web/documentation/LAMPro-HowTo/images/passwordReset2.png deleted file mode 100644 index 02220736..00000000 Binary files a/lam-web/documentation/LAMPro-HowTo/images/passwordReset2.png and /dev/null differ diff --git a/lam-web/documentation/LAMPro-HowTo/index.html b/lam-web/documentation/LAMPro-HowTo/index.html deleted file mode 100644 index f19ead1b..00000000 --- a/lam-web/documentation/LAMPro-HowTo/index.html +++ /dev/null @@ -1 +0,0 @@ -LDAP Account Manager Pro - HowTo diff --git a/lam-web/documentation/LAMPro-HowTo/style.css b/lam-web/documentation/LAMPro-HowTo/style.css deleted file mode 100755 index d5be8738..00000000 --- a/lam-web/documentation/LAMPro-HowTo/style.css +++ /dev/null @@ -1,59 +0,0 @@ -/* body { background-color:#F5F5F5; } */ - -body { - font-family:sans-serif; -} - -a { -color:#000080; -text-decoration:none; -} - -a:visited { -color:#000080; -text-decoration:none; -} - -a:hover { -color:red; -text-decoration:none; -} - -a:active { -color:red; -text-decoration:none; -} - -div.navheader td { - font-weight:bold; -} - -div.navfooter td { - font-weight:bold; -} - -div.table table { - border-collapse:collapse; - border-width:2px; -} - -div.navheader hr { - margin-bottom:30px; -} - -div.navfooter hr { - margin-top:30px; -} - -div.mediaobject img { - margin-top:20px; - margin-bottom:20px; -} - -h1 { color:#253aa3; } -h2 { color:#000080; font-size:13pt; } - -table { border-color:#253aa3; border-style:solid; } -th { font-size:12pt; font-weight:bold; height:21px; color:#253aa3; } -td { padding-left: 15px; font-size:12pt; } - diff --git a/lam-web/documentation/LDAP-Account-Manager-Dokumentation.pdf b/lam-web/documentation/LDAP-Account-Manager-Dokumentation.pdf deleted file mode 100644 index 12cd9ca7..00000000 Binary files a/lam-web/documentation/LDAP-Account-Manager-Dokumentation.pdf and /dev/null differ diff --git a/lam-web/documentation/faq.htm b/lam-web/documentation/faq.htm deleted file mode 100644 index 79ea2589..00000000 --- a/lam-web/documentation/faq.htm +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - LAM - FAQ - - - - - - - - - -
  - - -

FAQ

-
-
-
I want to change -the preferences but I do not know -the password.
-
- I get strange errors (e.g. object class violation/invalid syntax) when saving accounts.
-
- What is the syntax -of the filter fields in the account lists?
-
LDAP + SSL does not work.
-
I found a bug. -Where can I report it?
-
My question is not on the -list. Where can I find help?
-
-
-
-
-I want to change -the preferences but I do not know the password.
-
-
When you install LDAP -Account Manager the password for the default profile and the master -password are "lam".
-
-
-
- I get strange errors (e.g. object class violation/invalid syntax) when saving accounts.
-
-Probably, your LDAP server does not offer the required LDAP object classes and attributes.
-To check the LDAP schema open Tools -> Tests -> Schema test and check if any errors are reported.
-
-See docs/README.schema.txt for the required schema files.
-
-
-
What is the -syntax of the filter -fields in the account lists?
-
-
LDAP Account Manager -searches for "(attribute=<filter field>)".
-
-You can do simple filtering like: a*, *nix, groupname
-
-There are several limitations: If you only enter "*", LDAP will return -all accounts with the attribute set. Numeric fields cannot use the -"*", only exact matchings are possible.
-
-
-
-LDAP + SSL does not -work.
-
-
PHP uses the LDAP settings -in /etc/ldap.conf (you will have to create this file on some -distributions).
-Use the "LDAPTLS_CACERT" setting to specify your CA certificate.
-
-
-
-I found a bug. Where can I report it?
-
-
Please use the Bug Tracker at our Sourceforge homepage -or subscribe to our public mailinglist.
-
-If the problem is related to LDAP, please add some logging information. -In /etc/ldap/slapd.conf turn logging on with the line "loglevel 256". -OpenLDAP uses /var/log/syslog for log output.
-
-
-
-My question is not on the list. Where -can I find help?
-
-
Please subscribe to our -public mailinglist. - -
- - \ No newline at end of file diff --git a/lam-web/documentation/howto.htm b/lam-web/documentation/howto.htm deleted file mode 100755 index d702c4e8..00000000 --- a/lam-web/documentation/howto.htm +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - -
  -

HOWTOs

-
-

Here you will find a set of HOWTOs related with LDAP Account -Manager, LDAP and SMB/Samba. We are alwalys looking for good new HOWTOs -or other documentation that might help our users. So if you know a good -HOWTO, please let us know about it. We will take a look at it and then -link it on this site.

- -
- - - \ No newline at end of file diff --git a/lam-web/documentation/index.htm b/lam-web/documentation/index.htm deleted file mode 100755 index e57cf8e1..00000000 --- a/lam-web/documentation/index.htm +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

User documentation
-

-
-

Readme

-

Installation

-

FAQ

-

HOWTOs

-

Supported account types

- -

 


- -
- - - - diff --git a/lam-web/documentation/install.htm b/lam-web/documentation/install.htm deleted file mode 100644 index f160aa8d..00000000 --- a/lam-web/documentation/install.htm +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - - -

Installation
-

-
-

1. Requirements

-
   - Apache webserver (SSL optional) with PHP module (PHP 5 (>= 5.1) with
ldap, gettext, xml and optional mcrypt)
- some LAM plugins may require additional PHP extensions (you will get a
note on the login page if something is missing)
- Perl (optional, needed only for lamdaemon)
- OpenLDAP (>2.0)
- A web browser :-)

MHash is only needed for Samba password hashes.
MCrypt will be used to store your LDAP password encrypted in the session file.


See docs/README.schema.txt for information about used LDAP schema files.
- -
-

2. Installation

- -
   1. Extract package with:
tar xzf ldap-account-manager-<version>.tar.gz

2a. Copy the files into the html-file scope of the webserver. For example
/apache/htdocs.

Set appropriate file permissions:
- lam/sess: write permission for apache user
- lam/tmp: write permission for apache user
- lam/config (with subdirectories): write permission for apache user
- lam/lib: lamdaemon.pl must be set executable (See also
docs/readme.lamdeamon.txt)

2b. You can also use the included configure script to install LAM. See
"./configure --help" for a list of install options.

3. Configure config.cfg and create a configuration profile.
Copy config.cfg_sample to config.cfg and set the master password and default
profile.

Open the index.html in your web browser:
- Follow the link "Configuration Login" from the start page.
(The default password to edit the options is "lam")
- Select the default lam profile or create a new profile.
- Change the settings to fit your environment.

- -

3. Setting up PHP

-
   LAM runs with PHP5 (>= 5.1).

Needed changes in your php.ini:

* memory_limit = 64M
-
-
- - -
- - - - - - - - \ No newline at end of file diff --git a/lam-web/documentation/lam_de.pdf b/lam-web/documentation/lam_de.pdf deleted file mode 100644 index e7dad819..00000000 Binary files a/lam-web/documentation/lam_de.pdf and /dev/null differ diff --git a/lam-web/documentation/readme.htm b/lam-web/documentation/readme.htm deleted file mode 100644 index 1abd1963..00000000 --- a/lam-web/documentation/readme.htm +++ /dev/null @@ -1,312 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Readme

-
-  LDAP Account Manager (LAM) manages user, group and host accounts in an LDAP
-  directory. LAM runs on any webserver with PHP4/5 support and connects to your
-  LDAP server unencrypted or via SSL/TLS.
-  Currently LAM supports these account types: Samba 2 and 3, Unix, Kolab 2,
-  address book entries, NIS mail aliases and MAC addresses. There is a tree
-  viewer included to allow access to the raw LDAP attributes. You can use
-  templates for account creation and use multiple configuration profiles.
-  LAM is translated to Catalan, Chinese (Traditional), Dutch, English, French,
-  German, Hungarian, Italian, Japanese, Russian and Spanish.
-
-  http://sourceforge.net/projects/lam/
-
-    Copyright (C) 2003 - 2006 Michael Duergner 
-                              Roland Gruber 
-                              Tilo Lutz 
-
- -

Requirements:

-
-    PHP4/5
-    Openldap (2.0 or greater)
-    A web-browser that supports CSS
-
- -

Summary:

-
-    With LAM you can easily manage user, group and machine accounts stored in
-    an LDAP directory over a web interface. At the moment it supports:
-
-      - managing user/group/host/domain entries
-      - filtering and sorting
-      - account profiles
-      - multiple configuration profiles
-      - tree viwer
-      - schema browser
-      - OU Editor
-      - account creation via file upload
-      - PDF export for all accounts
-      - manage user/group Quota and create home directories
-
- -

Important:

-
-    The default password to edit the configuration options is "lam".
-
- -

Installation:

-
-    Please see the INSTALL file.
-
- -

Documentation:

-
-    Basic documentation is available in the directory "docs".
-
- -

Upgrade from older versions:

-
-    See docs/README.upgrade.txt for upgrade instructions.
-
- -

Internationalisation:

-
-    If you want to use a translated version of LAM be sure to install the
-    needed locales. See locale/ for a list of supported locales and languages.
-    Debian users can add locales with "dpkg-reconfigure locales".
-
- -

Security:

-
-    It is strongly recommended to use a SSL connection to your web server.
-
-    LAM needs to store your LDAP user name + password in the session. The session
-    files are saved in sess/ and are accessible only by the web server. To increase
-    security username and password are encrypted with MCrypt/AES if available.
-    The key and IV are generated at random when you log in. They are stored in two
-    cookies.
-
- -

Download:

-
-    You can get the newest version at ../.
-
- -

License:

-
-    LAM is published under the GNU General Public License.
-    The complete list of licenses can be found in the copyright file.
-
- -
-
- -
- - - - diff --git a/lam-web/documentation/supportedSchemas.htm b/lam-web/documentation/supportedSchemas.htm deleted file mode 100644 index a855b336..00000000 --- a/lam-web/documentation/supportedSchemas.htm +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - - -

Supported account types

-
-

This is a list of all supported account types and their schema -files. The account types can be combined (e.g. users with Samba and -Unix part)
-
-

- -

Unix

-
    -
  • Types: users and groups
  • -
  • Object classes: posixAccount, shadowAccount and posixGroup
  • -
  • Schema: nis.schema
  • -
- -

Samba 3

-
    -
  • Types: users, groups, hosts and domains
  • -
  • Object classes: sambaSamAccount, sambaGroupMapping, sambaDomain
  • -
  • Schema: samba.schema
  • -
- -

- -

-

Samba 2

- -
    -
  • Types: users and hosts
  • -
  • Object class: sambaAccount
  • -
  • Schema: samba.schema
  • -
- -

Kolab 2

-
    -
  • Type: users
  • -
  • Object class: kolabInetOrgPerson
  • -
  • Schema: kolab2.schema, rfc2739.schema
  • -
- -

Address book entries

-
    -
  • Type: users
  • -
  • Object class: inetOrgPerson
  • -
  • Schema: inetorgperson.schema
  • -
- -

Mail routing

-
    -
  • Type: users
  • -
  • Object class: inetLocalMailRecipient
  • -
  • Schema: misc.schema
  • -
- -

Mail aliases

-
    -
  • Type: groups
  • -
  • Object class: nisMailAlias
  • -
  • Schema: misc.schema
  • -
- -

Group of (unique) names (LAM Pro only)
-

-
    -
  • Type: groups
  • -
  • Object class: groupOfNames, groupOfUniqueNames
  • -
  • Schema: core.schema
  • -
- -

MAC addresses

-
    -
  • Type: hosts
  • -
  • Object class: ieee802device
  • -
  • Schema: nis.schema
  • -
- -

Simple Accounts

-
    -
  • Type: users
  • -
  • Object class: account
  • -
  • Schema: cosine.schema
  • -
- -

SSH keys (LPK patch)

-
    -
  • Type: users
  • -
  • Object class: ldapPublicKey
  • -
  • Schema: openssh-lpk.schema
  • -
- - -
- - - - - - \ No newline at end of file diff --git a/lam-web/download/debian.htm b/lam-web/download/debian.htm deleted file mode 100755 index 15921119..00000000 --- a/lam-web/download/debian.htm +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Debian packages

-
-

- - - - - -
- Debian users can get LDAP Account Manager by using the the official unstable branch of Debian or on our download page.
- LDAP Account Manager can be installed with "apt-get install ldap-account-manager".
-
The package is maintained by Roland Gruber (post@rolandgruber.de).
Thanks to Fabio Tranchitella who is sponsoring the package.
-

- -
- - - - diff --git a/lam-web/download/freebsd.htm b/lam-web/download/freebsd.htm deleted file mode 100644 index 57a00b90..00000000 --- a/lam-web/download/freebsd.htm +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

FreeBSD

-
-
-

LAM is part of the official FreeBSD ports tree. The port is maintained by Clement Laforet.

-
-

For more details see these pages:

-

FreeBSD-CVS: http://www.freebsd.org/cgi/cvsweb.cgi/ports/sysutils/ldap-account-manager

-

FreshPorts: http://www.freshports.org/sysutils/ldap-account-manager

- -
- - - - diff --git a/lam-web/download/index.htm b/lam-web/download/index.htm deleted file mode 100755 index 4cf67ad1..00000000 --- a/lam-web/download/index.htm +++ /dev/null @@ -1,424 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - -
  - - -

Downloads

Take a look at LDAP Account Manager Pro for more powerful features.
-
- -

-

- - - - - - - - - - - - - - - - -
LDAP Account Manager 2.3.0
-Source code - ldap-account-manager-2.3.0.tar.gz
-Debian package - ldap-account-manager_2.3.0-1_all.deb
-RPM package - ldap-account-manager-2.3.0-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 2.2.0
-Source code - ldap-account-manager-2.2.0.tar.gz
-Debian package - ldap-account-manager_2.2.0-1_all.deb
-RPM package - ldap-account-manager-2.2.0-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 2.1.0
-Source code - ldap-account-manager-2.1.0.tar.gz
-Debian package - ldap-account-manager_2.1.0-1_all.deb
-RPM package - ldap-account-manager-2.1.0-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 2.0.0
-Source code - ldap-account-manager-2.0.0.tar.gz
-Debian package - ldap-account-manager_2.0.0-1_all.deb
-RPM package - ldap-account-manager-2.0.0-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.3.0
-Source code - ldap-account-manager-1.3.0.tar.gz
-Debian package - ldap-account-manager_1.3.0-1_all.deb
-RPM package - ldap-account-manager-1.3.0-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.2.0
-Source code - ldap-account-manager-1.2.0.tar.gz
-Debian package - ldap-account-manager_1.2.0-1_all.deb
-RPM package - ldap-account-manager-1.2.0-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.1.1
-Source code - ldap-account-manager-1.1.1.tar.gz
-Debian package - ldap-account-manager_1.1.1-1_all.deb
-RPM package - ldap-account-manager-1.1.1-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.1.0
-Source code - ldap-account-manager-1.1.0.tar.gz
-Debian package - ldap-account-manager_1.1.0-1_all.deb
-RPM package - ldap-account-manager-1.1.0-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.0.4
-Source code - ldap-account-manager-1.0.4.tar.gz
-Debian package - ldap-account-manager_1.0.4-1_all.deb
-RPM package - ldap-account-manager-1.0.4-1.noarch.rpm
-


- -

-

-

Old releases

-


- -
- - - - \ No newline at end of file diff --git a/lam-web/download/oldReleases.htm b/lam-web/download/oldReleases.htm deleted file mode 100755 index 9e7fc6bf..00000000 --- a/lam-web/download/oldReleases.htm +++ /dev/null @@ -1,810 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Old releases

-
-

-

- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.0.3
-Source code - ldap-account-manager-1.0.3.tar.gz
-Debian package - ldap-account-manager_1.0.3-1_all.deb
-RPM package - ldap-account-manager-1.0.3-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.0.2
 - -Source code - ldap-account-manager-1.0.2.tar.gz
 - -Debian package - ldap-account-manager_1.0.2-1_all.deb
 - -RPM package - ldap-account-manager-1.0.2-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.0.1
 - -Source code - ldap-account-manager-1.0.1.tar.gz
 - -Debian package - ldap-account-manager_1.0.1-1_all.deb
 - -RPM package - ldap-account-manager-1.0.1-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.0.0
 - -Source code - ldap-account-manager-1.0.0.tar.gz
 - -Debian package - ldap-account-manager_1.0.0-1_all.deb
 - -RPM package - ldap-account-manager-1.0.0-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.0.rc2 (unstable)
 - -Source code - ldap-account-manager-1.0.rc2.tar.gz
 - -Debian package - ldap-account-manager_1.0.rc2-1_all.deb
 - -RPM package - ldap-account-manager-1.0.rc2-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 1.0.rc1 (unstable)
 - -Source code - ldap-account-manager-1.0.rc1.tar.gz
 - -Debian package - ldap-account-manager_1.0.rc1-1_all.deb
 - -RPM package - ldap-account-manager-1.0.rc2-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 0.5.3
 - -Source code - ldap-account-manager_0.5.3.tar.gz
 - -Debian package - ldap-account-manager_0.5.3-1_all.deb
 - -RPM package - ldap-account-manager-0.5.3-1.noarch.rpm
-


- - - - - - - - - - - - - - - - -
LDAP Account Manager 0.5.2
 - -Source code - ldap-account-manager_0.5.2.tar.gz
 - -Debian package - ldap-account-manager_0.5.2-1_all.deb
 - -RPM package - ldap-account-manager-0.5.2-1.noarch.rpm
-


-

- - - - - - - - - - - - -
LDAP Account Manager 0.5.1
 - -Source code - ldap-account-manager_0.5.1.tar.gz
 - -Debian package - ldap-account-manager_0.5.1-1_all.deb
-


-

-

-

- - - - - - - - - - - - -
LDAP Account Manager 0.5.0
 - -Source code - ldap-account-manager_0.5.0.tar.gz
 - -Debian package - ldap-account-manager_0.5.0-1_all.deb
-


-

-

-

- - - - - - - - - - - - -
LDAP Account -Manager 0.5.rc3 (unstable)
 - -Source code - ldap-account-manager_0.5.rc3.tar.gz
 - -Debian package - ldap-account-manager_0.4.10+0.5.rc3-1_all.deb
-


-

-

-

- - - - - - - - - - - - -
LDAP Account -Manager 0.5.rc2 (unstable)
 - -Source code - ldap-account-manager_0.5.rc2.tar.gz
 - -Debian package - ldap-account-manager_0.4.10+0.5.rc2-1_all.deb
-


-

-
- - - - - - - - - - - - -
LDAP Account -Manager 0.4.10
 - -Source code - ldap-account-manager_0.4.10.tar.gz
 - -Debian package - ldap-account-manager_0.4.10-1_all.deb
-


-

- - - - - - - - - - - - -
LDAP Account -Manager 0.4.9
 - -Source code - ldap-account-manager_0.4.9.tar.gz
 - -Debian package - ldap-account-manager_0.4.9_all.deb
-


-

- - - - - - - - - - - - -
LDAP Account -Manager 0.4.8
 - -Source code - ldap-account-manager_0.4.8.tar.gz
 - -Debian package - ldap-account-manager_0.4.8-1_all.deb
-


-

- - - - - - - - - - - - -
LDAP Account -Manager 0.4.7
 - -Source code - ldap-account-manager_0.4.7.tar.gz
 - -Debian package - ldap-account-manager_0.4.7-1_all.deb
-


-

- - - - - - - - - - - - -
LDAP Account -Manager 0.4.6
 - -Source code - ldap-account-manager_0.4.6.tar.gz
 - -Debian package - ldap-account-manager_0.4.6-3_all.deb
-


-

- - - - - - - - - - - - -
LDAP Account Manager 0.4.5
 - -Source -Code - ldap-account-manager_0.4.5.tar.gz
 - -DEB -File - ldap-account-manager_0.4.5-1_all.deb
-


-

- - - - - - - - - - - - -
LDAP Account Manager 0.4.4
 - -Source -Code - ldap-account-manager_0.4.4.tar.gz
 - -DEB -File - ldap-account-manager_0.4.4-1_all.deb
-


-

- - - - - - - - - - - - - - - -
LDAP Account -Manager 0.4.3
 - -Source -Code - ldap-account-manager_0.4.3.tar.gz
 - -DEB -File - ldap-account-manager_0.4.3-1_all.deb
 - -RPM -File - suse-9.0_ldap-account-manager_0.4.3-1.noarch.rpm
-


-

- - - - - - - - - - - - - - - -
LDAP Account -Manager 0.4.2
 - -Source -Code - ldap-account-manager_0.4.2.tar.gz
 - -DEB -File - ldap-account-manager_0.4.2-1_all.deb
 - -RPM -File - suse-9.0-LDAP-Account-Manager-0.4.2-1.noarch.rpm
-


-

- - - - - - - - - - - - - - - -
LDAP Account -Manager 0.4.1
 - -Source -Code - ldap-account-manager_0.4.1.tar.gz
 - -DEB -File - ldap-account-manager_0.4.1-1_all.deb
 - -RPM -File - suse-9.0-LDAP-Account-Manager-0.4.1-1.noarch.rpm
-


-

- - - - - - - - - - - - - - - -
LDAP Account -Manager 0.4
 - -Source -Code - LDAP-Account-Manager-0.4-0.tar.gz
 - -DEB -File - ldap-account-manager_0.4-2_all.deb
 - -RPM -File - suse-9.0-LDAP-Account-Manager-0.4-0.noarch.rpm
-


-

- - - - - - - - - - - - - - - -
LDAP Account -Manager 0.3
 - -Source -Code - LDAP-Account-Manager-0.3-1.tar.gz
 - -DEB -File - ldap-account-manager_0.3-1_all.deb
 - -RPM -File - suse-8.2-LDAP-Account-Manager-0.3-1.noarch.rpm
-


-

- - - - - - - - - - - - - - - -
LDAP Account -Manager 0.2
 - -Source -Code - LDAP-Account-Manager-0.2-1.tar.gz
 - -DEB -File - ldap-account-manager_0.2-1_all.deb
 - -RPM -File - suse-8.2-LDAP-Account-Manager-0.2-1.noarch.rpm
-


-

- - - - - - - - - - - - - - - -
LDAP Account -Manager 0.1
 - -Source -Code - LDAP-Account-Manager-0.1-1.tar.gz
 - -DEB -File - ldap-account-manager_0.1-1_all.deb
 - -RPM -File - suse-8.2-LDAP-Account-Manager-0.1-1.noarch.rpm
- -
- - - - diff --git a/lam-web/download/rpm.htm b/lam-web/download/rpm.htm deleted file mode 100755 index 7a40c48c..00000000 --- a/lam-web/download/rpm.htm +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

RPM packages

-
-

You can find up-to-date RPM packages in our Releases section.
-If you want to build the packages yourself then use this SPEC file. -

-Thanks to Iain Lea who maintains the RPM packages. -

- -


- -
- - - - diff --git a/lam-web/favicon.ico b/lam-web/favicon.ico deleted file mode 100644 index 1134d0c2..00000000 Binary files a/lam-web/favicon.ico and /dev/null differ diff --git a/lam-web/i18n/i18nhowto.htm b/lam-web/i18n/i18nhowto.htm deleted file mode 100755 index bcf12276..00000000 --- a/lam-web/i18n/i18nhowto.htm +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - -
  -

Translation HowTo
-

-

-
- Here is how our translation -system works:
-
-We use Gettext for -our translations. The .po files[1] contain all English strings -("msgid") in our
-project. You have to write the translation for each string in "msgstr". -The msgid must not be changed. -
-
-
- - - - - - - -
Example
- #: ../lib/lists.inc:474
- msgid "Change suffix"
- msgstr "" -
=> - #: ../lib/lists.inc:474
- msgid "Change suffix"
- msgstr "Suffix wechseln" -
-
-
-If you update an existing translation there might be fuzzy entries. Here the translation -system guessed the translation. Please also check these entries and -remove the word "fuzzy".
-
-At the beginning of the file please enter your name and mail address.
-Please note that the file must be encoded in UTF8. -

-Wildcards: There may appear wildcards like "%s" in the msgids. These are replaced by parameters at runtime. Please check that the number of wildcards in msgid and msgstr is the same. -

-We suggest to use KBabel -or PoEdit for the translation but -any editor with UTF8 support can do it, too.
-
-If you want to start a new translation please subscribe to lam-i18n -and write a short mail to what language you want to translate. We will -send you an empty .po file.
-Whenever the translations need to be updated we will inform you on lam-i18n.
-
-
-
-
-[1] locale/<LANG_ID>/LC_MESSAGES/messages.po
-
-
-
-
-
-
- - diff --git a/lam-web/i18n/index.htm b/lam-web/i18n/index.htm deleted file mode 100755 index f20dd269..00000000 --- a/lam-web/i18n/index.htm +++ /dev/null @@ -1,341 +0,0 @@ - - - - - - - - - - - - - - - - -
  -

I18N - Internationalisation
-

-

-
-

We -are always looking for people to translate LDAP Account Manager to -other languages or review existing translations. -

-

If -you would like to help please write to our i18n-mailinglist. -

-

 

-

If -you find translation errors please write to - lam-i18n@lists.sourceforge.net.

-
-
- LAM translation team:
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Language
-
Translator
-
Catalan
-
Dani Pardo
-
Chinese (Simplified)
-
Alan Needham
-
Chinese (Traditional)
-
Hung Chih-ming
-
Czech
-
Ludek Finstrle
-
Dutch
-
Ruud Baart
-
English
-
LAM developers
-
French
-
Xavier Poirier
-
German
-
Roland Gruber
-
Hungarian
-
Gergely Kakasy
-
Italian
-
Massimiliano Ferrero
-
Japanese
-
Yasuhiro Magara
-
Polish
-
Cezar C
-
Portuguese
-
Alexandre Makoto Tanno
-
Russian
-
Anatoly Turov
-
Spanish
-
Dani Pardo
-
-
-
- Translation HowTo
-
-
-
-
- - diff --git a/lam-web/images/background.png b/lam-web/images/background.png deleted file mode 100644 index 7a0ad19b..00000000 Binary files a/lam-web/images/background.png and /dev/null differ diff --git a/lam-web/images/brlink_logo.gif b/lam-web/images/brlink_logo.gif deleted file mode 100644 index b0423b69..00000000 Binary files a/lam-web/images/brlink_logo.gif and /dev/null differ diff --git a/lam-web/images/geoit_logo.gif b/lam-web/images/geoit_logo.gif deleted file mode 100644 index 3ee5b71b..00000000 Binary files a/lam-web/images/geoit_logo.gif and /dev/null differ diff --git a/lam-web/images/lam_logo.jpg b/lam-web/images/lam_logo.jpg deleted file mode 100644 index 35ef1e4d..00000000 Binary files a/lam-web/images/lam_logo.jpg and /dev/null differ diff --git a/lam-web/images/openlogo-nd-25.png b/lam-web/images/openlogo-nd-25.png deleted file mode 100644 index 5ad44879..00000000 Binary files a/lam-web/images/openlogo-nd-25.png and /dev/null differ diff --git a/lam-web/images/openlogo-nd-50.png b/lam-web/images/openlogo-nd-50.png deleted file mode 100644 index 411c9d96..00000000 Binary files a/lam-web/images/openlogo-nd-50.png and /dev/null differ diff --git a/lam-web/images/schema_groupOfNames.png b/lam-web/images/schema_groupOfNames.png deleted file mode 100644 index 3e767c7c..00000000 Binary files a/lam-web/images/schema_groupOfNames.png and /dev/null differ diff --git a/lam-web/images/schema_inetOrgPerson.png b/lam-web/images/schema_inetOrgPerson.png deleted file mode 100644 index e2a44eca..00000000 Binary files a/lam-web/images/schema_inetOrgPerson.png and /dev/null differ diff --git a/lam-web/images/schema_kolab.png b/lam-web/images/schema_kolab.png deleted file mode 100644 index 31b6f339..00000000 Binary files a/lam-web/images/schema_kolab.png and /dev/null differ diff --git a/lam-web/images/schema_mac.png b/lam-web/images/schema_mac.png deleted file mode 100644 index eb153a33..00000000 Binary files a/lam-web/images/schema_mac.png and /dev/null differ diff --git a/lam-web/images/schema_mailAlias.png b/lam-web/images/schema_mailAlias.png deleted file mode 100644 index 6079a528..00000000 Binary files a/lam-web/images/schema_mailAlias.png and /dev/null differ diff --git a/lam-web/images/schema_samba.png b/lam-web/images/schema_samba.png deleted file mode 100644 index 3d2e6885..00000000 Binary files a/lam-web/images/schema_samba.png and /dev/null differ diff --git a/lam-web/images/schema_ssh.png b/lam-web/images/schema_ssh.png deleted file mode 100644 index ccf8497e..00000000 Binary files a/lam-web/images/schema_ssh.png and /dev/null differ diff --git a/lam-web/images/schema_unix.png b/lam-web/images/schema_unix.png deleted file mode 100644 index db2e8b7b..00000000 Binary files a/lam-web/images/schema_unix.png and /dev/null differ diff --git a/lam-web/images/schema_user.png b/lam-web/images/schema_user.png deleted file mode 100644 index 7be48fb8..00000000 Binary files a/lam-web/images/schema_user.png and /dev/null differ diff --git a/lam-web/images/sflogo.png b/lam-web/images/sflogo.png deleted file mode 100644 index 503b9749..00000000 Binary files a/lam-web/images/sflogo.png and /dev/null differ diff --git a/lam-web/images/siedl_logo.gif b/lam-web/images/siedl_logo.gif deleted file mode 100644 index 794b1205..00000000 Binary files a/lam-web/images/siedl_logo.gif and /dev/null differ diff --git a/lam-web/images/zend_logo.gif b/lam-web/images/zend_logo.gif deleted file mode 100644 index 389e753a..00000000 Binary files a/lam-web/images/zend_logo.gif and /dev/null differ diff --git a/lam-web/index.htm b/lam-web/index.htm deleted file mode 100755 index 3c76fd4f..00000000 --- a/lam-web/index.htm +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - - - - - - - - -
  -

-

LDAP Account Manager

-

LDAP Account Manager (LAM) is a webfrontend for -managing accounts stored in an LDAP directory.

-
-
-

LAM -

-


-

-
-
-

LDAP Account Manager Pro

LAM Pro is an enhanced version of LAM which includes many features for enterprise usage. -E.g. the LAM Pro self service allows your users to change their personal data and passwords themselves. - More information
-
-
-

New: Scalix support for LAM available. Read more

-
-
-

Features:

-
    -
  • management of Unix user and group accounts -(posixAccount/posixGroup)
  • -
  • management of Samba 2.x/3 user and host -accounts -(sambaAccount/sambaSamAccount)
  • -
  • management of Kolab 2 accounts -(kolabInetorgPerson)
  • -
  • profiles for account creation
  • -
  • account creation via file upload
  • -
  • automatic creation/deletion of home -directories
  • -
  • setting quotas
  • -
  • PDF output for all accounts
  • -
  • editor for organizational units (OU)
  • -
  • schema browser
  • -
  • tree view
  • -
  • multiple configuration files
  • -
  • multi-language support (Catalan, Chinese -(Traditional + Simplified), Czech, Dutch, English, French, German, -Hungarian, Italian, Japanese, Polish, Portuguese, Russian and Spanish)
  • -
  • support for LDAP+SSL/TLS
  • -
-

-

-Complete list of supported account types: supported types -
-

-



-

If you like LAM please consider making a donation. -

-


-
-

-
- - diff --git a/lam-web/lam.js b/lam-web/lam.js deleted file mode 100644 index 46168281..00000000 --- a/lam-web/lam.js +++ /dev/null @@ -1,12 +0,0 @@ - -// mouseOver function -function list_over(list) { - list.setAttribute('class','nav-over', 0); - list.setAttribute('className','nav-over', 0); -} - -// mouseOut function -function list_out(list) { - list.setAttribute('class','nav', 0); - list.setAttribute('className','nav', 0); -} diff --git a/lam-web/lamPro/index.htm b/lam-web/lamPro/index.htm deleted file mode 100644 index c8cb2b2c..00000000 --- a/lam-web/lamPro/index.htm +++ /dev/null @@ -1,11 +0,0 @@ - - - - - -LDAP Account Manager - - - - - \ No newline at end of file diff --git a/lam-web/lamPro/payment.htm b/lam-web/lamPro/payment.htm deleted file mode 100644 index d7baaee3..00000000 --- a/lam-web/lamPro/payment.htm +++ /dev/null @@ -1,11 +0,0 @@ - - - - - -LDAP Account Manager - - - - - \ No newline at end of file diff --git a/lam-web/lamPro/rgs.htm b/lam-web/lamPro/rgs.htm deleted file mode 100644 index 363377c7..00000000 --- a/lam-web/lamPro/rgs.htm +++ /dev/null @@ -1,11 +0,0 @@ - - - - - -LDAP Account Manager - - - - - \ No newline at end of file diff --git a/lam-web/live-demo/index.htm b/lam-web/live-demo/index.htm deleted file mode 100755 index 3d6d5508..00000000 --- a/lam-web/live-demo/index.htm +++ /dev/null @@ -1,248 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

LAM-Live-Demo

-
-

For people who want to get a first impression of what -LDAP Account Manager is, how it looks like and what can be done with -it, we can offer a special service: LAM-Live-Demo. You can use -LDAP Account Manager on a machine on the internet and check out its -features.

-


-
- -Demo server 1 (last stable release of LAM Pro)       The password is "lam". -
-Demo server 1 (CVS)       The password is "lam". -
-
- -Demo server 2 (last stable release of LAM Pro)       The password is "lamsecret". -
-Demo server 2 (CVS)       The password is "lamsecret". -
-
- - -
-
-

- -
- - - - diff --git a/lam-web/mailinglists/index.htm b/lam-web/mailinglists/index.htm deleted file mode 100755 index f7904f7d..00000000 --- a/lam-web/mailinglists/index.htm +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Mailing lists

- - - - - - - -
lam-announce
- Here you get the latest announcements from the LAM development team. Mostly new releases and critical bugs or similiar things will be posted here. Go to the - lam-announce interface to add your e-mail address. -
-





- - - - - - - -
lam-public
- This list is for everyone, developers and users, to share their experiences with LAM, ask the developers something, discuss about LAM and more. Go to the - lam-public interface to add your e-mail address. -
-









- -
- - - - diff --git a/lam-web/new-developers.htm b/lam-web/new-developers.htm deleted file mode 100644 index 495f0b20..00000000 --- a/lam-web/new-developers.htm +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - - - - - -
  - -


-

-

LAM needs new developers/designers
-

-
-We are looking for new developers and designers to support our project. -Since LAM grew very fast over the last months we need your help.
-If you are interested in joining our team please contact Roland Gruber.
-
-

Developers

- -Needed skills:
-
-
    -
  • writing PHP applications
  • -
  • basic LDAP knowledge
  • -
  • speaking English or German
  • -
  • at least 3-5 hours time per week for LAM
  • -
-
-Your possible tasks:
-
    -
  • developing new plugins
  • -
  • maintaining parts of LAM (fixing bugs and implementing new features)
  • -
  • refactoring the existing codebase
  • -
  • ...
  • -
-
-You can take a look at our developer -documentation to get an overview over the code base.
-
-
-

Designers

- -Needed skills:
-
-
    -
  • artistic talent
  • -
  • webdesign knowledge
  • -
  • programming skills are optional
  • -
- -Your possible tasks:
-
-
    -
  • enhancing LAM's design
  • -
  • working on this homepage
  • -
  • ...
  • -
-
-If you are interested in joining our team or have any questions please -contact Roland Gruber. - -
-
-
- - - - diff --git a/lam-web/news/archives.htm b/lam-web/news/archives.htm deleted file mode 100755 index e692dcd8..00000000 --- a/lam-web/news/archives.htm +++ /dev/null @@ -1,705 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Archived news

-
-

- - - - - - - - - - -
Thursday 10th August 2006 - 1.0.4
This release includes support for Samba password policies and is now also translated to Russian.
-
-

- - - - - - - - - - -
Wednesday 5th July 2006 - 1.0.3
This release closes some security related bugs.
-
-

- - - - - - - - - - -
Wednesday 24th May 2006 - 1.0.2
This release adds some security enhancements and closes several bugs.
-
-

- - - - - - - - - - -
Wednesday 12th April 2006 - 1.0.1
This release fixes several bugs of the 1.0.0 release and adds some basic security checks.
-
-

- - - - - - - - - - -
Wednesday 1st March 2006 - 1.0.0
This release introduces a new architecture which supports more account types than just users, groups and hosts.
-
-

- - - - - - - - - - -
Wednesday 8th February 2006 - 1.0.rc2
This is the last release candidate of LAM 1.0. Please test it and report any problems.
-
-

- - - - - - - - - -
Wednesday 11th January 2006 - 1.0.rc1
This is the first release candidate of LAM 1.0. The new architecture will support more account types than just users, groups and hosts.
-
-

- - - - - - - - - - -
Wednesday 14th December 2005 - 0.5.3
This release fixes some bugs and allows to upload JPG images for users.
-
-

- - - - - - - - - -
Wednesday 16th November 2005 - 0.5.2
LAM 0.5.2 fixes some small bugs and includes a new module to manage SSH keys.
-
-

- - - - - - - - - -
Wednesday 19th October 2005 - 0.5.1
LAM 0.5.1 fixes several bugs which were reported since 0.5.0.
-
-

- - - - - - - - - -
Wednesday 28th September 2005 - 0.5.0
LAM 0.5.0 is ready!
This is the first release which includes the new architecture. It offers a lot of new - functions. See the changelog for details.
-
-

- - - - - - - - - -
Thursday 8th September 2005 - 0.5.rc3
LAM 0.5.rc3 is the third and maybe last release candidate of -LAM 0.5. Since this is an unstable release do not use it -in productive environments.
-
-

- - - - - - - - - -
Thursday 18th August 2005
LAM 0.5.rc2 is the second release candidate of LAM 0.5. Since -this is an unstable release do not use it -in productive environments.
-
-
-

- - - - - - - - - -
Monday 8th August 2005
LAM 0.5.rc1 is the first release candidate of LAM 0.5. Since -this is an unstable release do not use it -in productive environments.
-
-
-

- - - - - - - - - -
Thursday 28th July 2005
LAM 0.4.10 is now compatible with PHP5.
-
-
-

- - - - - - - - - -
Thursday 30th June 2005
LAM 0.5.alpha2 is the second and probably last alpha release -of LAM 0.5. Since this is an alpha release do not use it -in productive environments.
-
-
-

- - - - - - - - - -
Wednesday 11th May 2005
LAM 0.5.alpha1 is the first release of LAM which contains the -new modular architecture. Since this is an alpha release do not use it -in productive environments.
-
-
-

- - - - - - - - - -
Wednesday 9th March 2005
The LDAP Account Manager team is pleased to release another -version of LAM. This release fixes some minor bugs of the 0.4.8 release.
-There is also a security fix for lamdaemon.pl.
-
-

- - - - - - - - - -
Wednesday 26th January 2005
The LDAP Account Manager team is pleased to release another -version of LAM. This release fixes some minor bugs of the 0.4.7 -release.
-
-

- - - - - - - - - -
Thursday 27th May 2004
The LDAP Account Manager team is pleased to release another -version of LAM. This release fixes some minor bugs of the 0.4.5 -release.
-
-

- - - - - - - - - -
Monday 5th April 2004
John H. Terpstra wrote an appendix about LAM in his new book -Samba-3 by Example.
-It covers installation and usage of LAM. There are also several -screenshots.
-
-

- - - - - - - - - -
Sunday 21th March 2004
The LDAP Account Manager team is pleased to release the next -version of LAM (0.4.5), which is marked stable. This release fixes some -minor bugs and comes with a French translation.
-
-

- - - - - - - - - -
Sunday 29th February 2004
After a year of developing LDAP Account Manager we think -that LAM has reached a state where we can declare it stable.
-
-Thanks a lot to all the people that helped us to improve LAM and make -it such a great tool.
-
-Special thanks go to:
-- Clement Laforet for maintaining LAM in FreeBSD
-- Matthew Palmer/Andreas Barth who sponsor LAM for Debian
-- Zoltan Lohner/Oota Toshiya for their translations
-- Andreas Rehm who wrote a howto for LAM
-- John H. Terpstra for writing about LAM in his books
-- all the people on lam-public and bug submitters
-
-
-This version closes a lot of minor bugs. There are no new features.
-
-

- - - - - - - - - -
Monday 9th February 2004
Today the fourth beta release (version 0.4.3) is ready for -download in the download section. As in release 0.4.2 not many new -features have been added. Please note that this is still a beta -release, although we think that there should not be any more critical -bugs in this release. Please do not use it in a productive environment -unless you know the problems that could occur. The LDAP Account Manager -Development Team would be very pleased if you report any bugs you find -to our bug tracker.
-
-

- - - - - - - - - -
Wednesday 21th January 2004
Today the third beta release (version 0.4.2) is ready for -download in the download section. As in release 0.4.1 not many new -features have been added. Please note that this is still a beta -release, although we think that there should not be any more critical -bugs in this release. Please do not use it in a productive environment -unless you know the problems that could occur. The LDAP Account Manager -Development Team would be very pleased if you report any bugs you find -to our bug tracker.
-
-

- - - - - - - - - -
Tuesday 30th December 2003
The CVS archive has been splitted into the modules "lam" and -"lam-0.4".
-
-The lam module contains the new plugin structure and will be unstable -for some time. This will be the upcoming 0.5 release.
-
-lam-0.4 contains the 0.4.1 release and will be used until the plugins -are stable. There will be also a new release with a configuration -wizard and MCrypt removed in the next few weeks.
-
-

- - - - - - - - - -
Monday 29th December 2003
Today the second beta release (version 0.4.1) is ready for -download in the download section. Please note that this is still a beta -release, although we think that there should not be any more critical -bugs in this release. Please do not use it in a productive environment -unless you know the problems that could occur. The LDAP Account Manager -Development Team would be very pleased if you report any bugs you find -to our bug tracker.
-
-

- - - - - - - - - -
Monday 29th December 2003
Debian users now can get LAM directly from unstable. Thanks -to Matthew Palmer who is sponsoring the package.
-
-The Mentors repository will still be updated for the next few versions. -
-
-

- - - - - - - - - -
Wednesday 29th October 2003
Today the first beta release (version 0.4) is ready for -download in the download section. Please note that this is still a beta -release, although we think that the number of bugs has been reduced -since the last release. Please do not use it in a productive -environment unless you know the problems that could occur. The LDAP -Account Manager Development Team would be very pleased if you report -any bugs you find to our bug tracker.
-
-

- - - - - - - - - -
Sunday 31th August 2003
Today the third alpha release (version 0.3) is ready for -download in the download section. Please note that this is still just -an alpha release, although we think that the number of bugs has been -reduced since the last release. Please do not use it in a productive -environment unless you know the problems that could occur. The LDAP -Account Manager Development Team would be very pleased if you report -any bugs you find to our bug tracker.
-
-

- - - - - - - - - -
Saturday 5th June 2003
Today the second alpha release (version 0.2) is ready for -download in the download section. Please note that this is still just -an alpha release. Please do not use it in a productive environment. The -LDAP Account Manager Development Team would be very pleased if you -report any bugs you find to our bug tracker.
-
-

- - - - - - - - - -
Saturday 24th May 2003
Today the first alpha release (version 0.1) is ready for -download in the download section. Please note that this is just an -alpha release. Please do not use it in a productive environment. The -LDAP Account Manager Development Team would be very pleased if you -report any bugs you find to our bug tracker.
-
- -
- - - - diff --git a/lam-web/news/index.htm b/lam-web/news/index.htm deleted file mode 100755 index ff79073a..00000000 --- a/lam-web/news/index.htm +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

News

-
-

- - - - - - - - - - -
Wednesday 30th April 2008 - 2.3.0
LAM now supports password policies and phpGroupware accounts.
-
-

- - - - - - - - - - -
Wednesday 23th January 2008 - 2.2.0
This release adds a number of usability enhancements. The controls of the main tab were moved and are permanently visible. -
LAM Pro customers can set different access levels and use the new password reset page.
-
-

- - - - - - - - - - -
Wednesday 7th November 2007 - 2.1.0
This release comes with a new tabular design for the account pages. The Samba 3 module now supports terminal server settings.
-
-

- - - - - - - - - - -
Wednesday 8th August 2007 - 2.0.0
This is the first release which requires PHP5. It includes three -new translations (Simplified Chinese, Czech and Portuguese) and includes -several bug fixes and minor improvements.
-
-

- - - - - - - - - - -
Wednesday 28th March 2007 - 1.3.0
LAM can now display user photos in the account list and supports multiple lamdaemon servers.

-This release fixes also a security bug where HTML characters in LDAP data were not escaped.
-
-

- - - - - - - - - - -
Wednesday 24th January 2007 - 1.2.0
This release includes minor enhancements of the Samba 3 module. The LAM Pro version now supports groupOf(Unique)Names accounts.
-
-

- - - - - - - - - - -
Monday 13th November 2006 - End of PHP4 support
The support for PHP version 4 for LAM will end on 01.03.2007. This means that all releases after this date will require PHP 5 to run.
-
-

- - - - - - - - - - -
Wednesday 1st November 2006 - 1.1.1
This version fixes the password hashing bug. LAM now includes a test page for lamdaemon.
-
-

- - - - - - - - - - -
Wednesday 20th September 2006 - 1.1.0
This release comes with a new lamdaemon implementation which should be far more stable now.
-
-

- -

Archived news

-
- -
- - - - diff --git a/lam-web/po-files/messages.po.tar.gz b/lam-web/po-files/messages.po.tar.gz deleted file mode 100644 index 489baf76..00000000 Binary files a/lam-web/po-files/messages.po.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_ca.tar.gz b/lam-web/po-files/messages.po_ca.tar.gz deleted file mode 100644 index b48bcc33..00000000 Binary files a/lam-web/po-files/messages.po_ca.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_cs.tar.gz b/lam-web/po-files/messages.po_cs.tar.gz deleted file mode 100644 index 5fd72388..00000000 Binary files a/lam-web/po-files/messages.po_cs.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_es.tar.gz b/lam-web/po-files/messages.po_es.tar.gz deleted file mode 100644 index c96b863b..00000000 Binary files a/lam-web/po-files/messages.po_es.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_fr.tar.gz b/lam-web/po-files/messages.po_fr.tar.gz deleted file mode 100644 index 54f032bf..00000000 Binary files a/lam-web/po-files/messages.po_fr.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_hu.tar.gz b/lam-web/po-files/messages.po_hu.tar.gz deleted file mode 100644 index e15409b3..00000000 Binary files a/lam-web/po-files/messages.po_hu.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_it.tar.gz b/lam-web/po-files/messages.po_it.tar.gz deleted file mode 100644 index 717e923c..00000000 Binary files a/lam-web/po-files/messages.po_it.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_jp.tar.gz b/lam-web/po-files/messages.po_jp.tar.gz deleted file mode 100644 index 5e624257..00000000 Binary files a/lam-web/po-files/messages.po_jp.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_nl.tar.gz b/lam-web/po-files/messages.po_nl.tar.gz deleted file mode 100644 index 82538de7..00000000 Binary files a/lam-web/po-files/messages.po_nl.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_pt.tar.gz b/lam-web/po-files/messages.po_pt.tar.gz deleted file mode 100644 index d4d913bc..00000000 Binary files a/lam-web/po-files/messages.po_pt.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_ru.tar.gz b/lam-web/po-files/messages.po_ru.tar.gz deleted file mode 100644 index aeb75f86..00000000 Binary files a/lam-web/po-files/messages.po_ru.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_zh_CN.tar.gz b/lam-web/po-files/messages.po_zh_CN.tar.gz deleted file mode 100644 index 860304ec..00000000 Binary files a/lam-web/po-files/messages.po_zh_CN.tar.gz and /dev/null differ diff --git a/lam-web/po-files/messages.po_zh_TW.tar.gz b/lam-web/po-files/messages.po_zh_TW.tar.gz deleted file mode 100644 index aa5e8652..00000000 Binary files a/lam-web/po-files/messages.po_zh_TW.tar.gz and /dev/null differ diff --git a/lam-web/robots.txt b/lam-web/robots.txt deleted file mode 100755 index ae42c7ae..00000000 --- a/lam-web/robots.txt +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/lam-web/screenshots/images/config1.jpg b/lam-web/screenshots/images/config1.jpg deleted file mode 100644 index de2e479c..00000000 Binary files a/lam-web/screenshots/images/config1.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/config2.jpg b/lam-web/screenshots/images/config2.jpg deleted file mode 100644 index e0371d61..00000000 Binary files a/lam-web/screenshots/images/config2.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/config3.jpg b/lam-web/screenshots/images/config3.jpg deleted file mode 100644 index 16ff4d72..00000000 Binary files a/lam-web/screenshots/images/config3.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/fileupload.jpg b/lam-web/screenshots/images/fileupload.jpg deleted file mode 100644 index f4b74952..00000000 Binary files a/lam-web/screenshots/images/fileupload.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/grouplist.jpg b/lam-web/screenshots/images/grouplist.jpg deleted file mode 100644 index 344a0ef7..00000000 Binary files a/lam-web/screenshots/images/grouplist.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/login.jpg b/lam-web/screenshots/images/login.jpg deleted file mode 100644 index f0e46511..00000000 Binary files a/lam-web/screenshots/images/login.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/m_userlist.jpg b/lam-web/screenshots/images/m_userlist.jpg deleted file mode 100644 index 58db7edb..00000000 Binary files a/lam-web/screenshots/images/m_userlist.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/ouedit.jpg b/lam-web/screenshots/images/ouedit.jpg deleted file mode 100644 index ee0bb675..00000000 Binary files a/lam-web/screenshots/images/ouedit.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/pdf.jpg b/lam-web/screenshots/images/pdf.jpg deleted file mode 100644 index 470a3b84..00000000 Binary files a/lam-web/screenshots/images/pdf.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/pdfedit.jpg b/lam-web/screenshots/images/pdfedit.jpg deleted file mode 100644 index a6018dae..00000000 Binary files a/lam-web/screenshots/images/pdfedit.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/profiles.jpg b/lam-web/screenshots/images/profiles.jpg deleted file mode 100644 index 3384bfc5..00000000 Binary files a/lam-web/screenshots/images/profiles.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/schemabrowser.jpg b/lam-web/screenshots/images/schemabrowser.jpg deleted file mode 100644 index 1c191c06..00000000 Binary files a/lam-web/screenshots/images/schemabrowser.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_config1.jpg b/lam-web/screenshots/images/t_config1.jpg deleted file mode 100644 index 36d0fdc9..00000000 Binary files a/lam-web/screenshots/images/t_config1.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_config2.jpg b/lam-web/screenshots/images/t_config2.jpg deleted file mode 100644 index 55010c3e..00000000 Binary files a/lam-web/screenshots/images/t_config2.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_config3.jpg b/lam-web/screenshots/images/t_config3.jpg deleted file mode 100644 index 534449fb..00000000 Binary files a/lam-web/screenshots/images/t_config3.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_fileupload.jpg b/lam-web/screenshots/images/t_fileupload.jpg deleted file mode 100644 index 445ffc49..00000000 Binary files a/lam-web/screenshots/images/t_fileupload.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_grouplist.jpg b/lam-web/screenshots/images/t_grouplist.jpg deleted file mode 100644 index bea7729a..00000000 Binary files a/lam-web/screenshots/images/t_grouplist.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_login.jpg b/lam-web/screenshots/images/t_login.jpg deleted file mode 100644 index b0af153a..00000000 Binary files a/lam-web/screenshots/images/t_login.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_ouedit.jpg b/lam-web/screenshots/images/t_ouedit.jpg deleted file mode 100644 index b8d9b8b5..00000000 Binary files a/lam-web/screenshots/images/t_ouedit.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_pdf.jpg b/lam-web/screenshots/images/t_pdf.jpg deleted file mode 100644 index 135f0665..00000000 Binary files a/lam-web/screenshots/images/t_pdf.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_pdfedit.jpg b/lam-web/screenshots/images/t_pdfedit.jpg deleted file mode 100644 index 2a8bf68f..00000000 Binary files a/lam-web/screenshots/images/t_pdfedit.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_profiles.jpg b/lam-web/screenshots/images/t_profiles.jpg deleted file mode 100644 index d84f8a77..00000000 Binary files a/lam-web/screenshots/images/t_profiles.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_schemabrowser.jpg b/lam-web/screenshots/images/t_schemabrowser.jpg deleted file mode 100644 index c36fc838..00000000 Binary files a/lam-web/screenshots/images/t_schemabrowser.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_treeview.jpg b/lam-web/screenshots/images/t_treeview.jpg deleted file mode 100644 index 3e6f95f8..00000000 Binary files a/lam-web/screenshots/images/t_treeview.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_userPhotos.jpg b/lam-web/screenshots/images/t_userPhotos.jpg deleted file mode 100644 index 18d88e8a..00000000 Binary files a/lam-web/screenshots/images/t_userPhotos.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_useredit.jpg b/lam-web/screenshots/images/t_useredit.jpg deleted file mode 100644 index 21ef62c4..00000000 Binary files a/lam-web/screenshots/images/t_useredit.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/t_userlist.jpg b/lam-web/screenshots/images/t_userlist.jpg deleted file mode 100644 index 3188eb87..00000000 Binary files a/lam-web/screenshots/images/t_userlist.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/treeview.jpg b/lam-web/screenshots/images/treeview.jpg deleted file mode 100644 index 393aa16d..00000000 Binary files a/lam-web/screenshots/images/treeview.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/userPhotos.jpg b/lam-web/screenshots/images/userPhotos.jpg deleted file mode 100644 index 84a4616c..00000000 Binary files a/lam-web/screenshots/images/userPhotos.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/useredit.jpg b/lam-web/screenshots/images/useredit.jpg deleted file mode 100644 index 61f1dc74..00000000 Binary files a/lam-web/screenshots/images/useredit.jpg and /dev/null differ diff --git a/lam-web/screenshots/images/userlist.jpg b/lam-web/screenshots/images/userlist.jpg deleted file mode 100644 index 1c970561..00000000 Binary files a/lam-web/screenshots/images/userlist.jpg and /dev/null differ diff --git a/lam-web/screenshots/index.htm b/lam-web/screenshots/index.htm deleted file mode 100755 index a3a3172d..00000000 --- a/lam-web/screenshots/index.htm +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Screenshots

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Click on the images to enlarge them in a new window.



login page

list of user accounts

user photos


list of group accounts

modification of user accounts

account profiles


create users via file upload

tree view

schema browser


PDF export

select attributes for PDF export

OU-Editor


configuration profiles

configuration

account modules

Click on the images to enlarge them in a new window.
- -
- - - - diff --git a/lam-web/sponsors/donations.htm b/lam-web/sponsors/donations.htm deleted file mode 100755 index 234b0399..00000000 --- a/lam-web/sponsors/donations.htm +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

-

Donations

-
-

Why you should donate:

-
-LAM is developed in our free time without gaining money for the work. -This is the big advantage that free software offers to you.
-Of course, we also need to work to afford our life. Therefore the time -we can spend for the project is limited.
-
-You can help us to spend more time by making donations. This will make -it possible for us to buy hardware, software or present LAM on one of -the various Free Software exhibitions.
-
-Please note that you will always get a consideration for your -support. Your money helps us to keep LAM alive and continue the support -for this product.
-
-If you need special modifications or feature enhancements in LAM we are -strongly interested in helping you in return for a donation. Please -contact Roland Gruber for details.
-
-
-

Take a look at our bounty page: Bounties

-
-
-

How you can donate:

-
-PayPal: Just use the donation -service provided by Sourceforge.
-
-Bank transfer:
-
-Account holder: Roland Gruber
-Bank name: 1822direkt
-Germany: Account number: 1252 -757 733, BLZ: 500 502 01
-International: IBAN: DE50 -5005 0201 1252 7577 33, BIC: -FRASDEFF
-
-
-Other possibilities on request.
- -
- - - - diff --git a/lam-web/sponsors/index.htm b/lam-web/sponsors/index.htm deleted file mode 100755 index a4ad4c65..00000000 --- a/lam-web/sponsors/index.htm +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - - - - - - -
  -

Sponsors

-Take a look at our donations page for -information on how you can support us.
-
-
-Here is a list of our sponsors:
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
01.09.2007
-
BR Link sponsors LAM demo installations.
-
Geo-IT
-
-
22.02.2007
-
Siedl networks GmbH spent code to support multiple servers for lamdaemon.
-
Geo-IT
-
-
16.06.2005
-
Geo-IT spent us some money -for -supporting Kolab accounts.
-
Geo-IT
-
-
28.03.2005: Zend -supports us with -licenses for Zend Studio Professional
-
Zend
-
-
-
- - diff --git a/lam-web/style/layout.css b/lam-web/style/layout.css deleted file mode 100755 index b7718825..00000000 --- a/lam-web/style/layout.css +++ /dev/null @@ -1,92 +0,0 @@ -/* body { background-color:#F5F5F5; } */ - -body { - font-family:sans-serif; - background-image:url("../images/background.png"); - background-repeat: repeat-y; -} - -a { -color:#000080; -text-decoration:none; -} - -a:visited { -color:#000080; -text-decoration:none; -} - -a:hover { -color:red; -text-decoration:none; -} - -a:active { -color:red; -text-decoration:none; -} - -h1 { color:#253aa3; } -h2 { color:#000080; font-size:13pt; } - -table { border-color:#253aa3; border-style:solid; border-width:1px; } -th { background-color:#253aa3; text-align:left; font-size:12pt; font-weight:bold; color:#FFFFFF; border-color:#253aa3; border-style:hidden; height:21px; } -td { padding-left: 15px;border-color:#253aa3; border-style:hidden; font-size:12pt; } - -/* background table */ -table.main { - border-width:0px; -} - -/* menu */ -td.menu { - vertical-align:top; -} - -/* main area */ -td.mainarea { - vertical-align:top; -} - -/* home.htm */ -h1.home { text-align:center; color:#000080; } -p.home { text-align:center; } - -h2.features { margin-bottom:0px; } -p.features { margin:2px; } - -/* news/index.htm */ -h2.news { margin-bottom:0px; } -p.news { margin-top:5px; text-align:justify; } - -/* nav.htm */ -table.nav { border-color:#253aa3; border-width:1px; } -th.nav { background-color:#253aa3; text-align:left; font-size:12pt; font-weight:bold; color:#FFFFFF; height:21px; } -td.nav { padding-left: 15px;background-color:#FFFFFF; font-size:10pt; } -td.nav-over { padding-left: 15px;background-color:#a8c3ff; font-size:10pt; } - -a.download { color:#253aa3; text-decoration:none; font-weight:bold; } -a.download:hover { color:red;text-decoration:none; } - -p.download { font-size:12pt; } -/* third-party/index.htm */ -table.thirdparty { border-color:#253aa3; border-style:solid; border-width:3px; } -th.thirdparty { background-color:#253aa3; text-align:left; font-size:16pt; font-weight:bold; color:#FFFFFF; border-color:#253aa3; border-style:hidden; height:25px; } -td.thirdpartyLink { border-color:#253aa3; border-style:hidden; } -td.thirdpartySpace { border-color:#253aa3; border-style:hidden; text-align:right; color:#253aa3; font-weight:bold; } - -a.thirdparty { color:#253aa3; text-decoration:none; font-weight:bold; } -a.thirdparty:hover { text-decoration:underline; } - -/* Debian page */ -table.debian { border-width:0px; } -td.debian { font-size:12pt; } - -/* documentation/index.htm */ -a.documentation { color:#253aa3; text-decoration:none; font-weight:bold; font-size:12pt; } - -/* bugs */ -td.bugGrave { padding-left: 1px;background-color:red; } -td.bugNormal { padding-left: 1px;background-color:#ffc600; } -td.bugMinor { padding-left: 1px;background-color:yellow; } -td.bugOther { padding-left: 1px; } diff --git a/lam-web/tmp/ldap-account-manager-2.3.0RC1.tar.gz b/lam-web/tmp/ldap-account-manager-2.3.0RC1.tar.gz deleted file mode 100644 index 87a7c84b..00000000 Binary files a/lam-web/tmp/ldap-account-manager-2.3.0RC1.tar.gz and /dev/null differ diff --git a/lam-web/tmp/scalixGroupClass.inc b/lam-web/tmp/scalixGroupClass.inc deleted file mode 100644 index 091c95c2..00000000 --- a/lam-web/tmp/scalixGroupClass.inc +++ /dev/null @@ -1,264 +0,0 @@ -scalixScalixObject = false; - } - - - /** used for account pages, true if input data is correct */ - var $inputCorrect = true; - var $scalixScalixObject; - var $scalixMailnode; - var $scalixEmailAddress; - - - /** - * Returns meta data that is interpreted by parent class - * - */ - function get_metaData() { - $return = array(); - // manages user accounts - $return["account_types"] = array("group"); - // alias name - $return["alias"] = _("Scalix"); - // module dependencies - $return['dependencies'] = array('depends' => array(), 'conflicts' => array()); - // help Entries - $return['help'] = array ( - "scalixuser" => array( - "ext" => "FALSE", "Headline" => _("scalixScalixObject"), - "Text" => _("boolean TRUE or FALSE for creating scalix object")), - "mailnode" => array( - "ext" => "FALSE", "Headline" => _("scalixMailnode"), - "Text" => _("comma separated org units for object mailnode")), - "mboxaddr" => array( - "ext" => "FALSE", "Headline" => _("scalixEmailAddress"), - "Text" => _("E-Mail Adress of Scalix Group")) - ); - $return['attributes'] = array('scalixScalixObject','scalixMailnode','scalixEmailAddress'); - $return['objectClasses'] = array('scalixUserClass'); - return $return; - } - - /** - * This function loads all needed attributes into the object. - * - * @param array $attr an array as it is retured from ldap_get_attributes - */ - function load_attributes($attr) { - parent::load_attributes($attr); - //scalixScalixObject - if (is_string($this->attributes['scalixScalixObject'][0])) { - if ($this->attributes['scalixScalixObject'][0] == "TRUE") $this->scalixScalixObject = true; - else $this->scalixScalixObject = false; - } - //scalixMailnode - $this->attributes['objectClass'] = array(); - $this->attributes['scalixMailnode'] = array(); - $this->orig['objectClass'] = array(); - $this->orig['scalixMailnode'] = array(); - if (isset($attr['objectClass'])) { - $this->attributes['objectClass'] = $attr['objectClass']; - $this->orig['objectClass'] = $attr['objectClass']; - } - if (isset($attr['scalixMailnode'])) { - $this->attributes['scalixMailnode'] = $attr['scalixMailnode']; - $this->orig['scalixMailnode'] = $attr['scalixMailnode']; - } - - //scalixEmailAddress - $this->attributes['objectClass'] = array(); - $this->attributes['scalixEmailAddressx'] = array(); - $this->orig['objectClass'] = array(); - $this->orig['scalixEmailAddress'] = array(); - if (isset($attr['objectClass'])) { - $this->attributes['objectClass'] = $attr['objectClass']; - $this->orig['objectClass'] = $attr['objectClass']; - } - if (isset($attr['scalixEmailAddress'])) { - $this->attributes['scalixEmailAddress'] = $attr['scalixEmailAddress']; - $this->orig['scalixEmailAddress'] = $attr['scalixEmailAddress']; - } - - // add object class if needed -// if (! in_array('scalixUserClass', $this->orig['objectClass'])) { -// $this->attributes['objectClass'][] = 'scalixUserClass'; -// } - if (! in_array('scalixUserClass', $this->orig['objectClass'])) { - $this->attributes['objectClass'][] = 'scalixUserClass'; - } - return 0; - } - - /** - * Returns a list of modifications which have to be made to the LDAP account. - * - * @return array list of modifications - *
This function returns an array with 3 entries: - *
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) - *
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) - *
"add" are attributes which have to be added to LDAP entry - *
"remove" are attributes which have to be removed from LDAP entry - *
"modify" are attributes which have to been modified in LDAP entry - */ - function save_attributes() { - return $_SESSION[$this->base]->save_module_attributes($this->attributes, $this->orig); - } - - /** - * This function will create the meta HTML code to show a page with all attributes. - * - * @param array $post HTTP-POST values - */ - function display_html_attributes() { - $return = array(); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Scalix User') ), - 1 => array ( 'kind' => 'input', 'name' => 'scalixScalixObject', 'type' => 'checkbox', 'checked' => $this->scalixScalixObject, 'value' => 'true'), - 2 => array ('kind' => 'help', 'value' => 'scalixuser')); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Mailnode') ), - 1 => array ( 'kind' => 'input', 'type' => 'text', 'name' => 'scalixMailnode', 'size' => '20', 'maxlength' => '255', 'value' => $this->attributes['scalixMailnode'][0]), - 2 => array ( 'kind' => 'help', 'value' => 'mailnode' )); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Mboxaddr') ), - 1 => array ( 'kind' => 'input', 'type' => 'text', 'name' => 'scalixEmailAddress', 'size' => '20', 'maxlength' => '255', 'value' => $this->attributes['scalixEmailAddress'][0]), - 2 => array ( 'kind' => 'help', 'value' => 'mboxaddr' )); - - return $return; - } - - function get_pdfEntries() { - return array( - 'scalixUserClass_scalixScalixObject' => array('' . _('Scalix User') . '' . $this->attributes['scalixScalixObject'][0] . ''), - 'scalixUserClass_scalixMailnode' => array('' . _('Mailnode') . '' . $this->attributes['scalixMailnode'][0] . ''), - 'scalixUserClass_scalixMboxaddr' => array('' . _('Mboxaddr') . '' . $this->attributes['scalixEmailAddress'][0] . '')); - } - - /** - * Processes user input of the primary module page. - * It checks if all input values are correct and updates the associated LDAP attributes. - * - * @param array $post HTTP-POST values - * @return array list of info/error messages - */ - function process_attributes() { - $this->triggered_messages = array(); - if (isset($_POST['scalixScalixObject'])) { - $this->scalixScalixObject = true; - $this->attributes['scalixScalixObject'][0] = "TRUE"; - } else { - $this->scalixScalixObject = false; - $this->attributes['scalixScalixObject'][0] = "FALSE"; - } - $this->attributes['scalixMailnode'][0] = $_POST['scalixMailnode']; - $this->attributes['scalixEmailAddress'][0] = $_POST['scalixEmailAddress']; - - - if (sizeof($this->triggered_messages) > 0) { - $this->inputCorrect = false; - return $this->triggered_messages; - } - else { - $this->inputCorrect = true; - return 0; - } - } - - /** - * This function returns true if all needed settings are done. - */ - function module_complete() { - return $this->inputCorrect; - } - - /** - * Returns true if all settings on module page are correct. - */ - function module_ready() { - return $this->inputCorrect; - } - - function get_profileOptions() { - $return = array(); - // use Unix password as Samba password - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Scalix User') . ': '), - 1 => array('kind' => 'input', 'name' => 'scalixUserClass_scalixScalixObject', 'type' => 'checkbox', 'checked' => true), - 2 => array('kind' => 'help', 'value' => 'scalixuser') - ); - $mboxes = array(0 => 'LIMITED', 1 => 'FULL'); - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Mailnode') . ': '), - 1 => array('kind' => 'input', 'type' => 'text', 'name' => 'scalixUserClass_scalixMailnode', 'size' => '30', 'maxlength' => '255', 'value' => ''), - 2 => array('kind' => 'help', 'value' => 'mailnode') - ); - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Mboxaddr') . ': '), - 1 => array('kind' => 'select', 'type' => 'text', 'name' => 'scalixUserClass_scalixEmailAddress', 'size' => '30', 'maxlength' => '255', 'value' => ''), - 2 => array('kind' => 'help', 'value' => 'mboxaddr') - ); - return $return; - } - - /** - * Loads the values of an account profile into internal variables. - * - * @param array $profile hash array with profile values (identifier => value) - */ - function load_profile($profile) { - // profile mappings in meta data - parent::load_profile($profile); - // special profile options - if ($profile['scalixUserClass_scalixScalixObject'][0] == "true") { - $this->scalixScalixObject = true; - } - elseif ($profile['scalixUserClass_scalixScalixObject'][0] == "false") { - $this->scalixScalixObject = false; - } - if (isset($profile['scalixUserClass_scalixMailnode'][0])) { - $this->attributes['scalixMailnode'][0] = $profile['scalixUserClass_scalixMailnode'][0]; - } - if (isset($profile['scalixUserClass_scalixEmailAddress'][0])) { - $this->attributes['scalixEmailAddress'][0] = $profile['scalixUserClass_scalixEmailAddress'][0]; - } - } -} - - -?> - diff --git a/lam-web/tmp/scalixUserClass.inc b/lam-web/tmp/scalixUserClass.inc deleted file mode 100644 index 3fe88e8e..00000000 --- a/lam-web/tmp/scalixUserClass.inc +++ /dev/null @@ -1,352 +0,0 @@ -scalixScalixObject = false; - $this->scalixAdministrator = false; - $this->scalixMailboxAdministrator = false; - } - - - /** used for account pages, true if input data is correct */ - var $inputCorrect = true; - var $scalixScalixObject; - var $scalixMailnode; - var $scalixEmailAddress; - var $scalixAdministrator; - var $scalixMailboxAdministrator; - var $scalixMailboxClass; - - /** - * Returns meta data that is interpreted by parent class - * - */ - function get_metaData() { - $return = array(); - // manages user accounts - $return["account_types"] = array("user"); - // alias name - $return["alias"] = _("Scalix"); - // module dependencies - $return['dependencies'] = array('depends' => array(), 'conflicts' => array()); - // help Entries - $return['help'] = array ( - "scalixuser" => array( - "ext" => "FALSE", "Headline" => _("scalixScalixObject"), - "Text" => _("boolean TRUE or FALSE for creating scalix object")), - "mailnode" => array( - "ext" => "FALSE", "Headline" => _("scalixMailnode"), - "Text" => _("comma separated org units for object mail node")), - "mboxaddr" => array( - "ext" => "FALSE", "Headline" => _("scalixEmailAddress"), - "Text" => _("E-Mail Adress of Scalix User")), - "scalixadmin" => array( - "ext" => "FALSE", "Headline" => _("scalixAdministrator"), - "Text" => _("boolean TRUE or FALSE for admin capability")), - "mboxadmin" => array( - "ext" => "FALSE", "Headline" => _("scalixMailboxAdministrator"), - "Text" => _("boolean TRUE or FALSE for mboxadmin capability")), - "mboxclass" => array( - "ext" => "FALSE", "Headline" => _("scalixMailboxClass"), - "Text" => _("FULL or LIMITED for Class. LIMITED is a Scalix Standard User, FULL is a Scalix Premium User")) - ); - $return['attributes'] = array('scalixScalixObject', 'scalixAdministrator', 'scalixMailboxAdministrator', 'scalixMailnode','scalixMailboxClass','scalixEmailAddress'); - $return['objectClasses'] = array('scalixUserClass'); - return $return; - } - - /** - * This function loads all needed attributes into the object. - * - * @param array $attr an array as it is retured from ldap_get_attributes - */ - function load_attributes($attr) { - parent::load_attributes($attr); - //scalixScalixObject - if (is_string($this->attributes['scalixScalixObject'][0])) { - if ($this->attributes['scalixScalixObject'][0] == "TRUE") $this->scalixScalixObject = true; - else $this->scalixScalixObject = false; - } - //scalixAdministrator - if (is_string($this->attributes['scalixAdministrator'][0])) { - if ($this->attributes['scalixAdministrator'][0] == "TRUE") $this->scalixAdministrator = true; - else $this->scalixAdministrator = false; - } - //scalixMailboxAdministrator - if (is_string($this->attributes['scalixMailboxAdministrator'][0])) { - if ($this->attributes['scalixMailboxAdministrator'][0] == "TRUE") $this->scalixMailboxAdministrator = true; - else $this->scalixMailboxAdministrator = false; - } - //scalixMailnode - $this->attributes['objectClass'] = array(); - $this->attributes['scalixMailnode'] = array(); - $this->orig['objectClass'] = array(); - $this->orig['scalixMailnode'] = array(); - if (isset($attr['objectClass'])) { - $this->attributes['objectClass'] = $attr['objectClass']; - $this->orig['objectClass'] = $attr['objectClass']; - } - if (isset($attr['scalixMailnode'])) { - $this->attributes['scalixMailnode'] = $attr['scalixMailnode']; - $this->orig['scalixMailnode'] = $attr['scalixMailnode']; - } - - //scalixEmailAddress - $this->attributes['objectClass'] = array(); - $this->attributes['scalixEmailAddressx'] = array(); - $this->orig['objectClass'] = array(); - $this->orig['scalixEmailAddress'] = array(); - if (isset($attr['objectClass'])) { - $this->attributes['objectClass'] = $attr['objectClass']; - $this->orig['objectClass'] = $attr['objectClass']; - } - if (isset($attr['scalixEmailAddress'])) { - $this->attributes['scalixEmailAddress'] = $attr['scalixEmailAddress']; - $this->orig['scalixEmailAddress'] = $attr['scalixEmailAddress']; - } - //scalixMailboxClass - $this->attributes['objectClass'] = array(); - $this->attributes['scalixMailboxClass'] = array(); - $this->orig['objectClass'] = array(); - $this->orig['scalixMailboxClass'] = array(); - if (isset($attr['objectClass'])) { - $this->attributes['objectClass'] = $attr['objectClass']; - $this->orig['objectClass'] = $attr['objectClass']; - } - if (isset($attr['scalixMailboxClass'])) { - $this->attributes['scalixMailboxClass'] = $attr['scalixMailboxClass']; - $this->orig['scalixMailboxClass'] = $attr['scalixMailboxClass']; - } - // add object class if needed - if (! in_array('scalixUserClass', $this->orig['objectClass'])) { - $this->attributes['objectClass'][] = 'scalixUserClass'; - } - return 0; - } - - /** - * Returns a list of modifications which have to be made to the LDAP account. - * - * @return array list of modifications - *
This function returns an array with 3 entries: - *
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) - *
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) - *
"add" are attributes which have to be added to LDAP entry - *
"remove" are attributes which have to be removed from LDAP entry - *
"modify" are attributes which have to been modified in LDAP entry - */ - function save_attributes() { - return $_SESSION[$this->base]->save_module_attributes($this->attributes, $this->orig); - } - - /** - * This function will create the meta HTML code to show a page with all attributes. - * - * @param array $post HTTP-POST values - */ - function display_html_attributes() { - $return = array(); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Scalix User') ), - 1 => array ( 'kind' => 'input', 'name' => 'scalixScalixObject', 'type' => 'checkbox', 'checked' => $this->scalixScalixObject, 'value' => 'true'), - 2 => array ('kind' => 'help', 'value' => 'scalixuser')); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Mailnode') ), - 1 => array ( 'kind' => 'input', 'type' => 'text', 'name' => 'scalixMailnode', 'size' => '20', 'maxlength' => '255', 'value' => $this->attributes['scalixMailnode'][0]), - 2 => array ( 'kind' => 'help', 'value' => 'mailnode' )); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Mboxaddr') ), - 1 => array ( 'kind' => 'input', 'type' => 'text', 'name' => 'scalixEmailAddress', 'size' => '20', 'maxlength' => '255', 'value' => $this->attributes['scalixEmailAddress'][0]), - 2 => array ( 'kind' => 'help', 'value' => 'mboxaddr' )); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Scalix Admin') ), - 1 => array ( 'kind' => 'input', 'name' => 'scalixAdministrator', 'type' => 'checkbox', 'checked' => $this->scalixAdministrator, 'value' => 'true'), - 2 => array ('kind' => 'help', 'value' => 'scalixadmin')); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Scalix Mailbox Admin') ), - 1 => array ( 'kind' => 'input', 'name' => 'scalixMailboxAdministrator', 'type' => 'checkbox', 'checked' => $this->scalixMailboxAdministrator, 'value' => 'true'), - 2 => array ('kind' => 'help', 'value' => 'mboxadmin')); - $mboxes = array(0 => 'LIMITED', 1 => 'FULL'); - $return[] = array ( 0 => array ( 'kind' => 'text', 'text' => _('Scalix Mailbox Class') ), - 1 => array ( 'kind' => 'select', 'type' => 'text', 'name' => 'scalixMailboxClass', 'options' => $mboxes, 'size' => '1', 'maxlength' => '255', 'options_selected' => $this->attributes['scalixMailboxClass'][0]), - 2 => array ( 'kind' => 'help', 'value' => 'mboxclass' )); - return $return; - } - - function get_pdfEntries() { - return array( - 'scalixUserClass_scalixScalixObject' => array('' . _('Scalix User') . '' . $this->attributes['scalixScalixObject'][0] . ''), - 'scalixUserClass_scalixMailnode' => array('' . _('Mailnode') . '' . $this->attributes['scalixMailnode'][0] . ''), - 'scalixUserClass_scalixMboxaddr' => array('' . _('Mboxaddr') . '' . $this->attributes['scalixEmailAddress'][0] . ''), - 'scalixUserClass_scalixMailboxClass' => array('' . _('Scalix Mailbox Class') . '' . $this->attributes['scalixMailboxClass'][0] . ''), - 'scalixUserClass_scalixAdministrator' => array('' . _('Scalix Admin') . '' . $this->attributes['scalixAdministrator'][0] . ''), - 'scalixUserClass_scalixMailboxAdministrator' => array('' . _('Scalix Mailbox Admin') . '' . $this->attributes['scalixMailboxAdministrator'][0] . '')); - } - - /** - * Processes user input of the primary module page. - * It checks if all input values are correct and updates the associated LDAP attributes. - * - * @param array $post HTTP-POST values - * @return array list of info/error messages - */ - function process_attributes() { - $this->triggered_messages = array(); - if (isset($_POST['scalixScalixObject'])) { - $this->scalixScalixObject = true; - $this->attributes['scalixScalixObject'][0] = "TRUE"; - } else { - $this->scalixScalixObject = false; - $this->attributes['scalixScalixObject'][0] = "FALSE"; - } - $this->attributes['scalixMailnode'][0] = $_POST['scalixMailnode']; - $this->attributes['scalixEmailAddress'][0] = $_POST['scalixEmailAddress']; - $this->attributes['scalixMailboxClass'][0] = $_POST['scalixMailboxClass']; - if (isset($_POST['scalixAdministrator'])) { - $this->scalixAdministrator = true; - $this->attributes['scalixAdministrator'][0] = "TRUE"; - } else { - $this->scalixAdministrator = false; - $this->attributes['scalixAdministrator'][0] = "FALSE"; - } - if (isset($_POST['scalixMailboxAdministrator'])) { - $this->scalixMailboxAdministrator = true; - $this->attributes['scalixMailboxAdministrator'][0] = "TRUE"; - } else { - $this->scalixMailboxAdministrator = false; - $this->attributes['scalixMailboxAdministrator'][0] = "FALSE"; - } - - if (sizeof($this->triggered_messages) > 0) { - $this->inputCorrect = false; - return $this->triggered_messages; - } - else { - $this->inputCorrect = true; - return 0; - } - } - - /** - * This function returns true if all needed settings are done. - */ - function module_complete() { - return $this->inputCorrect; - } - - /** - * Returns true if all settings on module page are correct. - */ - function module_ready() { - return $this->inputCorrect; - } - - function get_profileOptions() { - $return = array(); - // use Unix password as Samba password - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Scalix User') . ': '), - 1 => array('kind' => 'input', 'name' => 'scalixUserClass_scalixScalixObject', 'type' => 'checkbox', 'checked' => true), - 2 => array('kind' => 'help', 'value' => 'scalixuser') - ); - $mboxes = array(0 => 'LIMITED', 1 => 'FULL'); - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Mailnode') . ': '), - 1 => array('kind' => 'input', 'type' => 'text', 'name' => 'scalixUserClass_scalixMailnode', 'size' => '30', 'maxlength' => '255', 'value' => ''), - 2 => array('kind' => 'help', 'value' => 'mailnode') - ); - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Mboxaddr') . ': '), - 1 => array('kind' => 'select', 'type' => 'text', 'name' => 'scalixUserClass_scalixEmailAddress', 'size' => '30', 'maxlength' => '255', 'value' => ''), - 2 => array('kind' => 'help', 'value' => 'mboxaddr') - ); - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Scalix Mailbox Class') . ': '), - 1 => array('kind' => 'select', 'type' => 'text', 'name' => 'scalixUserClass_scalixMailboxClass', 'size' => '1', 'maxlength' => '255', 'options' => $mboxes, 'options_selected' => $this->attributes['scalixMailboxClass'][0]), - 2 => array('kind' => 'help', 'value' => 'mboxclass') - ); - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Scalix Admin') . ': '), - 1 => array('kind' => 'input', 'name' => 'scalixUserClass_scalixAdministrator', 'type' => 'checkbox', 'checked' => false), - 2 => array('kind' => 'help', 'value' => 'scalixadmin') - ); - $return[] = array( - 0 => array('kind' => 'text', 'text' => _('Scalix Mailbox Admin') . ': '), - 1 => array('kind' => 'input', 'name' => 'scalixUserClass_scalixMailboxAdministrator', 'type' => 'checkbox', 'checked' => false), - 2 => array('kind' => 'help', 'value' => 'mboxadmin') - ); - return $return; - } - - /** - * Loads the values of an account profile into internal variables. - * - * @param array $profile hash array with profile values (identifier => value) - */ - function load_profile($profile) { - // profile mappings in meta data - parent::load_profile($profile); - // special profile options - if ($profile['scalixUserClass_scalixScalixObject'][0] == "true") { - $this->scalixScalixObject = true; - } - elseif ($profile['scalixUserClass_scalixScalixObject'][0] == "false") { - $this->scalixScalixObject = false; - } - if ($profile['scalixUserClass_scalixAdministrator'][0] == "true") { - $this->scalixAdministrator = true; - } - elseif ($profile['scalixUserClass_scalixAdministrator'][0] == "false") { - $this->scalixAdministrator = false; - } - if ($profile['scalixUserClass_scalixMailboxAdministrator'][0] == "true") { - $this->scalixMailboxAdministrator = true; - } - elseif ($profile['scalixUserClass_scalixMailboxAdministrator'][0] == "false") { - $this->scalixMailboxAdministrator = false; - } - if (isset($profile['scalixUserClass_scalixMailnode'][0])) { - $this->attributes['scalixMailnode'][0] = $profile['scalixUserClass_scalixMailnode'][0]; - } - if (isset($profile['scalixUserClass_scalixEmailAddress'][0])) { - $this->attributes['scalixEmailAddress'][0] = $profile['scalixUserClass_scalixEmailAddress'][0]; - } - if (isset($profile['scalixUserClass_scalixMailboxClass'][0])) { - $this->attributes['scalixMailboxClass'][0] = $profile['scalixUserClass_scalixMailboxClass'][0]; - } - } -} - - -?> - diff --git a/lam-web/todo/bugs.htm b/lam-web/todo/bugs.htm deleted file mode 100644 index 3dec92a8..00000000 --- a/lam-web/todo/bugs.htm +++ /dev/null @@ -1,429 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Submit a new bug report

-Please use our bug tracker to submit new bug reports. -
-
-
- -

Known bugs

- -

LAM 2.3.0

- - - - - - - - - - - - - - - - -
 Severity  BTS link  Description 
Minor2059740Problems With DN containing ( and )
Minor2103936Problem with gecos field in file upload
-
- -

LAM 2.2.0

- - - - - - - - - - - -
 Severity  BTS link  Description 
Minor1912736XHTML headers should be removed
-
- -

LAM 2.1.0

- - - - - - - - - -
 Severity  BTS link  Description 
No known bugs
-
- -

LAM 2.0.0

- - - - - - - - - - - - - - - - - - - - - - - - - - -
 Severity  BTS link  Description 
Normal1814578Samba domain: Lockout users after bad logon attempts must allow 0 - 999
Normal1811728Managing group quotas does not work
Normal1792447LAM does not run on PHP < 5.2.0
Normal1788752LAM Pro: UTF-8 characters are invalid displayed on configuration page
-
- -

LAM 1.3.0

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 Severity  BTS link  Description 
Normal1742543PHP Warning: mcrypt_decrypt(): The IV parameter must be ...
Normal1719168User list: refreshing GID translation does not work
Minor1740499allow uid as RDN attribute for inetOrgPerson
Minor1757215uid attribute no longer required for InetOrgPerson
Minor1702132OU editor: help images
Minor1702269Config editor: extra space
Minor1694863Some inconsistent help entries
-
- -

LAM 1.2.0

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 Severity  BTS link  Description 
Security1687379LAM does not escape HTML special chars in LDAP data
Normal1658868PDF generates wrong shadow expire information
Minor1660493Debian package does not include lamdaemonOld.pl
Minor1664542Samba groups: wrong help link
Minor1674198NIS mail aliases: allow more characters in alias name
-
- -

LAM 1.1.1

- - - - - - - - - - - - - - - - -
 Severity  BTS link  Description 
MinorLamdaemon test: works not with PHP 4
Minor1562426InetOrgPerson: Problems with error messages
-
- -

LAM 1.1.0

- - - - - - - - - - - - - - - - - - - - - -
 Severity  BTS link  Description 
Normal1562426Unix: Password hash is always SSHA
MinorUnix: No error message for wrong UID numbers in file upload
MinorFilters in account lists get lost when sorting the table
-
- - -
- - - - diff --git a/lam-web/todo/index.htm b/lam-web/todo/index.htm deleted file mode 100644 index a0f832b8..00000000 --- a/lam-web/todo/index.htm +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - - - - - - - - - - -
  - - -

Roadmap

-
-

Here we inform you about what we plan to include -in the upcoming releases.
-
-

-Long-term topics: -
    -
  • full integration of phpLDAPadmin
  • -
-LAM 2.4.0 (July 2008): -
    -
  • LDAP links
  • -
  • new account modules
  • -
- -
-
- -
- - - -