archived-doc-pt-br/reference/session/functions/session-start.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 151e61773c016edcae8fd4989ad9a86ffd03c283 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: surfmax,fernandoc,fernandowobeto -->
<refentry xml:id="function.session-start" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_start</refname>
  <refpurpose>Inicia uma nova sessão ou continua uma sessão existente</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>session_start</methodname>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>session_start</function> cria uma sessão ou continua a
   sessão atual baseado em um ID de sessão passado via GET ou POST,
   ou passado via cookie.
  </para>
  <para>
   Quando <function>session_start</function> é chamada ou quando uma sessão inicia automaticamente,
   o PHP chamará os manipuladores de gravação de sessão de abertura e de leitura.  Eles serão manipuladores de gravação internos
   fornecidos por padrão ou por extensões do PHP (como SQLite ou Memcached); ou podem ser
   manipuladores personalizados definidos por <function>session_set_save_handler</function>.
   A função de leitura recuperará qualquer informação de sessão existente (armazenada em um formato serializado especial)
   e será desserializado e usado para preencher automaticamente a variável super global $_SESSION quando a
   função de leitura retornar os dados de sessão gravados para o tratamento de sessão do PHP.
  </para>
  <para>
   Para utilizar uma sessão com nome,
   <function>session_name</function> deve ser chamada antes de
   <function>session_start</function>.
  </para>
  <para>
   Quando <link linkend="ini.session.use-trans-sid">session.use_trans_sid</link>
   está habilitada, a função <function>session_start</function>
   registrará um manipulador de saída interno para a reescrita da URL.
  </para>
  <para>
   Se um usuário usar <literal>ob_gzhandler</literal> ou similar com
   <function>ob_start</function>, a ordem da função é importante para
   saída/output adequado.  Por exemplo,
   <literal>ob_gzhandler</literal> deve ser registrado antes de iniciar a sessão.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      Se informado, este é um array associativo de opções que irão substituir
      os que estiverem configurados nas
      <link linkend="session.configuration">diretivas de configuração de sessão</link>.
      As chaves não devem incluir o prefixo <literal>session.</literal>.
     </para>
     <para>
      Além do conjunto de diretivas de configuração comum, a opção
      <literal>read_and_close</literal> pode ser informada. Se definida como
      &true;, fará com que a sessão seja fechada imediatamente depois de
      ser lida, evitando o bloqueio desnecessário caso os dados da sessão
      não sejam alterados.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Esta função retorna &true; se uma sessão foi iniciada com sucesso,
   caso contrário &false;.
  </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>7.1.0</entry>
       <entry>
        <function>session_start</function> agora retorna &false; e não mais
        inicializa <varname>$_SESSION</varname> quando este falha em iniciar a
        sessão.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <refsect2>
   <title>Um exemplo básico de sessão</title>

   <para>
    <example>
     <title><filename>page1.php</filename></title>
     <programlisting role="php">
<![CDATA[
<?php
// page1.php

session_start();

echo 'Bem vindo à página #1';

$_SESSION['favcolor'] = 'green';
$_SESSION['animal']   = 'cat';
$_SESSION['time']     = time();

// Funciona se o cookie de sessão foi aceito
echo '<br /><a href="page2.php">page 2</a>';

// Ou talvez passando o ID da sessão se necessário
echo '<br /><a href="page2.php?' . SID . '">page 2</a>';
?>
]]>
     </programlisting>
    </example>
   </para>
   <para>
    Após acessar <filename>page1.php</filename>, a segunda página
    <filename>page2.php</filename> magicamente terá os dados da
    sessão. Leia <link linkend="ref.session">funções para sessão</link>
    para informações sobre <link linkend="session.idpassing">propagação de
    IDs de sessão</link> já que, por exemplo, explica o que é a constante
    <constant>SID</constant>.
   </para>
   <para>
    <example>
     <title><filename>page2.php</filename></title>
     <programlisting role="php">
<![CDATA[
<?php
// page2.php

session_start();

echo 'Bem vindo à página #2<br />';

echo $_SESSION['favcolor']; // green
echo $_SESSION['animal'];   // cat
echo date('Y m d H:i:s', $_SESSION['time']);

// Pode ser desejado usar o SID aqui, como foi feito em page1.php
echo '<br /><a href="page1.php">page 1</a>';
?>
]]>
     </programlisting>
    </example>
   </para>
  </refsect2>
  <refsect2>
   <title>Fornecendo configurações para <function>session_start</function></title>

   <example>
    <title>Sobrepondo o tempo de duração de cookie</title>
    <programlisting role="php">
<![CDATA[
<?php
// Isto envia um cookie persistente que dura um dia
session_start([
    'cookie_lifetime' => 86400,
]);
?>
]]>
    </programlisting>
   </example>

   <example>
    <title>Lendo e fechando a sessão</title>
    <programlisting role="php">
<![CDATA[
<?php
// Se não houver necessidade de alterar nada na
// sessão, pode-se apenas lê-la e já fechá-la para evitar
// travar o arquivo de sessão e bloquear outras páginas
session_start([
    'cookie_lifetime' => 86400,
    'read_and_close'  => true,
]);
]]>
    </programlisting>
   </example>
  </refsect2>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Para usar sessões baseadas em cookies, <function>session_start</function>
    deve ser chamada antes de enviar qualquer saída para o browser.
   </para>
  </note>
  <note>
   <para>
    O uso de <link linkend="ini.zlib.output-compression">zlib.output_compression</link>
    é recomendado ao invés de <function>ob_gzhandler</function>
   </para>
  </note>
  <note>
   <para>
    Esta função envia vários cabeçalhos HTTP dependendo da
    configuração. Veja <function>session_cache_limiter</function> para
    personalizar estes cabeçalhos.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><varname>$_SESSION</varname></member>
    <member>
     <link linkend="ini.session.auto-start">session.auto_start</link>
     (diretiva de configuração)
    </member>
    <member><function>session_id</function></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
-->