cvs: peardoc /en/package/html/html-quickform-controller intro.xml /en/package/html/html-quickform-controller/html-quickform-controller container.xml

avb Wed Apr 5 15:35:42 2006 UTC Modified files: /peardoc/en/package/html/html-quickform-controller intro.xml /peardoc/en/package/html/html-quickform-controller/html-quickform-controller container.xml Log: Documented the need to start the session manually, per bug #4331 http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform-controller/intro.xml?r1=1.3&r2=1.4&diff_format=u Index: peardoc/en/package/html/html-quickform-controller/intro.xml diff -u peardoc/en/package/html/html-quickform-controller/intro.xml:1.3 peardoc/en/package/html/html-quickform-controller/intro.xml:1.4 --- peardoc/en/package/html/html-quickform-controller/intro.xml:1.3 Thu Nov 4 12:55:43 2004 +++ peardoc/en/package/html/html-quickform-controller/intro.xml Wed Apr 5 15:35:41 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="package.html.html-quickform-controller.intro"> <refnamediv> <refname>Introduction</refname> @@ -58,6 +58,16 @@ </refsect1> <refsect1 id="package.html.html-quickform-controller.intro.example"> <title>Basic usage example</title> + <note> + <title>Session initialization</title> + <para> + This simple example does not use sessions since there is no need to pass data between pages. + You&apos;ll need to use sessions when dealing with a real multipage form, though. <classname>HTML_QuickForm_Controller</classname> + <emphasis>does not</emphasis> start a session automatically, you should explicitly call + <ulink url="&url.php.lookup;session_start"><function>session_start</function></ulink> before instantiating + the controller class. + </para> + </note> <para> To ease understanding of this package's features, lets take an example form from <link linkend="package.html.html-quickform.tutorial.firstform">HTML_QuickForm tutorial</link> and http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml?r1=1.3&r2=1.4&diff_format=u Index: peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml diff -u peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml:1.3 peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml:1.4 --- peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml:1.3 Fri Oct 24 13:35:20 2003 +++ peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml Wed Apr 5 15:35:42 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="package.html.html-quickform-controller.html-quickform-controller.container"> <refnamediv> <refname>Controller::container()</refname> @@ -18,6 +18,14 @@ <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.container.desc"> &title.desc; + <note> + <title>Session initialization</title> + <para> + The package does store the data in session, but it <emphasis>does not</emphasis> start the + session automatically. You must call <ulink url="&url.php.lookup;session_start"><function>session_start</function></ulink> + function yourself before instantiating <classname>HTML_QuickForm_Controller</classname>. + </para> + </note> <para> Returns a reference to a session variable containing the form-page values and pages&apos; validation status. This is a &quot;low-level&quot; method, use <link linkend="package.html.html-quickform-controller.html-quickform-controller.exportvalues"><function>exportValues</function></link> if you want just to get the form&apos;s values.