Object encapsulation of PHP's native ldap functions
Object-oriented implementation of PHP's native ldap functions
This small library provides access to ldap functions in a nice, object-oriented implementation.
Its purpose is not to provide fancy extra functionality for ldap interaction, but only to provide an object-level encapsulation around native PHP functions in a way that makes sense for OOP world. As such, this library is intended either for those who prefer OOP programming style, for those who want to be able to test their ldap interaction or for those who would like to write their own libraries which provide that fancy extra functionality.
- PHP 5.4 and newer with LDAP support (setup instructions)
- OpenSSL module for SSL / TLS connections (setup instructions)
ldap_escapeare also available as long as they are present in your current PHP version.
ldap_modify_batch- available in PHP 5.4 branch since 5.4.26 and in higher versions of PHP since 5.5.10
ldap_escape- available since PHP 5.6.0
composer require dreamscapes/ldap-core:dev-master (visit Packagist for list of all available versions)
Since Composer will not allow you to install a library on a system which does not meet the system requirements listed in composer.json, it is necessary that you enable the ldap extension before invoking
composer install, i.e. in the before_install build lifecycle:
echo "extension=ldap.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
See the Travis docs for detailed information.
There are two classes -
Dreamscapes\Ldap\Core\Result, each of which implement part of the native ldap functions as instance methods (some functions which do not operate on the resource objects are static). The differentiating principle is simple - if the function deals with the state of the ldap connection, it is implemented in the first, whereas functions dealing with the data returned from ldap server (the result resource) are implemented in the latter class.
All methods are named as close to the original functions as possible, although with some improvements:
- Ldap v3 protocol is used by default
- The ldap_ prefix is removed from all method names
- The method names are camelCased instead of underscore_based
- All methods return data by returning them and not by populating variables passed as references
- Some functions are not implemented (usually because they are redundant)
- Exceptions are thrown if the ldap protocol encounters an error, and standard PHP warnings and errors are suppressed in most cases
// Load Composer's autoload script... include 'vendor/autoload.php'; // Import the class into current namespace use Dreamscapes\Ldap\Core\Ldap; // If ldap URI is provided, the Ldap instance will also open the connection // via ldap_connect() $con = new Ldap('ldap://example.com'); $con->bind('email@example.com', 'my pass'); // Example AD credentials // Read the rootDSE entry $res = $con->read('', 'objectclass=*', ['*']); // $res is now instance of Result class echo "Number of entries in resultset: " . $res->countEntries(); print_r($res->getEntries());
Online API documentation is available here. To generate API documentation offline:
git clone https://github.com/Dreamscapes/Ldap-Core.git cd Ldap-Core composer install make docs
Documentation is now available at ./docs/index.html
This software is licensed under the BSD (3-Clause) License. See the LICENSE file for more information.