README

安装

如果您尚未安装，安装该组件与安装Composer一样简单。

然后，在您的项目根目录下创建一个新的文件，命名为composer.json，并将以下内容粘贴到其中

{
    "require": {
        "tiesa/ldap": "dev-master"
    }
}

要选择组件名称和版本，您应参考Packagist上的信息。

然后，您就可以下载所有供应商库并生成自动加载配置文件了。

$ php composer.phar install

从那里开始，在您的脚本顶部添加以下代码，就可以轻松加载LDAP组件类以及任何在您的composer.json配置中支持的包

require_once '/path/to/project/vendor/autoload.php';

使用方法

连接和绑定

连接LDAP的典型顺序不仅包括与服务器建立连接，还包括绑定用户。操作如下：

<?php

use Toyota\Component\Ldap\Core\Manager;
use Toyota\Component\Ldap\Platform\Native\Driver;

$params = array(
    'hostname'      => 'ldap.example.com',
    'base_dn'       => 'dc=example,dc=com'
);
$manager = new Manager($params, new Driver());

$manager->connect();

// Anonymous binding
$manager->bind();

// Ready for searching & persisting information

大多数情况下，您必须使用具有特权的用户来绑定LDAP，以便执行持久性操作。

$manager->bind('cn=user,dc=example,dc=com', 'myTopSecretPassword');

连接参数

我们在连接和绑定介绍中已经看到了一组最小的参数。然而，还有很多配置选项可供选择。

hostname: LDAP服务器的FQDN
port: 在LDAP服务器上连接的端口号（默认为389用于常规连接，636用于SSL连接）
security: SSL或TLS之一。如果没有设置安全选项，连接将是纯文本连接
bind_dn: 用于绑定的默认区分名（在这种情况下，$manager->bind()将不再是匿名的）
bind_password: 用于绑定的默认密码
options: 默认情况下启用连接的LDAP选项（请参阅Toyota\Component\Ldap\API\ConnectionInterface）

错误处理

所有Ldap错误代码和消息都通过方便的异常处理，这些错误代码和消息通常很麻烦跟踪（并且很容易忘记）。

因此，例如，您可以编写以下代码：

<?php
// ... namespace imports and $params configuration
$manager = new Manager($params, new Driver());

try {
    $manager->connect();
} catch (ConnectionException $e) {
    // Do something about it
}

try {
    $manager->bind();
} catch (BindingException $e) {
    // Do something about it
}

// ...

所有可用的异常都位于Toyota\Component\Ldap\Exception命名空间中。

搜索LDAP

最基本和最复杂的搜索都通过唯一的API处理。这是ldap_read或ldap_list或ldap_search困境的终结。

<?php
// ... $manager connection & binding

$results = $manager->search(Search::SCOPE_ALL, 'ou=comp,dc=example,dc=com', '(objectclass=*)');

// A search result instance is retrieved which provides iteration capability for a convenient use

foreach ($results as $node) {
    echo $node->getDn();
    foreach ($node->getAttributes() as $attribute) {
        echo sprintf('%s => %s', $attribute->getName(), implode(',', $attribute->getValues()));
    }
}

SCOPE_ALL将允许您搜索包括您提供的具有区分名的基准节点在内的整个子树。其他选项包括：

SCOPE_BASE: 只搜索与给定区分名匹配的一个节点
SCOPE_ONE: 搜索与给定区分名匹配的节点之下的节点

为了更方便，组件提供了一种直接方法，当您知道其区分名时，可以检索一个节点

<?php
$node = $manager->getNode('cn=my,ou=node,dc=example,dc=com');

将信息持久化到LDAP

忘记所有ldap_mod_add、ldap_mod_del、ldap_mod_replace、ldap_add和ldap_delete。现在您只需要记住save()和delete()。组件将跟踪您对LDAP条目所做的所有更改，并将自动发出正确的函数调用以在目录中执行这些更改

<?php

$node = $manager->getNode('cn=node,ou=to,ou=update,dc=example,dc=com');
$node->get('username')->set('test_user');
$node->get('objectClass')->add('inetOrgPerson');
$node->get('sn')->set('Doe');
$node->removeAttribute('whatever');

$manager->save($node);

// Update done

$node = new Node()
$node->setDn('ou=create',dc=example,dc=com');
$node->get('objectClass', true)->add(array('top', 'organizationalUnit'));
// The true param creates the attribute on the fly
$node->get('ou', true)->set('create');

$manager->save($node);

// New Ldap entry saved

$manager->delete($node);

// Now it's gone

资源

要运行测试套件，请在您的开发环境中从github克隆项目。从分发版本开始打包您自己的autoload.php和phpunit.xml版本，您就准备就绪了。

$ php composer.phar install --dev
$ vendor/bin/phpunit

mrdm-nl / ldap

维护者

详细信息