Files
php-doc-ru/reference/mongodb/bson/regex/construct.xml
sergey 4899e53e49 new: mongodb bson
git-svn-id: https://svn.php.net/repository/phpdoc/ru/trunk@347457 c90b9560-bf6c-de11-be94-00142212c4b1
2019-05-21 09:48:39 +00:00

155 lines
4.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0f19fd56d91bf2324083913698dfeb01312fb15c Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<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>Создает новый 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>
Шаблон регулярного выражения.
</para>
<note>
<simpara>
Шаблон не должен быть заключен в символы-разделители.
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter> (<type>string</type>)</term>
<listitem>
<para>
<link xlink:href="&url.mongodb.docs.regex;#op._S_options">Флаги регулярных
выражений</link>. Символы в этом аргументе будут отсортированы в
алфавитном порядке.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
<member>Выдает <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>, если <parameter>pattern</parameter> или <parameter>flags</parameter> содержат нулевые байты.</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>
Аргумент <parameter>flags</parameter> является необязательным и по умолчанию
равен пустой строке.
</para>
<para>
Символы в аргументе <parameter>flags</parameter> будут отсортированы
в алфавитном порядке при построении регулярного выражения. Ранее символы
хранились в указанном порядке.
</para>
<para>
Выдается <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>,
если <parameter>pattern</parameter> или
<parameter>flags</parameter> содержат нулевые байты. Ранее значения
были бы обрезаны в первом нулевом байте.
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Пример использования <function>MongoDB\BSON\Regex::__construct</function></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</link></member>
<member><link xlink:href="&url.mongodb.docs.regex;#op._S_options">Поддерживаемые флаги регулярных выражений</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
-->