doc-en/reference/ldap/functions/ldap-exop-sync.xml at master · php/doc-en · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.ldap-exop-sync" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_exop_sync</refname>
  <refpurpose>Performs an extended operation</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>LDAP\Result</type><type>bool</type></type><methodname>ldap_exop_sync</methodname>
   <methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
   <methodparam><type>string</type><parameter>request_oid</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>request_data</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">response_data</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">response_oid</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Performs an extended operation on the specified <parameter>ldap</parameter> with
   <parameter>request_oid</parameter> the <acronym>OID</acronym> of the operation and
   <parameter>request_data</parameter> the data.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>ldap</parameter></term>
    <listitem>
     <simpara>
      &ldap.parameter.ldap;
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>request_oid</parameter></term>
    <listitem>
     <simpara>
      The extended operation request <acronym>OID</acronym>.
      Can be one of the
      <constant>LDAP_EXOP_<replaceable>*</replaceable></constant>
      constants,
      or a string with the <acronym>OID</acronym> of the operation.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>request_data</parameter></term>
    <listitem>
     <simpara>
      The extended operation request data.
      May be &null; for some operations like <constant>LDAP_EXOP_WHO_AM_I</constant>,
      may also need to be <acronym>BER</acronym> encoded.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>controls</parameter></term>
    <listitem>
     <simpara>
      Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>response_data</parameter></term>
    <listitem>
     <simpara>
      Will be filled with the extended operation response data if provided.
      If not provided <function>ldap_parse_exop</function> may be used on the
      result object later to get this data.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>response_oid</parameter></term>
    <listitem>
     <simpara>
      Will be filled with the response <acronym>OID</acronym> if provided,
      usually equal to the request <acronym>OID</acronym>.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   When used with <parameter>response_data</parameter>,
   returns &true; on success or &false; on error.
   When used without <parameter>response_data</parameter>,
   returns a result identifier or &false; on error.
  </simpara>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>ldap_exop</function></member>
   <member><function>ldap_exop_whoami</function></member>
   <member><function>ldap_exop_refresh</function></member>
   <member><function>ldap_exop_passwd</function></member>
   <member><function>ldap_parse_result</function></member>
   <member><function>ldap_parse_exop</function></member>
  </simplelist>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->