php8.5
/
Download
Home/ Manual/ mongodb / bson/ The MongoDB\BSON\Regex class

The MongoDB\BSON\Regex class

Guide Edit on GitHub ✎

BSON type for a regular expression pattern and optional flags.

Intro

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

class MongoDB\BSON\Regex { }

Changelog

VersionDescription
PECL mongodb 1.12.0Implements Stringable for PHP 8.0+.
PECL mongodb 1.3.0Implements MongoDB\BSON\RegexInterface.
PECL mongodb 1.2.0Implements Serializable and JsonSerializable.

Regex

In this section

MongoDB\BSON\Regex::__construct

Construct a new Regex

MongoDB\BSON\Regex::__toString

Returns the string representation of this 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

Source: reference/mongodb/bson/regex.xml · from the official PHP manual (php/doc-en)