session-get-cookie-params.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-get-cookie-params">
 <refnamediv>
  <refname>session_get_cookie_params</refname>
  <refpurpose>Get the session cookie parameters</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>session_get_cookie_params</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Gets the session cookie parameters.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array with the current session cookie information, the array
   contains the following items:
   <itemizedlist>
    <listitem>
     <simpara>
      <link linkend="ini.session.cookie-lifetime">"lifetime"</link> -  The
      lifetime of the cookie in seconds.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <link linkend="ini.session.cookie-path">"path"</link> -  The path where
      information is stored.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <link linkend="ini.session.cookie-domain">"domain"</link> -  The domain
      of the cookie.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <link linkend="ini.session.cookie-secure">"secure"</link> -  The cookie
      should only be sent over secure connections.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <link linkend="ini.session.cookie-httponly">"httponly"</link> - The
      cookie can only be accessed through the HTTP protocol.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <link linkend="ini.session.cookie-samesite">"samesite"</link> - Controls
      the cross-domain sending of the cookie.
     </simpara>
    </listitem>
   </itemizedlist>
  </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.3.0</entry>
       <entry>
        The "samesite" entry was added in the returned array.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>
     <link linkend="ini.session.cookie-lifetime">session.cookie_lifetime</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-path">session.cookie_path</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-domain">session.cookie_domain</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-secure">session.cookie_secure</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-httponly">session.cookie_httponly</link>
    </member>
    <member>
     <link linkend="ini.session.cookie-samesite">session.cookie_samesite</link>
    </member>
    <member>
     <function>session_set_cookie_params</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
-->