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

avb Fri Sep 19 11:15:09 2003 EDT Added files: /peardoc/en/package/html/html-quickform-controller/html-quickform-controller exportvalue.xml Modified files: /peardoc/en/package/html html-quickform-controller.xml /peardoc/en/package/html/html-quickform-controller/html-quickform-controller container.xml exportvalues.xml Log: Updated HTML_QuickForm_Controller docs for release 0.9.1

Index: peardoc/en/package/html/html-quickform-controller.xml diff -u peardoc/en/package/html/html-quickform-controller.xml:1.1 peardoc/en/package/html/html-quickform-controller.xml:1.2 --- peardoc/en/package/html/html-quickform-controller.xml:1.1 Thu Sep 4 17:03:47 2003 +++ peardoc/en/package/html/html-quickform-controller.xml Fri Sep 19 11:15:07 2003 @@ -46,6 +46,7 @@ &package.html.html-quickform-controller.html-quickform-controller.addpage; &package.html.html-quickform-controller.html-quickform-controller.applydefaults; &package.html.html-quickform-controller.html-quickform-controller.container; +&package.html.html-quickform-controller.html-quickform-controller.exportvalue; &package.html.html-quickform-controller.html-quickform-controller.exportvalues; &package.html.html-quickform-controller.html-quickform-controller.findinvalid; &package.html.html-quickform-controller.html-quickform-controller.getactionname; 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.1 peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml:1.2 --- peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml:1.1 Thu Sep 4 17:03:51 2003 +++ peardoc/en/package/html/html-quickform-controller/html-quickform-controller/container.xml Fri Sep 19 11:15:09 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.html.html-quickform-controller.html-quickform-controller.container"> <refnamediv> <refname>Controller::container()</refname> @@ -10,8 +10,8 @@ require_once &apos;HTML/QuickForm/Controller.php&apos;; </funcsynopsisinfo> <funcprototype> - <funcdef>array&amp; <function>HTML_QuickForm_Controller::container</function></funcdef> -<paramdef></paramdef> + <funcdef>array &amp;<function>HTML_QuickForm_Controller::container</function></funcdef> + <paramdef>bool <parameter> <optional>$reset = &false;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -20,7 +20,7 @@ &title.desc; <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">exportValues</link> if you want just to get the form&apos;s values. + 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. </para> <para> The structure of the container is the following @@ -45,6 +45,26 @@ </para> </refsect1> + <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.container.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + + + &type.bool; + <parameter>$reset</parameter> + </term> + <listitem> + <para> + If true, then reset the container: clear all default, constant and submitted values + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.container.throws"> &title.throws; <para> Index: peardoc/en/package/html/html-quickform-controller/html-quickform-controller/exportvalues.xml diff -u peardoc/en/package/html/html-quickform-controller/html-quickform-controller/exportvalues.xml:1.1 peardoc/en/package/html/html-quickform-controller/html-quickform-controller/exportvalues.xml:1.2 --- peardoc/en/package/html/html-quickform-controller/html-quickform-controller/exportvalues.xml:1.1 Thu Sep 4 17:03:51 2003 +++ peardoc/en/package/html/html-quickform-controller/html-quickform-controller/exportvalues.xml Fri Sep 19 11:15:09 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.html.html-quickform-controller.html-quickform-controller.exportvalues"> <refnamediv> <refname>Controller::exportValues()</refname> @@ -11,7 +11,7 @@ </funcsynopsisinfo> <funcprototype> <funcdef>array <function>HTML_QuickForm_Controller::exportValues</function></funcdef> -<paramdef></paramdef> + <paramdef>string <parameter> <optional>$pageName = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -20,6 +20,26 @@ &title.desc; &notdocumented; </refsect1> + <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.exportvalues.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + + + &type.string; + <parameter>$pageName</parameter> + </term> + <listitem> + <para> + name of the page, if not set then returns values for all pages + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.exportvalues.throws"> &title.throws; <para> @@ -49,4 +69,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> +--> Index: peardoc/en/package/html/html-quickform-controller/html-quickform-controller/exportvalue.xml +++ peardoc/en/package/html/html-quickform-controller/html-quickform-controller/exportvalue.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform-controller.html-quickform-controller.exportvalue"> <refnamediv> <refname>Controller::exportValue()</refname> <refpurpose>Returns the element's value</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;HTML/QuickForm/Controller.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>mixed <function>HTML_QuickForm_Controller::exportValue</function></funcdef> <paramdef>string <parameter>$pageName</parameter></paramdef> <paramdef>string <parameter>$elementName</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.exportvalue.desc"> &title.desc; &notdocumented; </refsect1> <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.exportvalue.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$pageName</parameter> </term> <listitem> <para> name of the page </para> </listitem> </varlistentry> <varlistentry> <term> &type.string; <parameter>$elementName</parameter> </term> <listitem> <para> name of the element in the page </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.exportvalue.returns"> &title.returns; <para> <emphasis>returns</emphasis> value for the element </para> </refsect1> <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.exportvalue.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform-controller.html-quickform-controller.exportvalue.note"> &title.note; &note.notstatic; </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 -->