<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Construct a new Regex</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-bson-regex.html">MongoDB\BSON\Regex</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-regex.getflags.html">MongoDB\BSON\Regex::getFlags</a></div>
<div class="up"><a href="class.mongodb-bson-regex.html">MongoDB\BSON\Regex</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-bson-regex.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\BSON\Regex::__construct</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\BSON\Regex::__construct</span> — <span class="dc-title">Construct a new Regex</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-bson-regex.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\BSON\Regex::__construct</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$pattern</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$flags</code><span class="initializer"> = ""</span></span>
] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-bson-regex.construct-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">pattern</code> (<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)</dt>
<dd>
<p class="para">
The regular expression pattern.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
The pattern should not be wrapped with delimiter characters.
</span>
</p></blockquote>
</dd>
<dt>
<code class="parameter">flags</code> (<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)</dt>
<dd>
<p class="para">
The <a href="https://docs.mongodb.com/manual/reference/operator/query/regex/#op._S_options" class="link external">» regular
expression flags</a>. Characters in this argument will be sorted
alphabetically.
</p>
</dd>
</dl>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-bson-regex.construct-errors">
<h3 class="title">Errors/Exceptions</h3>
<ul class="simplelist">
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li>
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> if <code class="parameter">pattern</code> or <code class="parameter">flags</code> contain null bytes.</li>
</ul>
</div>
<div class="refsect1 changelog" id="refsect1-mongodb-bson-regex.construct-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.2.0</td>
<td>
<p class="para">
The <code class="parameter">flags</code> argument is optional and defaults to
an empty string.
</p>
<p class="para">
Characters in the <code class="parameter">flags</code> argument will be sorted
alphabetically when a Regex is constructed. Previously, the characters
were stored in the order provided.
</p>
<p class="para">
<a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a>
is thrown if <code class="parameter">pattern</code> or
<code class="parameter">flags</code> contain null bytes. Previously, values
would be truncated at the first null byte.
</p>
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongodb-bson-regex.construct-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1773">
<p><strong>Example #1 <span class="function"><strong>MongoDB\BSON\Regex::__construct()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$regex </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">Regex</span><span style="color: #007700">(</span><span style="color: #DD0000">'^foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'i'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$regex</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
object(MongoDB\BSON\Regex)#1 (2) {
["pattern"]=>
string(4) "^foo"
["flags"]=>
string(1) "i"
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-bson-regex.construct-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="https://docs.mongodb.com/manual/reference/bson-types/" class="link external">» BSON Types</a></li>
<li class="member"><a href="https://docs.mongodb.com/manual/reference/operator/query/regex/#op._S_options" class="link external">» Supported regular expression flags</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-bson-regex.html">MongoDB\BSON\Regex</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-regex.getflags.html">MongoDB\BSON\Regex::getFlags</a></div>
<div class="up"><a href="class.mongodb-bson-regex.html">MongoDB\BSON\Regex</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
