README.md
1# PHP LDAP CLASS FOR MANIPULATING ACTIVE DIRECTORY
2*Version 4.0.4*
3
4Written by Scott Barnett, Richard Hyland
5email: scott@wiggumworld.com, adldap@richardhyland.com
6https://github.com/Rich2k/adLDAP/
7
8## ABOUT
9
10adLDAP is a PHP class that provides LDAP authentication and integration with Active Directory.
11
12We'd appreciate any improvements or additions to be submitted back
13to benefit the entire community :)
14
15## REQUIREMENTS
16
17adLDAP requires PHP 5 and both the LDAP (http://php.net/ldap) and SSL (http://php.net/openssl) libraries
18
19## INSTALLATION
20
21adLDAP is not an application, but a class library designed to integrate into your own applications.
22
23The core of adLDAP is contained in the 'src' directory. Simply copy/rename this directory inside your own
24projects.
25
26Edit the file ``src/adLDAP.php`` and change the configuration variables near the top, specifically
27those for domain controllers, base dn and account suffix, and if you want to perform anything more complex
28than use authentication you'll also need to set the admin username and password variables too.
29
30From within your code simply require the adLDAP.php file and call it like so
31
32 require_once(dirname(__FILE__) . '/adLDAP.php');
33 $adldap = new adLDAP();
34
35It would be better to wrap it in a try/catch though
36
37 try {
38 $adldap = new adLDAP();
39 }
40 catch (adLDAPException $e) {
41 echo $e;
42 exit();
43 }
44
45Then simply call commands against it e.g.
46
47``$adldap->authenticate($username, $password);``
48
49or
50
51``$adldap->group()->members($groupName);``
52
53## DOCUMENTATION
54
55You can find our website at https://github.com/Rich2k/adLDAP/ or the class documentation at
56
57https://github.com/Rich2k/adLDAP/wiki/adLDAP-Developer-API-Reference
58
59## LICENSE
60
61This library is free software; you can redistribute it and/or modify it under the terms of the
62GNU Lesser General Public License as published by the Free Software Foundation; either
63version 2.1 of the License, or (at your option) any later version.
64
65This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
66without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
67See the GNU Lesser General Public License for more details or LICENSE.txt distributed with
68this class.
69