ldap_exop

(PHP 7 >= 7.2.0, PHP 8)

ldap_exop — 拡張されたオペレーションを実行する

説明

function ldap_exop(
    LDAP\Connection $ldap,
    string $request_oid,
    string $request_data = null,
    array $controls = null,
    string &$response_data = ?,
    string &$response_oid = ?
): mixed

指定された ldap で オペレーションの OID を request_oid で指定し、 データを request_data で指定して拡張されたオペレーションを実行します。

警告

4 個を超えるパラメータの使用は推奨されなくなりました。 代わりに ldap_exop_sync() を使ってください。

パラメータ

ldap
ldap_connect() が返す LDAP\Connection クラスのインスタンス。
request_oid
拡張オペレーションリクエストの OID。 LDAP_EXOP_* 定数のいずれか、 または操作の OID を示す文字列。
request_data
拡張オペレーションリクエストのデータ。 LDAP_EXOP_WHO_AM_I のように、 操作によってはNULLで問題ない場合もありますし、 BER エンコードが必要な場合もあります。
controls
リクエストと一緒に送信する LDAP コントロール の配列。
response_data
この値を指定すると、拡張オペレーションレスポンスの値で埋められます。 指定しなかった場合に後でこのデータを取得するには、 結果オブジェクトに対して ldap_parse_exop() を使います。
response_oid
この値を指定すると、レスポンスの OID で埋められます。 これは通常、リクエストの OID と等しい値です。

戻り値

response_data を指定した場合、成功時に true を返し、エラー時に false を返します。 response_data を指定しなかった場合、結果識別子を返し、 エラー時に false を返します。

変更履歴

バージョン 説明
8.4.0 4 個を超えるパラメータの使用は推奨されなくなりました。 代わりに ldap_exop_sync() を使ってください。
8.1.0 引数 ldap は、LDAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な ldap link resource を期待していました。
7.3.0 controls のサポートが追加されました。

例

例1 Whoami 拡張オペレーション

<?php
$ds = ldap_connect("localhost"); // assuming the LDAP server is on this host

if ($ds) {
// bind with appropriate dn to give update access
$bind = ldap_bind($ds, "cn=root, o=My Company, c=US", "secret");
if (!$bind) {
echo "Unable to bind to LDAP server";
exit;
}

// Call WHOAMI EXOP
$r = ldap_exop($ds, LDAP_EXOP_WHO_AM_I);

// Parse the result object
ldap_parse_exop($ds, $r, $retdata);
// Output: string(31) "dn:cn=root, o=My Company, c=US"
var_dump($retdata);

// Same thing using $response_data parameter
$success = ldap_exop($ds, LDAP_EXOP_WHO_AM_I, NULL, NULL, $retdata, $retoid);
if ($success) {
var_dump($retdata);
}

ldap_close($ds);
} else {
echo "Unable to connect to LDAP server";
}
?>

参考