Home/ Manual/ bson / regex/ MongoDB\BSON\Regex::__construct

MongoDB\BSON\Regex::__construct

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Construct a new Regex

Description

MongoDB\BSON\Regex::__construct(string $pattern, string $flags = "")

pattern (string): The regular expression pattern.
Note
The pattern should not be wrapped with delimiter characters.
flags (string): The regular expression flags. Characters in this argument will be sorted alphabetically.

Throws MongoDB\Driver\Exception\InvalidArgumentException if pattern or flags contain null bytes.

Version	Description
PECL mongodb 1.2.0	The `flags` argument is optional and defaults to an empty string.Characters in the `flags` argument will be sorted alphabetically when a Regex is constructed. Previously, the characters were stored in the order provided.`MongoDB\Driver\Exception\InvalidArgumentException` is thrown if `pattern` or `flags` contain null bytes. Previously, values would be truncated at the first null byte.

php

<?php

$regex = new MongoDB\BSON\Regex('^foo', 'i');
var_dump($regex);

?>

The above example will output:

output

object(MongoDB\BSON\Regex)#1 (2) {
  ["pattern"]=>
  string(4) "^foo"
  ["flags"]=>
  string(1) "i"
}