<!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>The MongoDB\BSON\Regex class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-bson-objectid.unserialize.html">MongoDB\BSON\ObjectId::unserialize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-regex.construct.html">MongoDB\BSON\Regex::__construct</a></div>
<div class="up"><a href="book.bson.html">MongoDB\BSON</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongodb-bson-regex" class="reference">
<h1 class="title">The MongoDB\BSON\Regex class</h1>
<div class="partintro"><p class="verinfo">(mongodb >=1.0.0)</p>
<div class="section" id="mongodb-bson-regex.intro">
<h2 class="title">Introduction</h2>
<p class="para">
BSON type for a regular expression pattern and optional
<a href="https://docs.mongodb.com/manual/reference/operator/query/regex/#op._S_options" class="link external">» flags</a>.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
This BSON type is mainly used when querying the database. Alternatively,
the
<a href="https://docs.mongodb.com/manual/reference/operator/query/regex" class="link external">» $regex</a>
query operator may be used.
</span>
</p></blockquote>
</div>
<div class="section" id="mongodb-bson-regex.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="modifier">final</span>
<span class="ooclass">
<strong class="classname">MongoDB\BSON\Regex</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.mongodb-bson-regexinterface.html" class="interfacename">MongoDB\BSON\RegexInterface</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.mongodb-bson-type.html" class="interfacename">MongoDB\BSON\Type</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.jsonserializable.html" class="interfacename">JsonSerializable</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-regex.construct.html" class="methodname">__construct</a></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 class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-regex.getflags.html" class="methodname">getFlags</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-regex.getpattern.html" class="methodname">getPattern</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="mongodb-bson-regex.jsonserialize.html" class="methodname">jsonSerialize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-regex.serialize.html" class="methodname">serialize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-regex.tostring.html" class="methodname">__toString</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-bson-regex.unserialize.html" class="methodname">unserialize</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$serialized</code></span>
)</div>
}</div>
</div>
<div class="section">
<h2 class="title">Changelog</h2>
<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>
Implements <span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span> and
<span class="interfacename"><a href="class.jsonserializable.html" class="interfacename">JsonSerializable</a></span>.
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-bson-regex.construct.html">MongoDB\BSON\Regex::__construct</a> — Construct a new Regex</li><li><a href="mongodb-bson-regex.getflags.html">MongoDB\BSON\Regex::getFlags</a> — Returns the Regex's flags</li><li><a href="mongodb-bson-regex.getpattern.html">MongoDB\BSON\Regex::getPattern</a> — Returns the Regex's pattern</li><li><a href="mongodb-bson-regex.jsonserialize.html">MongoDB\BSON\Regex::jsonSerialize</a> — Returns a representation that can be converted to JSON</li><li><a href="mongodb-bson-regex.serialize.html">MongoDB\BSON\Regex::serialize</a> — Serialize a Regex</li><li><a href="mongodb-bson-regex.tostring.html">MongoDB\BSON\Regex::__toString</a> — Returns the string representation of this Regex</li><li><a href="mongodb-bson-regex.unserialize.html">MongoDB\BSON\Regex::unserialize</a> — Unserialize a Regex</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-bson-objectid.unserialize.html">MongoDB\BSON\ObjectId::unserialize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-regex.construct.html">MongoDB\BSON\Regex::__construct</a></div>
<div class="up"><a href="book.bson.html">MongoDB\BSON</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
