session-set-cookie-params.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 37be0e0626e8b96e617e800392651eacc5f65bdc Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.session-set-cookie-params" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_set_cookie_params</refname>
  <refpurpose>Устанавливает параметры cookie для сессии</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>session_set_cookie_params</methodname>
   <methodparam><type>int</type><parameter>lifetime_or_options</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>path</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>domain</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>secure</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>httponly</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>Альтернативная сигнатура появилась в PHP 7.3.0:</para>
  <methodsynopsis>
   <type>bool</type><methodname>session_set_cookie_params</methodname>
   <methodparam><type>array</type><parameter>lifetime_or_options</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis role="procedural">
   <type>bool</type><methodname>session_set_cookie_params</methodname>
   <methodparam><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция устанавливает параметры cookie, которые определили в файле &php.ini;. Эффект этой
   функции длится только пока работает скрипт. Поэтому функцию
   <function>session_set_cookie_params</function> требуется вызывать для каждого запроса и перед каждым
   вызовом функции <function>session_start</function>.
  </para>
  <para>
   Функция обновляет ini-значения времени выполнения, которые соответствуют ini-ключам PHP-конфигурации,
   которые возвращает функция <function>ini_get</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>lifetime_or_options</parameter></term>
     <listitem>
      <para>
       Первая сигнатура: <link linkend="ini.session.cookie-lifetime">время жизни</link>
       сеансового блока данных cookie в секундах.
      </para>
      <para>
       Вторая сигнатура: ассоциативный массив (<type>array</type>) с произвольным набором ключей из следующего списка:
       <literal>lifetime</literal>, <literal>path</literal>, <literal>domain</literal>,
       <literal>secure</literal>, <literal>httponly</literal> и <literal>samesite</literal>.
       Значения несут тот же смысл, который описали в параметрах с тем же именем.
       Элемент <literal>samesite</literal> принимает либо значение <literal>Lax</literal>, либо значение <literal>Strict</literal>.
       Значения разрешённых опций, которые не указали, по умолчанию
       совпадают со значениями по умолчанию явных параметров.
       Функция не устанавливает cookie-атрибут SameSite,
       если элемент <literal>samesite</literal> не указали.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       <link linkend="ini.session.cookie-path">Путь</link> в домене,
       для которого cookie будет работать. Для всех путей в домене
       указывают одинарный слеш: «/».
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>domain</parameter></term>
     <listitem>
      <para>
       <link linkend="ini.session.cookie-domain">Домен</link> cookie, например
       «www.php.net». Чтобы каждый поддомен видел cookies,
       перед именем домена требуется поставить точку, например «.php.net».
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>secure</parameter></term>
     <listitem>
      <para>
       Функция будет передавать блоки данных cookies только
       по <link linkend="ini.session.cookie-secure">защищённым</link> соединениям,
       если для параметра установили значение &true;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>httponly</parameter></term>
     <listitem>
      <para>
       PHP попытается отправить флаг <link linkend="ini.session.cookie-httponly">httponly</link>
       при установке сессионного блока данных cookie,
       если для параметра установили значение &true;.
      </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>8.0.0</entry>
       <entry>
        Параметры <parameter>path</parameter>, <parameter>domain</parameter>,
        <parameter>secure</parameter> и <parameter>httponly</parameter> теперь принимают значение &null;.
       </entry>
      </row>
      <row>
       <entry>7.3.0</entry>
       <entry>
        Добавили альтернативную сигнатуру, которая поддерживает массив опций <parameter>lifetime_or_options</parameter>.
        Эта сигнатура поддерживает также установку cookie-атрибута SameSite.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        &return.success; Раньше функция возвращала тип <type>void</type>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>
     <link linkend="ini.session.cookie-lifetime">session.cookie_lifetime</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-path">session.cookie_path</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-domain">session.cookie_domain</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-secure">session.cookie_secure</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-httponly">session.cookie_httponly</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-samesite">session.cookie_samesite</link>
    </member>
    <member><function>session_get_cookie_params</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
-->