php-doc-en/reference/session/sessionupdatetimestamphandlerinterface/validateid.xml

64 lines
1.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="sessionupdatetimestamphandlerinterface.validateid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SessionUpdateTimestampHandlerInterface::validateId</refname>
<refpurpose>Validate ID</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SessionUpdateTimestampHandlerInterface::validateId</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
Validates a given session ID. A session ID is valid, if a session with that ID already exists.
This function is automatically executed when a session is to be started, a session ID is supplied
and <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link> is enabled.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
The session ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; for valid ID, &false; otherwise.
Note that this value is returned internally to PHP for processing.
</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
-->