mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 12:28:55 +00:00
0f19fd56d9
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343960 c90b9560-bf6c-de11-be94-00142212c4b1
152 lines
4 KiB
XML
152 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="mongodb-bson-regex.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoDB\BSON\Regex::__construct</refname>
|
|
<refpurpose>Construct a new Regex</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\Regex::__construct</methodname>
|
|
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>flags</parameter><initializer>""</initializer></methodparam>
|
|
</methodsynopsis>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>pattern</parameter> (<type>string</type>)</term>
|
|
<listitem>
|
|
<para>
|
|
The regular expression pattern.
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
The pattern should not be wrapped with delimiter characters.
|
|
</simpara>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter> (<type>string</type>)</term>
|
|
<listitem>
|
|
<para>
|
|
The <link xlink:href="&url.mongodb.docs.regex;#op._S_options">regular
|
|
expression flags</link>. Characters in this argument will be sorted
|
|
alphabetically.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<simplelist>
|
|
&mongodb.throws.argumentparsing;
|
|
<member>Throws <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> if <parameter>pattern</parameter> or <parameter>flags</parameter> contain null bytes.</member>
|
|
</simplelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>1.2.0</entry>
|
|
<entry>
|
|
<para>
|
|
The <parameter>flags</parameter> argument is optional and defaults to
|
|
an empty string.
|
|
</para>
|
|
<para>
|
|
Characters in the <parameter>flags</parameter> argument will be sorted
|
|
alphabetically when a Regex is constructed. Previously, the characters
|
|
were stored in the order provided.
|
|
</para>
|
|
<para>
|
|
<classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>
|
|
is thrown if <parameter>pattern</parameter> or
|
|
<parameter>flags</parameter> contain null bytes. Previously, values
|
|
would be truncated at the first null byte.
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>MongoDB\BSON\Regex::__construct</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$regex = new MongoDB\BSON\Regex('^foo', 'i');
|
|
var_dump($regex);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
object(MongoDB\BSON\Regex)#1 (2) {
|
|
["pattern"]=>
|
|
string(4) "^foo"
|
|
["flags"]=>
|
|
string(1) "i"
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
|
|
<member><link xlink:href="&url.mongodb.docs.regex;#op._S_options">Supported regular expression flags</link></member>
|
|
</simplelist>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|