mfischer Sun Feb 10 21:48:58 2002 EDT
Modified files:
/phpdoc/en/functions ldap.xml
Log:
- Correct protos.
Index: phpdoc/en/functions/ldap.xml
diff -u phpdoc/en/functions/ldap.xml:1.41 phpdoc/en/functions/ldap.xml:1.42
--- phpdoc/en/functions/ldap.xml:1.41 Sat Feb 2 10:36:02 2002
+++ phpdoc/en/functions/ldap.xml Sun Feb 10 21:48:58 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.41 $ -->
+<!-- $Revision: 1.42 $ -->
<reference id="ref.ldap">
<title>LDAP functions</title>
<titleabbrev>LDAP</titleabbrev>
@@ -212,8 +212,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_add</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_add</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>array</type><parameter>entry</parameter></methodparam>
</methodsynopsis>
@@ -275,8 +275,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_bind</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_bind</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>bind_rdn</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>bind_password</parameter></methodparam>
</methodsynopsis>
@@ -301,8 +301,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_close</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_close</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
@@ -333,8 +333,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_compare</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_compare</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>string</type><parameter>attribute</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
@@ -416,7 +416,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_connect</methodname>
+ <type>resource</type><methodname>ldap_connect</methodname>
<methodparam
choice="opt"><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>port</parameter></methodparam>
</methodsynopsis>
@@ -455,8 +455,8 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ldap_count_entries</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns number of entries in the result or &false; on error.</para>
@@ -477,8 +477,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_delete</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_delete</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
</methodsynopsis>
<para>
@@ -563,7 +563,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ldap_errno</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Return the LDAP error number of the last LDAP command for this
@@ -619,7 +619,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ldap_error</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns string error message.</para>
@@ -679,8 +679,8 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ldap_first_attribute</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>ber_identifier</parameter></methodparam>
</methodsynopsis>
<para>
@@ -715,9 +715,9 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_first_entry</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_identifier</parameter></methodparam>
+ <type>resource</type><methodname>ldap_first_entry</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns the result entry identifier for the first entry on
@@ -745,8 +745,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_free_result</methodname>
-
<methodparam><type>int</type><parameter>result_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_free_result</methodname>
+
+<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;</para>
@@ -774,8 +774,8 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ldap_get_attributes</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns a complete entry information in a multi-dimensional array
@@ -843,8 +843,8 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ldap_get_dn</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns the DN of the result entry and &false; on error.</para>
@@ -864,8 +864,8 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ldap_get_entries</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns a complete result information in a multi-dimenasional
@@ -915,7 +915,7 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ldap_get_option</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>retval</parameter></methodparam>
</methodsynopsis>
@@ -965,8 +965,8 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ldap_get_values</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>attribute</parameter></methodparam>
</methodsynopsis>
<para>
@@ -1038,8 +1038,8 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ldap_get_values_len</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>attribute</parameter></methodparam>
</methodsynopsis>
<para>
@@ -1074,8 +1074,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_list</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>resource</type><methodname>ldap_list</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
<methodparam><type>string</type><parameter>filter</parameter></methodparam>
<methodparam
choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
@@ -1146,8 +1146,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_modify</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_modify</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>array</type><parameter>entry</parameter></methodparam>
</methodsynopsis>
@@ -1169,8 +1169,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_mod_add</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_mod_add</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>array</type><parameter>entry</parameter></methodparam>
</methodsynopsis>
@@ -1193,8 +1193,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_mod_del</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_mod_del</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>array</type><parameter>entry</parameter></methodparam>
</methodsynopsis>
@@ -1217,8 +1217,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_mod_replace</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_mod_replace</methodname>
+
+<methodparam><type>resoure</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>array</type><parameter>entry</parameter></methodparam>
</methodsynopsis>
@@ -1242,9 +1242,9 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ldap_next_attribute</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam>
- <methodparam><type>int</type><parameter>ber_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>ber_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns the next attribute in an entry on success and &false; on
@@ -1271,9 +1271,9 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_next_entry</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
-
<methodparam><type>int</type><parameter>result_entry_identifier</parameter></methodparam>
+ <type>resource</type><methodname>ldap_next_entry</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns entry identifier for the next entry in the result whose
@@ -1304,8 +1304,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_read</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>resource</type><methodname>ldap_read</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
<methodparam><type>string</type><parameter>filter</parameter></methodparam>
<methodparam
choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
@@ -1358,7 +1358,7 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ldap_rename</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>string</type><parameter>newrdn</parameter></methodparam>
<methodparam><type>string</type><parameter>newparent</parameter></methodparam>
@@ -1392,8 +1392,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_search</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>resource</type><methodname>ldap_search</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
<methodparam><type>string</type><parameter>filter</parameter></methodparam>
<methodparam
choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
@@ -1548,7 +1548,7 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ldap_set_option</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>newval</parameter></methodparam>
</methodsynopsis>
@@ -1632,8 +1632,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_unbind</methodname>
-
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
+ <type>bool</type><methodname>ldap_unbind</methodname>
+
+<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;</para>
@@ -1674,9 +1674,9 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_first_reference</methodname>
- <methodparam><type>int</type><parameter>link</parameter></methodparam>
- <methodparam><type>int</type><parameter>result</parameter></methodparam>
+ <type>resource</type><methodname>ldap_first_reference</methodname>
+ <methodparam><type>resource</type><parameter>link</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
@@ -1696,9 +1696,9 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_next_reference</methodname>
- <methodparam><type>int</type><parameter>link</parameter></methodparam>
- <methodparam><type>int</type><parameter>entry</parameter></methodparam>
+ <type>resource</type><methodname>ldap_next_reference</methodname>
+ <methodparam><type>resource</type><parameter>link</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>entry</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
@@ -1719,8 +1719,8 @@
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>ldap_parse_reference</methodname>
- <methodparam><type>int</type><parameter>link</parameter></methodparam>
- <methodparam><type>int</type><parameter>entry</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>link</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>entry</parameter></methodparam>
<methodparam><type>array</type><parameter>referrals</parameter></methodparam>
</methodsynopsis>
<para>
@@ -1742,8 +1742,8 @@
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>ldap_parse_result</methodname>
- <methodparam><type>int</type><parameter>link</parameter></methodparam>
- <methodparam><type>int</type><parameter>result</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>link</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>errcode</parameter></methodparam>
<methodparam><type>string</type><parameter>matcheddn</parameter></methodparam>
<methodparam><type>string</type><parameter>errmsg</parameter></methodparam>
@@ -1767,8 +1767,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_set_rebind_proc</methodname>
- <methodparam><type>int</type><parameter>link</parameter></methodparam>
+ <type>bool</type><methodname>ldap_set_rebind_proc</methodname>
+ <methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
@@ -1789,9 +1789,9 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_sort</methodname>
- <methodparam><type>int</type><parameter>link</parameter></methodparam>
- <methodparam><type>int</type><parameter>result</parameter></methodparam>
+ <type>bool</type><methodname>ldap_sort</methodname>
+ <methodparam><type>resource</type><parameter>link</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>string</type><parameter>sortfilter</parameter></methodparam>
</methodsynopsis>
<para>
@@ -1812,8 +1812,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>ldap_start_tls</methodname>
- <methodparam><type>int</type><parameter>link</parameter></methodparam>
+ <type>bool</type><methodname>ldap_start_tls</methodname>
+ <methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
