session-id.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f5c124befdf7c2791877694a86ead123b179d935 Maintainer: samesch Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 151e61773c016edcae8fd4989ad9a86ffd03c283 Reviewer: samesch -->
<refentry xml:id="function.session-id" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_id</refname>
  <refpurpose>Liefert und/oder setzt die aktuelle 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> wird verwendet, um die Session-ID der
   aktuellen Session zu erhalten oder zu setzen.
  </para>
  <para>
   Die Konstante <constant>SID</constant> kann auch dazu verwendet werden, den
   aktuellen Namen und die Session-ID als Zeichenkette passend zum Anhängen an
   URLs zu erhalten. Siehe auch
   <link linkend="ref.session">Session-Funktionen</link>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>id</parameter></term>
      <listitem>
       <para>
        Wenn <parameter>id</parameter> angegeben wird und nicht &null; ist,
        wird die aktuelle Session-ID ersetzt. <function>session_id</function>
        muss zu diesem Zweck vor <function>session_start</function> aufgerufen
        werden. In Abhängigkeit von der Session-Routine sind in der Session-ID
        nicht alle Zeichen erlaubt. Zum Beispiel erlaubt die dateibasierte
        Session-Routine nur Zeichen im Bereich
        <literal>[a-zA-Z0-9,-]</literal>!
       </para>
       <note>
        <simpara>
         Falls Session-Cookies verwendet werden und für
         <function>session_id</function> eine <parameter>id</parameter>
         angegeben wird, wird ungeachtet dessen, ob die aktuelle Session-ID
         mit der neuen identisch ist, bei jedem Aufruf von
         <function>session_start</function> ein neues Cookie gesendet.
        </simpara>
       </note>
      </listitem>
     </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>session_id</function> gibt die Session-ID der aktuellen Session
   zurück oder die leere Zeichenkette (<literal>""</literal>), falls es keine
   aktuelle Session gibt (es existiert keine aktuelle Session-ID). Bei
   Auftreten eines Fehlers wird &false; zurückgegeben.
  </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> ist jetzt nullable (akzeptiert den
       NULL-Wert).
      </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
-->