<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: d7a77b5f850d5077f75d0c8c0d22cd60f099965d 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>

Функция <function>session_name</function> изменяет название сессии в блоке данных cookie HTTP-протокола,

а при включённой директиве <link linkend="ini.session.use-trans-sid">session.use_trans_sid</link> —

в содержимом вывода, если для сессии указали новое имя <parameter>name</parameter>.

Функция <function>session_name</function> выдаёт ошибку уровня <constant>E_WARNING</constant>,

если функцию вызвали после отправки cookie HTTP-протокола. Функцию

<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>

Название сессии нельзя составлять только из цифр, в имени требуется указать хотя бы

одну букву. При нарушении требования PHP каждый раз будет генерировать новый

идентификатор.

</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>name</parameter> теперь принимает значение &null;.

</entry>

</row>

<row>

<entry>7.2.0</entry>

<entry>

Функция <function>session_name</function> проверяет статус сессии,

раньше функция проверяла только статус cookie. Поэтому

старую версию функции <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}'";

?>

]]>

</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

-->