Skip to content

Commit c5732d3

Browse files
Fill Memcached::__construct() parameters description
1 parent 0e48683 commit c5732d3

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

reference/memcached/memcached/construct.xml

+13-4
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,25 @@
4040
<varlistentry>
4141
<term><parameter>callback</parameter></term>
4242
<listitem>
43-
<para>
44-
<!-- TODO Document constructor params -->
45-
</para>
43+
<methodsynopsis>
44+
<type>void</type><methodname><replaceable>callback</replaceable></methodname>
45+
<methodparam><type>Memcached</type><parameter>memcached</parameter></methodparam>
46+
<methodparam><type>string</type><parameter>persistent_id</parameter></methodparam>
47+
</methodsynopsis>
48+
<simpara>
49+
The <parameter>callback</parameter> parameter is called when the
50+
connection is established. It should be a valid PHP <type>callable</type>
51+
that receive the <classname>Memcached</classname> object as its first
52+
parameter, and <parameter>persistent_id</parameter> as its second.
53+
</simpara>
4654
</listitem>
4755
</varlistentry>
4856
<varlistentry>
4957
<term><parameter>connection_str</parameter></term>
5058
<listitem>
5159
<para>
52-
<!-- TODO Document constructor params -->
60+
This parameter is used to pass additional connection options to
61+
the memcache servers, such as a server weight in a cluster.
5362
</para>
5463
</listitem>
5564
</varlistentry>

0 commit comments

Comments
 (0)