# The MongoDB\BSON\Regex class

(mongodb >=1.0.0)

## Introduction

BSON type for a regular expression pattern and optional » flags.

> Note: This BSON type is mainly used when querying the database. Alternatively, the » $regex query operator may be used.

## Class synopsis

final MongoDB\BSON\Regex implements MongoDB\BSON\RegexInterface , MongoDB\BSON\Type , Serializable , JsonSerializable {
/* Methods */
final public __construct ( string `$pattern` [, string `$flags` = "" ] )
final public getFlags ( void ) : string
final public getPattern ( void ) : string
final public jsonSerialize ( void ) : mixed
final public serialize ( void ) : string
final public __toString ( void ) : string
final public unserialize ( string `$serialized` ) : void
}

## Changelog

Version | Description
--- | ---
1.3.0 | Implements MongoDB\BSON\RegexInterface.
1.2.0 | Implements Serializable and JsonSerializable.

## Table of Contents

- MongoDB\BSON\Regex::__construct — Construct a new Regex
- MongoDB\BSON\Regex::getFlags — Returns the Regex's flags
- MongoDB\BSON\Regex::getPattern — Returns the Regex's pattern
- MongoDB\BSON\Regex::jsonSerialize — Returns a representation that can be converted to JSON
- MongoDB\BSON\Regex::serialize — Serialize a Regex
- MongoDB\BSON\Regex::__toString — Returns the string representation of this Regex
- MongoDB\BSON\Regex::unserialize — Unserialize a Regex