output-add-rewrite-var.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ba4d305a78a5a09589424a4ceb84182334c247c2 Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.output-add-rewrite-var">
 <refnamediv>
  <refname>output_add_rewrite_var</refname>
  <refpurpose>Добавляет значения в обработчик перезаписи URL-адресов</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>output_add_rewrite_var</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>string</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция запускает обработчик буфера вывода <literal>'URL-Rewriter'</literal>,
   если он не активен,
   сохраняет значения параметров <parameter>name</parameter> и <parameter>value</parameter>,
   и когда буфер сбрасывается, перезаписывает <acronym>URL</acronym>-адреса
   и формы на основе пригодных ini-настроек.
   Очередные вызовы функции будут сохранять каждую дополнительную
   пару из имени и значения до тех пор, пока обработчик не отключится.
  </para>
  <para>
   Когда буфер вывода сбрасывается
   (вызовом функций <function>ob_flush</function>, <function>ob_end_flush</function>,
   <function>ob_get_flush</function> или в конце работы скрипта),
   обработчик <literal>'URL-Rewriter'</literal> добавляет в атрибуты HTML-тегов пары из имени и значения
   как параметры запроса для <acronym>URL</acronym>-адресов
   и скрытые поля на основе значений директив конфигурации
   <link linkend="ini.url-rewriter.tags">url_rewriter.tags</link>
   и <link linkend="ini.url-rewriter.hosts">url_rewriter.hosts</link> в формы.
  </para>
  <para>
   Каждая пара имени и значения, которую добавили в обработчик <literal>'URL-Rewriter'</literal>,
   добавится в <acronym>URL</acronym>-адреса и (или) формы,
   даже если это задублирует <acronym>URL</acronym>-параметры запроса
   или элементы с одинаковыми названиями атрибутов.
  </para>
  <note>
   <simpara>
    После отключения обработчика <literal>'URL-Rewriter'</literal> его невозможно
    запустить снова.
   </simpara>
  </note>
  <warning>
   <simpara>
    До PHP 8.4.0 хосты для перезаписи задавали через директиву
    <link linkend="ini.session.trans-sid-hosts">session.trans_sid_hosts</link>,
    а не <link linkend="ini.url-rewriter.hosts">url_rewriter.hosts</link>.
   </simpara>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Имя параметра.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Значение параметра.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.1.0</entry>
       <entry>
        Начиная с PHP 7.1.0 функция работает с выделенным буфером вывода,
        директива <link linkend="ini.url-rewriter.tags">url_rewriter.tags</link>
        учитывается только при работе с функциями вывода,
        а директива <link linkend="ini.url-rewriter.tags">url_rewriter.hosts</link> доступна.
        До PHP 7.1.0 переменные перезаписи, которые установили функцией <function>output_add_rewrite_var</function>,
        работали с общим буфером вывода с поддержкой прозрачного идентификатора сессии.
        Смотрите описание директивы <link linkend="ini.session.trans-sid-tags">session.trans_sid_tags</link>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример добавления значения в обработчик перезаписи URL-адресов функцией <function>output_add_rewrite_var</function></title>
    <programlisting role="php">
<![CDATA[
<?php

ini_set('url_rewriter.tags', 'a=href,form=');

output_add_rewrite_var('var', 'value');

// несколько ссылок
echo '<a href="file.php">ссылка</a>
<a href="http://example.com">ссылка2</a>';

// форма
echo '<form action="script.php" method="post">
<input type="text" name="var2" />
</form>';

print_r(ob_list_handlers());

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
<a href="file.php?var=value">ссылка</a>
<a href="http://example.com">ссылка2</a>

<form action="script.php" method="post">
<input type="hidden" name="var" value="value" />
<input type="text" name="var2" />
</form>

Array
(
    [0] => URL-Rewriter
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>output_reset_rewrite_vars</function></member>
    <member><function>ob_flush</function></member>
    <member><function>ob_list_handlers</function></member>
    <member><link linkend="ini.url-rewriter.tags">url_rewriter.tags</link></member>
    <member><link linkend="ini.url-rewriter.hosts">url_rewriter.hosts</link></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
-->