Skip to content

Commit 2e5a764

Browse files
committed
PHPLIB-174: Document that socket paths must be URL-encoded
1 parent 6d9d362 commit 2e5a764

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/includes/apiargs-MongoDBClient-method-construct-param.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ description: |
1111
Any special characters in the URI components need to be encoded according to
1212
`RFC 3986 <http://www.faqs.org/rfcs/rfc3986.html>`_. This is particularly
1313
relevant to the username and password, which can often include special
14-
characters such as ``@``, ``:``, or ``%``. The :php:`rawurlencode()
15-
<rawurlencode>` function may be used to encode constituent parts of the URI.
14+
characters such as ``@``, ``:``, or ``%``. When connecting via a Unix domain
15+
socket, the socket path may contain special characters such as slashes and
16+
must be encoded. The :php:`rawurlencode() <rawurlencode>` function may be used
17+
to encode constituent parts of the URI.
1618
interface: phpmethod
1719
operation: ~
1820
optional: true

0 commit comments

Comments
 (0)