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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongodb-bson-regex.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\Regex::__construct</refname>
<refpurpose>Construct a new Regex</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\Regex::__construct</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>flags</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter> (<type>string</type>)</term>
<listitem>
<para>
The regular expression pattern.
</para>
<note>
<simpara>
The pattern should not be wrapped with delimiter characters.
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter> (<type>string</type>)</term>
<listitem>
<para>
The <link xlink:href="&url.mongodb.docs.regex;#op._S_options">regular
expression flags</link>. Characters in this argument will be sorted
alphabetically.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
<member>Throws <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> if <parameter>pattern</parameter> or <parameter>flags</parameter> contain null bytes.</member>
</simplelist>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 1.2.0</entry>
<entry>
<para>
The <parameter>flags</parameter> argument is optional and defaults to
an empty string.
</para>
<para>
Characters in the <parameter>flags</parameter> argument will be sorted
alphabetically when a Regex is constructed. Previously, the characters
were stored in the order provided.
</para>
<para>
<classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>
is thrown if <parameter>pattern</parameter> or
<parameter>flags</parameter> contain null bytes. Previously, values
would be truncated at the first null byte.
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>MongoDB\BSON\Regex::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$regex = new MongoDB\BSON\Regex('^foo', 'i');
var_dump($regex);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(MongoDB\BSON\Regex)#1 (2) {
["pattern"]=>
string(4) "^foo"
["flags"]=>
string(1) "i"
}
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&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>
</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
-->
|
