Skip to content

Memcached::__construct: Document callback and connection_str parameters #5376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dustaboy3 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Memcached::__construct: Document callback and connection_str parameters #5376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions reference/memcached/memcached/construct.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
Creates a Memcached instance representing the connection to the memcache
servers.
</para>
&warn.undocumented.func;
</refsect1>

<refsect1 role="parameters">
Expand All @@ -41,15 +40,24 @@
<term><parameter>callback</parameter></term>
<listitem>
<para>
<!-- TODO Document constructor params -->
An optional callback function that is invoked when a new persistent
connection is created. This can be used to perform initialization tasks
such as configuring options or adding servers.
</para>
<para>
The callback is only executed when a new persistent instance is created,
not when an existing persistent instance is reused.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>connection_str</parameter></term>
<listitem>
<para>
<!-- TODO Document constructor params -->
An optional connection string used to configure the Memcached instance.
The format of the connection string depends on the underlying libmemcached
library and may be used to define servers and connection options in a
single string.
</para>
</listitem>
</varlistentry>
Expand Down