session-name.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d7a77b5f850d5077f75d0c8c0d22cd60f099965d Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.session-name" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_name</refname>
  <refpurpose>Lit et/ou modifie le nom de la session</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> retourne le nom de la session
   courante. Si le paramètre <parameter>name</parameter> est fourni,
   <function>session_name</function> modifiera le nom de la session
   et retournera l'<emphasis>ancien</emphasis> nom de la session.
  </para>
  <para>
   Si un nouveau nom de session <parameter>name</parameter> est
   fourni, <function>session_name</function> modifie le cookie HTTP
   (et le contenue de sortie quand <link linkend="ini.session.use-trans-sid">session.transid</link> est
   activé). Une fois le cookie HTTP envoyé,
   appeler <function>session_name</function> déclenche un <constant>E_WARNING</constant>.
   <function>session_name</function> doit être appelé
   avant <function>session_start</function> pour que la session fonctionne
   correctement.
  </para>
  <para>
   Le nom de la session est réinitialisé à la valeur par défaut, stockée dans
   <literal>session.name</literal> lors du démarrage. Ainsi, vous devez
   appeler <function>session_name</function> pour chaque demande (et avant que
   <function>session_start</function> soit appelé).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Le nom de session est utilisé comme nom pour les cookies et les URLs
       (i.e. <literal>PHPSESSID</literal>). Il ne doit contenir que des caractères alphanumériques ;
       il doit être court et descriptif (surtout pour les utilisateurs
       ayant activé l'alerte cookie). Si <parameter>name</parameter> est fourni et non &null;,
       le nom de la session courante sera remplacé par cette valeur.
      </para>
      <para>
       <warning>
        <para>
         Les noms de session ne peuvent pas contenir uniquement des chiffres, au moins une lettre
         doit être présente. Sinon, un identifiant de session sera généré à chaque fois.
        </para>
       </warning>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne le nom de la session courante. Si le paramètre <parameter>name</parameter>
   est fourni et que la fonction met à jour le nom de la session, alors
   l'<emphasis>ancien</emphasis> nom de session sera retourné, &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> est désormais nullable.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        <function>session_name</function> vérifie l'état de la session,
        auparavant elle vérifiait uniquement l'état du cookie. Par conséquent,
        les versions plus anciennes de <function>session_name</function> autorise
        l'appel de <function>session_name</function>
        après <function>session_start</function> ce qui peut causer le plantage de PHP
        et peut donner lieu à des comportements étranges.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>session_name</function></title>
    <programlisting role="php">
<![CDATA[
<?php

/* choisi le nom de session  : WebsiteID */

$previous_name = session_name("WebsiteID");

echo "L'ancien nom de la session était $previous_name<br />";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>
     La directive de configuration <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
-->