The MongoDB\BSON\Regex class

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.

MongoDB\BSON\Regex

final class MongoDB\BSON\Regex implements MongoDB\BSON\RegexInterface, MongoDB\BSON\Type, Serializable, JsonSerializable, Stringable {

/* Methods */

final public __construct(string $pattern, string $flags = "")

final public string getFlags()

final public string getPattern()

final public mixed jsonSerialize()

final public string serialize()

final public string __toString()

final public void unserialize(string $data)

}

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