svn: /phpdoc/en/trunk/reference/session/functions/ session-start.xml

sixd Wed, 13 Jan 2010 17:48:21 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=293511 Log: Fix trans-sid link and tidy grammar Changed paths: U phpdoc/en/trunk/reference/session/functions/session-start.xml Modified: phpdoc/en/trunk/reference/session/functions/session-start.xml =================================================================== --- phpdoc/en/trunk/reference/session/functions/session-start.xml 2010-01-13 17:15:32 UTC (rev 293510) +++ phpdoc/en/trunk/reference/session/functions/session-start.xml 2010-01-13 17:48:21 UTC (rev 293511) @@ -14,28 +14,32 @@ </methodsynopsis> <para> <function>session_start</function> creates a session or resumes the - current one based on the current session id that's being passed via a - request, such as GET, POST, or a cookie. + current one based on a session identifier passed via a GET or POST + request, or passed via a cookie. </para> <para> - If you want to use a named session, you must call + To use a named session, call <function>session_name</function> before calling <function>session_start</function>. </para> <para> - <function>session_start</function> will register internal output handler - for URL rewriting when <literal>trans-sid</literal> is enabled. If a user - uses <literal>ob_gzhandler</literal> or like with - <function>ob_start</function>, the order of output handler is important - for proper output. For example, user must register - <literal>ob_gzhandler</literal> before session start. + When <link linkend="ini.session.use-trans-sid">session.use_trans_sid</link> + is enabled, the <function>session_start</function> function will + register an internal output handler for URL rewriting. </para> + <para> + If a user uses <literal>ob_gzhandler</literal> or similar with + <function>ob_start</function>, the function order is important for + proper output. For example, + <literal>ob_gzhandler</literal> must be registered before starting the session. + </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - This function returns &true; if session was started with success otherwise &false;. + This function returns &true; if a session was successfully started, + otherwise &false;. </para> </refsect1> @@ -54,17 +58,17 @@ <row> <entry>5.3.0</entry> <entry> - If session fails to start for some reason, then &false; is returned - where previously &true; always was returned. + If a session fails to start, then &false; is returned. + Previously &true; was returned. </entry> </row> <row> <entry>4.3.3</entry> <entry> - As of now, calling <function>session_start</function> while the - session has already been started will result in an error of level - <constant>E_NOTICE</constant>. Also, the second session start will - simply be ignored. + As of PHP 4.3.3, calling <function>session_start</function> + after the session was previously started will result in an + error of level <constant>E_NOTICE</constant>. Also, the + second session start will simply be ignored. </entry> </row> </tbody> @@ -138,22 +142,21 @@ &reftitle.notes; <note> <para> - If you are using cookie-based sessions, you must call - <function>session_start</function> before anything is outputted to the - browser. + To use cookie-based sessions, <function>session_start</function> + must be called before outputing anything to the browser. </para> </note> <note> <para> Use of <link linkend="ini.zlib.output-compression">zlib.output_compression</link> - is recommended rather than <function>ob_gzhandler</function> + is recommended instead of <function>ob_gzhandler</function> </para> </note> <note> <para> - This function will send out several HTTP headers depending on the - configuration. See <function>session_cache_limiter</function> to customize - these headers. + This function sends out several HTTP headers depending on the + configuration. See <function>session_cache_limiter</function> to + customize these headers. </para> </note> </refsect1>