Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
treadstone42 committed Apr 13, 2013
1 parent 690c86f commit 03b379f
Showing 1 changed file with 22 additions and 27 deletions.
49 changes: 22 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,62 @@
PHP LDAP CLASS FOR MANIPULATING ACTIVE DIRECTORY
Version 4.0.4
# PHP LDAP CLASS FOR MANIPULATING ACTIVE DIRECTORY
*Version 4.0.4*

Written by Scott Barnett, Richard Hyland
email: scott@wiggumworld.com, adldap@richardhyland.com
http://adldap.sourceforge.net/
https://github.com/Rich2k/adLDAP/

ABOUT
=====
## ABOUT

adLDAP is a PHP class that provides LDAP authentication and integration with Active Directory.

We'd appreciate any improvements or additions to be submitted back
to benefit the entire community :)

REQUIREMENTS
============
## REQUIREMENTS

adLDAP requires PHP 5 and both the LDAP (http://php.net/ldap) and SSL (http://php.net/openssl) libraries

INSTALLATION
============
## INSTALLATION

adLDAP is not an application, but a class library designed to integrate into your own applications.

The core of adLDAP is contained in the 'src' directory. Simply copy/rename this directory inside your own
projects.

Edit the file 'src/adLDAP.php' and change the configuration variables near the top, specifically
Edit the file ``src/adLDAP.php`` and change the configuration variables near the top, specifically
those for domain controllers, base dn and account suffix, and if you want to perform anything more complex
than use authentication you'll also need to set the admin username and password variables too.

From within your code simply require the adLDAP.php file and call it like so

require_once(dirname(__FILE__) . '/adLDAP.php');
$adldap = new adLDAP();
require_once(dirname(__FILE__) . '/adLDAP.php');
$adldap = new adLDAP();

It would be better to wrap it in a try/catch though

try {
$adldap = new adLDAP();
}
catch (adLDAPException $e) {
echo $e;
exit();
}
try {
$adldap = new adLDAP();
}
catch (adLDAPException $e) {
echo $e;
exit();
}

Then simply call commands against it e.g.

$adldap->authenticate($username, $password);
``$adldap->authenticate($username, $password);``

or

$adldap->group()->members($groupName);
``$adldap->group()->members($groupName);``

DOCUMENTATION
=============
## DOCUMENTATION

You can find our website at http://adldap.sourceforce.net or the class documentation at
You can find our website at https://github.com/Rich2k/adLDAP/ or the class documentation at

http://adldap.sourceforge.net/wiki/doku.php?id=documentation
https://github.com/Rich2k/adLDAP/wiki/adLDAP-Developer-API-Reference

LICENSE
=======
## LICENSE

This library is free software; you can redistribute it and/or modify it under the terms of the
GNU Lesser General Public License as published by the Free Software Foundation; either
Expand Down

0 comments on commit 03b379f

Please sign in to comment.