CakeFest 2024: The Official CakePHP Conference

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

/* Methods */
final public __construct(string $pattern, string $flags = "")
final public getFlags(): string
final public getPattern(): string
final public jsonSerialize(): mixed
final public serialize(): string
final public __toString(): string
final public unserialize(string $data): void
}

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

add a note

User Contributed Notes 2 notes

up
-31
aws dot htc at gmail dot com
7 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
To Top