[ PHPXref.com ] [ Generated: Sun Jul 20 17:00:49 2008 ] [ cmsdAm 0.8 ]
[ Index ]     [ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/classes/ -> cmsdam_ldap.php (summary)

(no description)

File Size: 594 lines (30 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 2 files
 etc/ldap_user.php
 etc/ldap_group.php

Defines 1 class

cmsdam_ldap:: (14 methods):
  ldap_ldapconnect()
  ldap_not_implemented()
  ldap_user_names()
  ldap_group_names()
  ldap_group_users_name()
  ldap_user_email()
  ldap_user_attr()
  ldap_user_exist()
  ldap_user_add()
  ldap_group_add()
  ldap_user_count()
  ldap_user_delete()
  ldap_group_del_user()
  ldap_user_check()


Class: cmsdam_ldap  - X-Ref

Yeah!! One of the things that make cmsdam a cool Content Management System Framework: LDAP support.
LDAP support in cmsdam is integrated in the users and group classes, so you don't need to call
these methods from your sections. This is only for developers.<br><br>
<b>Class instance:&nbsp;$cms-&gt;ldap</b>

ldap_ldapconnect()   X-Ref
Makes the LDAP connection and bind.
Returns False on errors and True on success.

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
return: bool False on errors and True on success

ldap_not_implemented($method)   X-Ref
Writes to debug and logs that the "$method" method is not implemented on LDAP and returns false.

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str method The method name not valid for LDAP
return: bool Always returns False

ldap_user_names()   X-Ref
This api method returns an array with ALL the user names from LDAP!

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
return: array ALL the user names from LDAP

ldap_group_names()   X-Ref
This api method returns an array with ALL the group names from LDAP!

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
return: array ALL the group names from LDAP

ldap_group_users_name($group)   X-Ref
Returns an array with all the usernames in "$group" group

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str group The groupname you want users of
return: array ALL the user names from LDAP for group "$group"

ldap_user_email($username)   X-Ref
Returns the email of the user "$username" from LDAP

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str username The username you want email of
return: str The email of the user "$username"

ldap_user_attr($username, $attribute)   X-Ref
Returns the given attribute of the user "$username" from LDAP (users tree)

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str username The username you want to retrieve
param: str attribute The LDAP attribute you want to retrieve for the user "$username"
return: str The attribute "$attribute" of the user "$username"

ldap_user_exist($username)   X-Ref
Returns True if the user "$username" exists in LDAP or False if don't.

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str username The username you want to know if it exists
return: bool True or False

ldap_user_add($username, $useremail, $userpassword)   X-Ref
Add a user into ldap. Please check etc/ldap_user.php.

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str username The username you want to add
param: str useremail The user email address
param: str userpassword The user's password
return: bool True or False

ldap_group_add($groupname, $username)   X-Ref
Add a user into ldap group, or create a group if it does not exists. Please check etc/ldap_user.php.

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str groupname The groupname you want to create/add
param: str username The username you want to add to the group groupname
return: bool True or False

ldap_user_count()   X-Ref
Returns the number of the users in LDAP!

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
return: int Returns the number of the users in LDAP

ldap_user_delete($username)   X-Ref
Delete a user from LDAP

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str username The username you want to delete from ldap
return: bool Returns true on success or false on errors

ldap_group_del_user($groupname, $username)   X-Ref
Delete $username user from $groupname group in LDAP

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str groupname The name of the group
param: str username The username you want to delete from the group in ldap
return: bool False on error, True on success

ldap_user_check($username, $password)   X-Ref
Returns true if user credentials are valid in LDAP. This is made doing LDAP bind.

author: dAm2K (Dino Ciuffetti) &lt;dam2k@users.sourceforge.net&gt;
param: str username The user you want to check
param: str password The password of the user
return: bool True if user credentials are valid, False if NOT



[ Powered by PHPXref - Served by Debian GNU/Linux ]