1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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="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>
</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>5.2.0</entry>
<entry>
The "httponly" entry was added in the returned array.
</entry>
</row>
<row>
<entry>4.0.4</entry>
<entry>
The "secure" 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><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
-->
|