archived-doc-ru/reference/strings/functions/addcslashes.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2bcb7a986d47e06c1a37474a8b3634367c907043 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.addcslashes" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>addcslashes</refname>
  <refpurpose>Экранирует строку слешами в стиле языка C</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>addcslashes</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>string</type><parameter>characters</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция возвращает строку, которую заэкранировала обратными слешами перед символами,
   которые указали в параметре <parameter>characters</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Строка, которую требуется заэкранировать.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>characters</parameter></term>
     <listitem>
      <para>
       Список экранируемых символов.
       Если параметр <parameter>characters</parameter> содержит символы
       <literal>\n</literal>, <literal>\r</literal> и т. п., функция преобразует их
       в стиле языка C, тогда как другие нецифробуквенные
       символы с ASCII-кодами ниже 32 и выше 126 функция преобразует
       в восьмеричное представление.
      </para>
      <para>
       При определении последовательности символов в аргументе <parameter>characters</parameter>
       убедитесь, что знаете, какие символы находятся между символами, которые установили
       как начало и конец диапазона.
       <informalexample>
        <programlisting role="php">
<![CDATA[
<?php

echo addcslashes('foo[ ]', 'A..z');
// Выводит:  \f\o\o\[ \]

// Функция заэкранирует заглавные и строчные английские буквы
// ... а также [\]^_`

?>
]]>
        </programlisting>
       </informalexample>
       Функция не создаст диапазон, если ASCII-код первого символа диапазона больше
       последнего. Вместо этого функция заэкранирует только первый символ, последний символ
       и точку. Значение ASCII-кода символов находят функцией
       <function>ord</function>.
       <informalexample>
        <programlisting role="php">
<![CDATA[
<?php

echo addcslashes("zoo['.']", 'z..A'); // Выводит:  \zoo['\.']

?>
]]>
        </programlisting>
       </informalexample>
      </para>
      <para>
       При экранировании символов 0, a, b, f, n, r, t и v соблюдают осторожность.
       Функция преобразовывает символы в последовательности \0, \a, \b, \f, \n, \r, \t и \v —
       предопределённые escape-последовательности в языке Си. Многие из этих
       последовательностей также определяют другие Си-подобные языки, включая PHP,
       то есть иногда выдётся неожиданный результат, если использовать
       вывод функции <function>addcslashes</function>, чтобы создать код в этих языках
       с этими символами в аргументе <parameter>characters</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает заэкранированную строку.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
    Символы наподобие "\0..\37" в параметре <parameter>characters</parameter>
    заэкранируют каждый символ с ASCII-кодами от 0 до 31.
   <example>
    <title>Пример использования функции <function>addcslashes</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$escaped = addcslashes($not_escaped, "\0..\37!@\177..\377");

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>stripcslashes</function></member>
    <member><function>stripslashes</function></member>
    <member><function>addslashes</function></member>
    <member><function>htmlspecialchars</function></member>
    <member><function>quotemeta</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
-->