diff options
author | Frédéric Guillot <fred@kanboard.net> | 2018-04-06 10:54:58 -0700 |
---|---|---|
committer | Frédéric Guillot <fred@kanboard.net> | 2018-04-06 10:54:58 -0700 |
commit | 0b306fa60ad84ea077111e0ff7b59208ba7bc8a3 (patch) | |
tree | 5d8941b5950ede2db8ca3fba0213792db0f07a50 /doc/en_US/plugin-ldap-client.markdown | |
parent | ac11220a1aa7ae30b8827d9bbf221888d3edd0a7 (diff) |
Move documentation to https://docs.kanboard.org/
Diffstat (limited to 'doc/en_US/plugin-ldap-client.markdown')
-rw-r--r-- | doc/en_US/plugin-ldap-client.markdown | 99 |
1 files changed, 0 insertions, 99 deletions
diff --git a/doc/en_US/plugin-ldap-client.markdown b/doc/en_US/plugin-ldap-client.markdown deleted file mode 100644 index 312eea71..00000000 --- a/doc/en_US/plugin-ldap-client.markdown +++ /dev/null @@ -1,99 +0,0 @@ -LDAP Library -============ - -To facilitate LDAP integration, Kanboard has its own LDAP library. -This library can perform common operations. - -Client ------- - -Class: `Kanboard\Core\Ldap\Client` - -To connect to your LDAP server easily, use this method: - -```php -use Kanboard\Core\Ldap\Client as LdapClient; -use Kanboard\Core\Ldap\ClientException as LdapException; - -try { - $client = LdapClient::connect(); - - // Get native LDAP resource - $resource = $client->getConnection(); - - // ... - -} catch (LdapException $e) { - // ... -} -``` - -LDAP Queries ------------- - -Classes: - -- `Kanboard\Core\Ldap\Query` -- `Kanboard\Core\Ldap\Entries` -- `Kanboard\Core\Ldap\Entry` - -Example to query the LDAP directory: - -```php - -$query = new Query($client) -$query->execute('ou=People,dc=kanboard,dc=local', 'uid=my_user', array('cn', 'mail')); - -if ($query->hasResult()) { - $entries = $query->getEntries(); // Return an instance of Entries -} -``` - -Read one entry: - -```php -$firstEntry = $query->getEntries()->getFirstEntry(); -$email = $firstEntry->getFirstValue('mail'); -$name = $firstEntry->getFirstValue('cn', 'Default Name'); -``` - -Read multiple entries: - -```php -foreach ($query->getEntries()->getAll() as $entry) { - $emails = $entry->getAll('mail'); // Fetch all emails - $dn = $entry->getDn(); // Get LDAP DN of this user - - // Check if a value is present for an attribute - if ($entry->hasValue('mail', 'user2@localhost')) { - // ... - } -} -``` - -User Helper ------------ - -Class: `Kanboard\Core\Ldap\User` - -Fetch a single user in one line: - -```php -// Return an instance of LdapUserProvider -$user = User::getUser($client, 'my_username'); -``` - -Group Helper ------------- - -Class: `Kanboard\Core\Ldap\Group` - -Fetch groups in one line: - -```php -// Define LDAP filter -$filter = '(&(objectClass=group)(sAMAccountName=My group*))'; - -// Return a list of LdapGroupProvider -$groups = Group::getGroups($client, $filter); -``` |