odbc-connection-string-quote.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d8085016354e4c76913e9fcd3614bd82e9780202 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.odbc-connection-string-quote" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>odbc_connection_string_quote</refname>
  <refpurpose>Заключает в кавычки значение строки подключения</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>odbc_connection_string_quote</methodname>
   <methodparam><type>string</type><parameter>str</parameter></methodparam>
  </methodsynopsis>
  <para>
   Заключает в кавычки значение строки подключения в соответствии с правилами ODBC.
   То есть оно будет окружено кавычками, а все завершающие фигурные скобки будут экранированы.
   Это необходимо делать для всех значений строки подключения,
   которые поступают от пользователя. Невыполнение этого требования может привести
   к проблемам с разбором строки подключения или к инъекции значений в строку подключения.
  </para>
  <para>
   Обратите внимание, что данная функция не проверяет,
   не заключена ли уже строка в кавычки и не нуждается ли она в кавычках.
   Для этого следует использовать функцию <function>odbc_connection_string_is_quoted</function>
   и <function>odbc_connection_string_should_quote</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>str</parameter></term>
    <listitem>
     <para>
      Строка, не заключённая в кавычки.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает строку, заключённую в кавычки,
   окружённую фигурными скобками и правильно экранированную.
  </para>
 </refsect1>

 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <example xml:id="odbc-connection-string-quote.example.basic"><!-- {{{ -->
   <title>Пример использования <function>odbc_connection_string_quote</function></title>
   <para>
    В этом примере строка заключается в кавычки, а затем помещается в строку соединения.
    Обратите внимание, что строка заключена в кавычки,
    а символ окончания кавычек в середине строки был экранирован.
   </para>
   <programlisting role="php">
<![CDATA[
<?php
$value = odbc_connection_string_quote("foo}bar");
$connection_string = "DSN=PHP;UserValue=$value";
echo $connection_string;
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
DSN=PHP;UserValue={foo}}bar}
]]>
   </screen>
  </example><!-- }}} -->
 </refsect1><!-- }}} -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>odbc_connection_string_is_quoted</function></member>
    <member><function>odbc_connection_string_should_quote</function></member>
   </simplelist>
  </para>
 </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
-->