cvs: phpdoc /en/functions session.xml

yohgaki Mon Jan 28 03:22:01 2002 EDT Modified files: /phpdoc/en/functions session.xml Log: Added <varname> for PHP variables Index: phpdoc/en/functions/session.xml diff -u phpdoc/en/functions/session.xml:1.78 phpdoc/en/functions/session.xml:1.79 --- phpdoc/en/functions/session.xml:1.78 Mon Jan 28 02:15:49 2002 +++ phpdoc/en/functions/session.xml Mon Jan 28 03:21:59 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.78 $ --> +<!-- $Revision: 1.79 $ --> <reference id="ref.session"> <title>Session handling functions</title> <titleabbrev>Sessions</titleabbrev> @@ -54,10 +54,13 @@ </note> <note> <para> - As of PHP 4.1.0, $_SESSION is available as global variable just - like $_POST, $_GET, $_REQUEST and so on. Not like - $HTTP_SESSION_VARS, $_SESSION is always global. Therefore, - <literal>global</literal> should not be used for $_SESSION. + As of PHP 4.1.0, <varname>$_SESSION</varname> is available as + global variable just like <varname>$_POST</varname>, + <varname>$_GET</varname>, <varname>$_REQUEST</varname> and so on. + Not like <varname>$HTTP_SESSION_VARS</varname>, + <varname>$_SESSION</varname> is always global. Therefore, + <literal>global</literal> should not be used for + <varname>$_SESSION</varname>. </para> </note> @@ -67,9 +70,9 @@ enabled and <link linkend="ini.register-globals"><literal>register_globals</literal></link> is disabled, only members of the global associative array - $HTTP_SESSION_VARS can be registered as session variables. The - restored session variables will only be available in the array - $HTTP_SESSION_VARS. + <varname>$HTTP_SESSION_VARS</varname> can be registered as session + variables. The restored session variables will only be available + in the array <varname>$HTTP_SESSION_VARS</varname>. <example> <title> Registering a variable with <link @@ -91,12 +94,14 @@ </example> </para> <para> - Use of $_SESSION (or $HTTP_SESSION_VARS with PHP 4.0.6 or less) is - recommended for security and code readablity. With $_SESSION or - $HTTP_SESSION_VARS, there is no need to use + Use of <varname>$_SESSION</varname> (or + <varname>$HTTP_SESSION_VARS</varname> with PHP 4.0.6 or less) is + recommended for security and code readablity. With + <varname>$_SESSION</varname> or + <varname>$HTTP_SESSION_VARS</varname>, there is no need to use session_register()/session_unregister()/session_is_registered() functions. Users can access session variable like a normal - variable. + variable. <example> <title> Registering a variable with $_SESSION. @@ -137,12 +142,13 @@ corresponding global variables. Since PHP must know which global variables are registered as session variables, users must register variables with session_register() function while - $HTTP_SESSION_VARS/$_SESSION does not need to use - session_register(). + <varname>$HTTP_SESSION_VARS</varname>/<varname>$_SESSION</varname> + does not need to use session_register(). <caution> <para> - If you are using $HTTP_SESSION_VARS/$_SESSION, do not use - <function>session_register</function>, + If you are using + <varname>$HTTP_SESSION_VARS</varname>/<varname>$_SESSION</varname>, + do not use <function>session_register</function>, <function>session_is_registered</function> and <function>session_unregister</function> unless you know internal of session module. @@ -175,13 +181,15 @@ <link linkend="ini.register-globals"><literal>register_globals</literal></link> are enabled, then the globals variables and the - $HTTP_SESSION_VARS/$_SESSION entries will reference the same value - for already registered variables. + <varname>$HTTP_SESSION_VARS</varname>/<varname>$_SESSION</varname> + entries will reference the same value for already registered + variables. </para> <para> If user use session_register() to register session variable, - $HTTP_SESSION_VARS/$_SESSION will not have these variable in array - until it is loaded from session storage. (i.e. until next request) + <varname>$HTTP_SESSION_VARS</varname>/<varname>$_SESSION</varname> + will not have these variable in array until it is loaded from + session storage. (i.e. until next request) </para> <para> There are two methods to propagate a session id: @@ -704,8 +712,9 @@ </caution> <caution> <para> - If you are using $HTTP_SESSION_VARS/$_SESSION, do not use - <function>session_register</function>, + If you are using + <varname>$HTTP_SESSION_VARS</varname>/<varname>$_SESSION</varname>, + do not use <function>session_register</function>, <function>session_is_registered</function> and <function>session_unregister</function>. </para> @@ -720,8 +729,9 @@ parameters will be made. </para> <para> - You can also create a session variable by simply setting the appropriate - member of the $HTTP_SESSION_VARS or $_SESSION (PHP >= 4.1.0) array. + You can also create a session variable by simply setting the + appropriate member of the <varname>$HTTP_SESSION_VARS</varname> + or <varname>$_SESSION</varname> (PHP >= 4.1.0) array. <informalexample> <programlisting role="php"> <![CDATA[ @@ -749,9 +759,10 @@ <link linkend="resource">resource types</link> appendix. </para> <para> - If $_SESSION (or $HTTP_SESSION_VARS for PHP 4.0.6 or less) is - used, assign variable to $_SESSION. i.e. $_SESSION['var'] = - 'ABC'; + If <varname>$_SESSION</varname> (or + <varname>$HTTP_SESSION_VARS</varname> for PHP 4.0.6 or less) is + used, assign variable to + <varname>$_SESSION</varname>. i.e. $_SESSION['var'] = 'ABC'; </para> </note> <para> @@ -787,7 +798,8 @@ </para> <note> <para> - If $_SESSION (or $HTTP_SESSION_VARS for PHP 4.0.6 or less) is + If <varname>$_SESSION</varname> (or + <varname>$HTTP_SESSION_VARS</varname> for PHP 4.0.6 or less) is used, use <function>unset</function> to unregister a session variable. </para> @@ -802,8 +814,9 @@ </caution> <caution> <para> - If you are using $HTTP_SESSION_VARS/$_SESSION, do not use - <function>session_register</function>, + If you are using + <varname>$HTTP_SESSION_VARS</varname>/<varname>$_SESSION</varname>, + do not use <function>session_register</function>, <function>session_is_registered</function> and <function>session_unregister</function>. </para> @@ -832,7 +845,8 @@ </para> <note> <para> - If $_SESSION (or $HTTP_SESSION_VARS for PHP 4.0.6 or less) is + If <varname>$_SESSION</varname> (or + <varname>$HTTP_SESSION_VARS</varname> for PHP 4.0.6 or less) is used, use <function>unset</function> to unregister session variable. i.e. unset($_SESSION); </para> @@ -862,15 +876,17 @@ </para> <note> <para> - If $_SESSION (or $HTTP_SESSION_VARS for PHP 4.0.6 or less) is + If <varname>$_SESSION</varname> (or + <varname>$HTTP_SESSION_VARS</varname> for PHP 4.0.6 or less) is used, use <function>isset</function> to check a variable is - registered in $_SESSION. + registered in <varname>$_SESSION</varname>. </para> </note> <caution> <para> - If you are using $HTTP_SESSION_VARS/$_SESSION, do not use - <function>session_register</function>, + If you are using + <varname>$HTTP_SESSION_VARS</varname>/<varname>$_SESSION</varname>, + do not use <function>session_register</function>, <function>session_is_registered</function> and <function>session_unregister</function>. </para>