Php/docs/mongodb-bson-regex.construct
MongoDB\BSON\Regex::__construct
(mongodb >=1.0.0)
MongoDB\BSON\Regex::__construct — Construct a new Regex
Description
final public MongoDB\BSON\Regex::__construct
( string $pattern
[, string $flags
= ""
] )
Parameters
pattern
(string)The regular expression pattern.
Note:
The pattern should not be wrapped with delimiter characters.
flags
(string)The [https://docs.mongodb.com/manual/reference/operator/query/regex/#op._S_options » regular expression flags]. Characters in this argument will be sorted alphabetically.
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
- Throws MongoDB\Driver\Exception\InvalidArgumentException if
pattern
orflags
contain null bytes.
Changelog
Version | Description |
---|---|
PECL mongodb 1.2.0 |
The Characters in the MongoDB\Driver\Exception\InvalidArgumentException
is thrown if |
Examples
Example #1 MongoDB\BSON\Regex::__construct() example
<?php$regex = new MongoDB\BSON\Regex('^foo', 'i');var_dump($regex);?>
The above example will output:
object(MongoDB\BSON\Regex)#1 (2) { ["pattern"]=> string(4) "^foo" ["flags"]=> string(1) "i" }