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
class MongoDB\BSON\Regex
implements
MongoDB\BSON\RegexInterface, MongoDB\BSON\Type, Serializable, JsonSerializable, Stringable {
/* Methods */
}Changelog
| Version | Description |
|---|---|
| PECL mongodb 1.12.0 | Implements Stringable for PHP 8.0+. |
| PECL mongodb 1.3.0 | Implements MongoDB\BSON\RegexInterface. |
| PECL mongodb 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
add a note
User Contributed Notes 2 notes
aws dot htc at gmail dot com ¶
8 years ago
Example
Find names that start with "Al"
$regex = new MongoDB\BSON\Regex ( '^Al');
$cursor = $collection->find(array('name' => $regex));
//iterate through the cursor
