Php/docs/mongodb-bson-regex.getpattern

• PHP Manual
• MongoDB\BSON\Regex
• Returns the Regex's pattern

MongoDB\BSON\Regex::getPattern

(mongodb >=1.0.0)

MongoDB\BSON\Regex::getPattern — Returns the Regex's pattern

説明

final public MongoDB\BSON\Regex::getPattern ( ) : string

パラメータ

この関数にはパラメータはありません。

返り値

Returns the Regex's pattern.

エラー / 例外

• 引数のパースに失敗した場合に MongoDB\Driver\Exception\InvalidArgumentException をスローします。

例

例1 MongoDB\BSON\Regex::getPattern() example

<?php$regex = new MongoDB\BSON\Regex('regex', 'i');var_dump($regex->getPattern());?>

上の例の出力は、 たとえば以下のようになります。

string(5) "regex"

参考

• » BSON Types