archived-doc-ru/reference/session/functions/session-name.xml

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

<refentry xml:id="function.session-name" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_name</refname>
  <refpurpose>Получить или установить имя текущей сессии</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>session_name</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>session_name</function> возвращает имя текущей
   сессии. Если задан параметр <parameter>name</parameter>,
   <function>session_name</function> обновит имя сессии и вернёт
   <emphasis>старое</emphasis> имя сессии.
  </para>
  <para>
   Если новое имя сессии (<parameter>name</parameter>) предоставлено,
   <function>session_name</function> изменяет cookie HTTP
   (и выводит содержимое при включённой опции <literal>session.transid</literal>).
   Когда cookie HTTP отправлены, <function>session_name</function> вызывает ошибку.
   <function>session_name</function> необходимо вызывать до
   <function>session_start</function> для правильной работы сессии.
  </para>
  <para>
   Имя сессии сбрасываются на значение по умолчанию, хранящегося в
   <literal>session.name</literal> во время запуска запроса. Таким образом, вам нужно
   вызывать <function>session_name</function> для каждого запроса (и до
   <function>session_start</function>).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Имя сессии ссылается на имя сессии, которое
       используется в cookie и URL (например, <literal> PHPSESSID </literal>). Оно
       должно содержать только буквенно-цифровые символы, и должен быть коротким и
       понятными (например, для пользователей с включённым предупреждением cookie).
       Если задан параметр <parameter>name</parameter> и он не равен &null;, имя текущей
       сессии поменяется на него.
      </para>
      <para>
       <warning>
        <para>
         Имя сессии не может состоять только из цифр, по крайней мере, одна буква
         должна присутствовать. В противном случае каждый раз будет генерироваться новый
         идентификатор.
        </para>
       </warning>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает имя текущей сессии. Если задан параметр <parameter>name</parameter>, имя
   текущей сессии поменяется и будет возвращено <emphasis>старое</emphasis>&return.falseforfailure;.
  </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>module</parameter> теперь может быть &null;.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        <function>session_name</function> проверяет статус сессии,
        ранее она проверяла только статус cookie. Поэтому
        старая версия <function>session_name</function> позволяла
        вызывать <function>session_name</function>
        после <function>session_start</function>, что могло привести к сбою PHP
        и неправильному поведению.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>session_name</function></title>
    <programlisting role="php">
<![CDATA[
<?php

/* устанавливает имя сессии равным WebsiteID */

$previous_name = session_name("WebsiteID");

echo "Предыдущее имя сессии: $previous_name<br />";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>
     Параметр конфигурации <link linkend="ini.session.name">session.name</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
-->