LDIF ファイル

#
# This is a content LDIF file.
# It contains one single entry featuring several
# attributes and one comment (this one).
# attr1, attr4 and cn are single valued, the others are
# multivalued. objectclass is a special case, LDAP servers
# will interpret this operational attribute to define the
# classes the object will belong to and thus, which attributes
# it may contain. the OCL-attribute is usually multivalued.
#
version: 1
dn: cn=test1,ou=example,dc=cno
objectclass: someobjectclass
attr1: 12345
attr2: 1234
attr2: baz
attr3: foo
attr3: bar
attr4: brrrzztt
cn: test1

#
# This is a content+change LDIF file.
# It does contain the (shortened) entry from the example above to show
# that LDIF files can contain multiple entry modes.
# The second entry is a change entry. In this case, some
# operations will be done on the entries attributes.
#
version: 1
dn: cn=test1,ou=example,dc=cno
objectclass: someobjectclass
attr1: 12345
cn: test1

# Delete attr1, replace values of attr2 and add new attribute attr42
# The attribute "changetype" is special: it says, what to do with
# this entries dataset. It could also be "delete" or "add" to delete
# a whole entry or to add a completely fresh one. "modrdn" will
# move the entry to a new location once the LDIF file is imported.
dn: cn=test2,ou=example,dc=cno
changetype: modify
delete: attr1
-
replace: attr2
attr2: 123456_newtest
-
add: attr42
attr42: the answer

// LDIF ファイルを読み込みモードでオープンします
$ldif = new Net_LDAP_LDIF('somefile.ldif', 'r');
if ($ldif->error()) {
    $error_o = $ldif->error(); // エラー時は Net_LDAP_Error オブジェクトを取得します
            die('ERROR: '.$error_o->getMessage());
}

// LDIF ファイルのエントリをパースし、オブジェクトに格納します
 do {
    $entry = $ldif->read_entry();
    if ($ldif->error()) {
        // エラー時にはエラーを表示します。
        // ここでは短縮パラメータを使用しているので、error()
        // は Net_LDAP_Object ではなく文字列を返します
        die('ERROR AT INPUT LINE '.$ldif->error_lines().': '.$ldif->error(true));
    } else {
        // エラーなし: エントリに対して何らかの処理をします
        // ここでは単にエントリの DN を表示しています
        echo 'sucessfully parsed '.$entry->dn();
    }
} while (!$ldif->eof());

// 最後は done() をコールします
$ldif->done();

// $entries の中には Net_LDAP_Entry オブジェクトが格納されているものとします
        // $entries = array( ... );

        // 書き込み用にファイルをオープンします
        $ldif = new Net_LDAP_LDIF('somewritefile.ldif', 'w');
        if ($ldif->error()) die('ERROR: '.$error_o->getMessage());

        // データを書き込み、エラーチェックをします
        // 単一の Net_LDAP_Entry オブジェクトか、
        // オブジェクトの配列を渡します
        $ldif->write_entry($entries);
        if ($ldif->error()) die('WRITE ERROR: '.$error_o->getMessage());

// テストデータと 3 つのエントリを用意します
        $testattrs = array(
                'attr1' => '1234',
                'attr2' => 'foo',
                'attr3' => array('bar', 'baz')
            );
        $entries = array(
                Net_LDAP_Entry::createFresh('cn=foo,dc=example,dc=cno',
                    array_merge(array('cn' => 'foo'), $testattrs)),
                Net_LDAP_Entry::createFresh('cn=bar,dc=example,dc=cno',
                    array_merge(array('cn' => 'bar'), $testattrs)),
                Net_LDAP_Entry::createFresh('cn=baz,dc=example,dc=cno',
                    array_merge(array('cn' => 'baz'), $testattrs))
            );

        // 最初のエントリと最後のエントリに変更を加えます
        $entries[0]->add(array('someattr' => 'added'));
        $entries[0]->replace(array('attr1' => 'replaced'));
        $entries[2]->delete(array('attr2'));
        $entries[2]->delete(array('attr3' => 'bar'));

        // 書き込み用のファイルを change モードでオープンします
        $ldif = new Net_LDAP_LDIF('somewritefile.ldif', 'w', array('change' => true));
        if ($ldif->error()) die('ERROR: '.$error_o->getMessage());

        // データを書き込み、エラーチェックをします
        // 単一の Net_LDAP_Entry オブジェクトか、
        // オブジェクトの配列を渡します
        $ldif->write_entry($entries);
        if ($ldif->error()) die('WRITE ERROR: '.$error_o->getMessage());

        // LDIF ファイルに含まれるのは
        // cn=foo,dc=example,dc=cno と cn=baz,dc=example,dc=cno のふたつだけです。
        // cn=bar,dc=example,dc=cno には変更が加えられていないのでスキップされます。

version: 1
dn: cn=foo,dc=example,dc=cno
changetype: modify
add: someattr
someattr: added
-
replace: attr1
attr1: replaced
-

dn: cn=baz,dc=example,dc=cno
changetype: modify
delete: attr2
-
delete: attr3
attr3: bar
-

// LDIF ファイルを読み込み用にオープンします
// (この例では読みやすくするためにエラーチェックを省略していますが、
//  実際に使用する際には必ずエラーチェックをしましょう!)
$ldif = new Net_LDAP_LDIF('somefile.ldif', 'r');

// まだ何も読んでいないので、これは空の配列を返します
$empty_array = $ldif->current_lines();

// ではまず、最初のエントリのデータを読んでみましょう
$first_entry_lines = $ldif->next_lines();

// もう一度コールしたとしても、2 番目のエントリを読むわけではありません。
// これはもう一度最初の行を読むことになります!
$first_entry_lines_again = $ldif->next_lines();

// ここで current_lines() をコールしても、
// 先ほどと同様に次には進みません
$empty_array_again = $ldif->current_lines();

// 次に進めたい場合は read_entry() メソッドを使用します。
// これは、読み込んだ後に次に進みます
$first_entry = $ldif->read_entry();

// ここで、current_lines() は最初のエントリを返します。
// 一方 next_lines() は 2 番目の行を返します。
$first_entry_lines  = $ldif->current_lines();
$second_entry_lines = $ldif->next_lines();

// 行を移動するにはもうひとつのやりかたもあります。
// もし LDIF のコンテンツを読みたいだけなのならこちらのほうが高速です。
// この場合は "force" パラメータを next_lines() に渡します
$third_entry_lines  = $ldif->next_lines(true);
$fourth_entry_lines = $ldif->next_lines(true);
$fifth_entry_lines  = $ldif->next_lines(true);

// 行を Net_LDAP_Entry に変換したい場合は
// parseLines() を使用します
$fourth_entry = $ldif->parseLines($fourth_entry_lines);

// 手動で移動させたのは行だけなので、
// current_lines() は直近の Net_LDAP_Entry オブジェクト
// (最初のエントリ) の行を返します
$first_entry_lines  = $ldif->current_lines();

// 次のエントリに移動したい場合は、このようにします
$sixth_entry = $ldif->read_entry();

// これで current_lines() が移動しました
$sixth_entry_lines = $ldif->current_lines();