Files
2024-10-08 07:21:32 -03:00

121 lines
3.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f5c124befdf7c2791877694a86ead123b179d935 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: surfmax,fernandoc,fernandowobeto,leonardolara -->
<refentry xml:id="function.session-id" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_id</refname>
<refpurpose>Obtém e/ou define o id de sessão atual</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> é usado para obter ou definir o id de sessão
para a sessão atual.
</para>
<para>
A constante <constant>SID</constant> também pode ser usada para
obter o nome e id da sessão atual como uma string adequado para
adicionar em URLs. Veja também <link linkend="ref.session">Manipulação
de Sessão</link>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
Se <parameter>id</parameter> for especificado e não &null;, ele substituirá o
id de sessão atual. <function>session_id</function> precisa ser chamado antes de
<function>session_start</function> para este fim. Dependendo do
manipulador de sessão, nem todos os caracteres são permitidos em um id de sessão.
Por exemplo, o manipulador de sessão em arquivo permite apenas caracteres no
intervalo <literal>[a-zA-Z0-9,-]</literal>!
</para>
<note>
<simpara>
Quando estiver usando cookies de sessão, especificar um <parameter>id</parameter>
para <function>session_id</function> sempre enviará um novo cookie
quando <function>session_start</function> for chamada, sem importar se o
id da sessão atual for idêntico ao que está sendo definido.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>session_id</function> retorna o id de sessão para a sessão
atual ou uma string vazia (<literal>""</literal>) se não houver sessão
atual (não existe um id de sessão atual).
Em caso de falha, &false; é retornado.
</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> é anulável agora.
</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
-->