mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-22 20:08:55 +00:00
151e61773c
Closes GH-236. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351750 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
3.6 KiB
XML
120 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.session-id" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>session_id</refname>
|
|
<refpurpose>Get and/or set the current session id</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>session_id</methodname>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>id</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>session_id</function> is used to get or set the session id for
|
|
the current session.
|
|
</para>
|
|
<para>
|
|
The constant <constant>SID</constant> can also be used to
|
|
retrieve the current name and session id as a string suitable for
|
|
adding to URLs. See also <link linkend="ref.session">Session
|
|
handling</link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>id</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>id</parameter> is specified and not &null;, it will replace the current
|
|
session id. <function>session_id</function> needs to be called before
|
|
<function>session_start</function> for that purpose. Depending on the
|
|
session handler, not all characters are allowed within the session id.
|
|
For example, the file session handler only allows characters in the
|
|
range <literal>a-z A-Z 0-9 , (comma) and - (minus)</literal>!
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
When using session cookies, specifying an <parameter>id</parameter>
|
|
for <function>session_id</function> will always send a new cookie
|
|
when <function>session_start</function> is called, regardless if the
|
|
current session id is identical to the one being set.
|
|
</simpara>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<function>session_id</function> returns the session id for the current
|
|
session or the empty string (<literal>""</literal>) if there is no current
|
|
session (no current session id exists).
|
|
On failure, &false; is returned.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
<parameter>id</parameter> is nullable now.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>session_regenerate_id</function></member>
|
|
<member><function>session_start</function></member>
|
|
<member><function>session_set_save_handler</function></member>
|
|
<member>
|
|
<link linkend="ini.session.save-handler">session.save_handler</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
|
|
-->
|