From ef0c6d581bc4801bbf3b10f36701ab3a933c8c73 Mon Sep 17 00:00:00 2001
From: Jeremy Mikola <jmikola@php.net>
Date: Wed, 6 Jan 2016 17:50:41 +0000
Subject: [PATCH] Clarify pattern/flags for MongoDB\BSON\Regex

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338408 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mongodb/bson/regex/construct.xml | 11 ++++++++---
 reference/mongodb/bson/regex/getflags.xml  |  3 ++-
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/reference/mongodb/bson/regex/construct.xml b/reference/mongodb/bson/regex/construct.xml
index 8c40d8c663..00cf5fe4da 100644
--- a/reference/mongodb/bson/regex/construct.xml
+++ b/reference/mongodb/bson/regex/construct.xml
@@ -27,13 +27,17 @@
      <para>
       The regular expression pattern.
      </para>
+     <note>
+      <para>The pattern should not be wrapped with delimiter characters.</para>
+     </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter> (<type>string</type>)</term>
     <listitem>
      <para>
-      The regular expression flags.
+      The <link xlink:href="&url.mongodb.docs.regex;#op._S_options">regular
+      expression flags</link>.
      </para>
     </listitem>
    </varlistentry>
@@ -56,7 +60,7 @@
 <![CDATA[
 <?php
 
-$regex = new MongoDB\BSON\Regex('regex', 'i');
+$regex = new MongoDB\BSON\Regex('^foo', 'i');
 var_dump($regex);
 
 ?>
@@ -67,7 +71,7 @@ var_dump($regex);
 <![CDATA[
 object(MongoDB\BSON\Regex)#1 (2) {
   ["pattern"]=>
-  string(5) "regex"
+  string(4) "^foo"
   ["flags"]=>
   string(1) "i"
 }
@@ -81,6 +85,7 @@ object(MongoDB\BSON\Regex)#1 (2) {
   &reftitle.seealso;
   <simplelist>
    <member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
+   <member><link xlink:href="&url.mongodb.docs.regex;#op._S_options">Supported regular expression flags</link></member>
   </simplelist>
  </refsect1>
 
diff --git a/reference/mongodb/bson/regex/getflags.xml b/reference/mongodb/bson/regex/getflags.xml
index 8fd26f7ac3..3c97a59fcd 100644
--- a/reference/mongodb/bson/regex/getflags.xml
+++ b/reference/mongodb/bson/regex/getflags.xml
@@ -25,7 +25,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns the Regex&apos;s flags
+   Returns the Regex&apos;s flags.
   </para>
  </refsect1>
 
@@ -65,6 +65,7 @@ string(1) "i"
   &reftitle.seealso;
   <simplelist>
    <member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
+   <member><link xlink:href="&url.mongodb.docs.regex;#op._S_options">Supported regular expression flags</link></member>
   </simplelist>
  </refsect1>