<!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 MongoRegex class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodate.tostring.html">MongoDate::__toString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoregex.construct.html">MongoRegex::__construct</a></div>
<div class="up"><a href="mongo.types.html">Types</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongoregex" class="reference">
<h1 class="title">The MongoRegex class</h1>
<div class="partintro"><p class="verinfo">(PECL mongo >=0.8.1)</p>
<div class="section" id="mongoregex.intro">
<h2 class="title">Introduction</h2>
<p class="para">
This class can be used to create regular expressions. Typically, these
expressions will be used to query the database and find matching strings.
More unusually, they can be saved to the database and retrieved.
</p>
<p class="para">
Regular expressions consist of four parts. First a <em>/</em>
as starting delimiter, then then pattern, another <em>/</em>
and finally a string containing flags.
</p>
<p class="para">
<div class="example" id="example-1497">
<p><strong>Example #1 Regular expression pattern</strong></p>
<div class="example-contents screen">
<div class="cdata"><pre>
/pattern/flags
</pre></div>
</div>
</div>
</p>
<p class="para">
MongoDB recognizes six regular expression flags:
</p>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<em>i</em>: Case insensitive
</p>
</li>
<li class="listitem">
<p class="para">
<em>m</em>: Multiline
</p>
</li>
<li class="listitem">
<p class="para">
<em>x</em>: Can contain comments
</p>
</li>
<li class="listitem">
<p class="para">
<em>l</em>: locale
</p>
</li>
<li class="listitem">
<p class="para">
<em>s</em>: dotall, "." matches everything, including newlines
</p>
</li>
<li class="listitem">
<p class="para">
<em>u</em>: match unicode
</p>
</li>
</ul>
</div>
<div class="section" id="mongoregex.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">MongoRegex</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Fields */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<span class="type">string</span>
<var class="varname">$<var class="varname">regex</var></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<span class="type">string</span>
<var class="varname">$<var class="varname">flags</var></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="mongoregex.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongoregex.tostring.html" class="methodname">__toString</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongoregex.construct.html">MongoRegex::__construct</a> — Creates a new regular expression</li><li><a href="mongoregex.tostring.html">MongoRegex::__toString</a> — A string representation of this regular expression</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodate.tostring.html">MongoDate::__toString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoregex.construct.html">MongoRegex::__construct</a></div>
<div class="up"><a href="mongo.types.html">Types</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
