php-doc-en/reference/session/functions/session-id.xml
2002-05-30 11:59:16 +00:00

59 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/session.xml, last change in rev 1.2 -->
<refentry id="function.session-id">
<refnamediv>
<refname>session_id</refname>
<refpurpose>Get and/or set the current session id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>session_id</methodname>
<methodparam choice="opt"><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
<function>session_id</function> returns the session id for the
current session.
</para>
<para>
If <parameter>id</parameter> is specified, 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 and 0-9</literal>!
</para>
<para>
The constant <systemitem>SID</systemitem> can also be used to
retrieve the current name and session id as a string suitable for
adding to URLs. Note that <systemitem>SID</systemitem> is only defined if
the client didn't sent the right cookie. See also <link
linkend="ref.session">Session handling</link>.
</para>
<para>
See also <function>session_start</function>.
</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:"../../../../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
-->