cvs: peardoc /en/package/html html-quickform.xml /en/package/html/html-quickform html-quickform-xbutton.xml intro-elements.xml
/en/package/html/html-quickform/html-quickform html-quickform.xml issubmitted.xml toarray.xml /en/package/html/html-quickform/html-quickform-date
html-quickform-date.xml /en/package/html/html-quickform/html-quickform-xbutton html-quickform-xbutton.xml setcontent.xml
| From: | Alexey Borzov | Date: | Sun, 18 Jun 2006 15:39:15 +0000 |
| Subject: | cvs: peardoc /en/package/html html-quickform.xml /en/package/html/html-quickform html-quickform-xbutton.xml intro-elements.xml /en/package/html/html-quickform/html-quickform html-quickform.xml issubmitted.xml toarray.xml /en/package/html/html-quickform/html-quickform-date html-quickform-date.xml /en/package/html/html-quickform/html-quickform-xbutton html-quickform-xbutton.xml setcontent.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-8049@lists.php.net to get a copy of this message | ||
avb Sun Jun 18 15:39:15 2006 UTC
Added files:
/peardoc/en/package/html/html-quickform html-quickform-xbutton.xml
/peardoc/en/package/html/html-quickform/html-quickform
issubmitted.xml
/peardoc/en/package/html/html-quickform/html-quickform-xbutton
html-quickform-xbutton.xml
setcontent.xml
Modified files:
/peardoc/en/package/html html-quickform.xml
/peardoc/en/package/html/html-quickform intro-elements.xml
/peardoc/en/package/html/html-quickform/html-quickform
html-quickform.xml
toarray.xml
/peardoc/en/package/html/html-quickform/html-quickform-date
html-quickform-date.xml
Log:
Updated QuickForm docs with changes from releases 3.2.x
http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform.xml?r1=1.22&r2=1.23&diff_format=u Index: peardoc/en/package/html/html-quickform.xml diff -u peardoc/en/package/html/html-quickform.xml:1.22 peardoc/en/package/html/html-quickform.xml:1.23 --- peardoc/en/package/html/html-quickform.xml:1.22 Sun Jun 18 11:16:26 2006 +++ peardoc/en/package/html/html-quickform.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <sect1 id="package.html.html-quickform"> <title>HTML_QuickForm</title> <para> @@ -151,6 +151,10 @@ &package.html.html-quickform.html-quickform-textarea.setcols; &package.html.html-quickform.html-quickform-textarea.setrows; &package.html.html-quickform.html-quickform-textarea.setwrap; + +&package.html.html-quickform.html-quickform-xbutton; +&package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton; +&package.html.html-quickform.html-quickform-xbutton.setcontent; </sect3> <sect3 id="package.html.html-quickform.elements.custom"> <title>Custom elements</title> @@ -219,6 +223,7 @@ <title>Getting, setting and processing element values</title> &package.html.html-quickform.html-quickform.setconstants; &package.html.html-quickform.html-quickform.setdefaults; +&package.html.html-quickform.html-quickform.issubmitted; &package.html.html-quickform.html-quickform.exportvalue; &package.html.html-quickform.html-quickform.exportvalues; &package.html.html-quickform.html-quickform.getelementvalue; http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/intro-elements.xml?r1=1.8&r2=1.9&diff_format=u Index: peardoc/en/package/html/html-quickform/intro-elements.xml diff -u peardoc/en/package/html/html-quickform/intro-elements.xml:1.8 peardoc/en/package/html/html-quickform/intro-elements.xml:1.9 --- peardoc/en/package/html/html-quickform/intro-elements.xml:1.8 Mon Sep 12 14:29:10 2005 +++ peardoc/en/package/html/html-quickform/intro-elements.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="package.html.html-quickform.intro-elements"> <refnamediv> <refname>QuickForm element types</refname> @@ -7,7 +7,7 @@ <refsect1 id="package.html.html-quickform.intro-elements.overview"> <title>Elements overview</title> <para> -As of release 3.2, <classname>HTML_QuickForm</classname> knows 22 element types that can be created via <link linkend="package.html.html-quickform.html-quickform.createelement"><function>createElement</function></link> and added to the form via <link linkend="package.html.html-quickform.html-quickform.addelement"><function>addElement</function></link>. These can be divided into two big groups: standard HTML elements and custom elements. +As of release 3.2.5, <classname>HTML_QuickForm</classname> knows 23 element types that can be created via <link linkend="package.html.html-quickform.html-quickform.createelement"><function>createElement</function></link> and added to the form via <link linkend="package.html.html-quickform.html-quickform.addelement"><function>addElement</function></link>. These can be divided into two big groups: standard HTML elements and custom elements. </para> <variablelist> @@ -96,6 +96,13 @@ Class for <textarea> elements, <link linkend="package.html.html-quickform.html-quickform-textarea"><classname>HTML_QuickForm_textarea</classname></link> </para></listitem> </varlistentry> + + <varlistentry> + <term><literal>'xbutton'</literal></term> + <listitem><para> + Class for <button> elements, <link linkend="package.html.html-quickform.html-quickform-xbutton"><classname>HTML_QuickForm_xbutton</classname></link> + </para></listitem> + </varlistentry> </variablelist> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml diff -u peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml:1.5 peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml:1.6 --- peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml:1.5 Tue Mar 16 18:10:21 2004 +++ peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="package.html.html-quickform.html-quickform.html-quickform"> <refnamediv> <refname>constructor HTML_QuickForm::HTML_QuickForm()</refname> @@ -14,7 +14,7 @@ <paramdef>string <parameter> <optional>$formName = ''</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$method = 'post'</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$action = ''</optional></parameter></paramdef> - <paramdef>string <parameter> <optional>$target = '_self'</optional></parameter></paramdef> + <paramdef>string <parameter> <optional>$target = ''</optional></parameter></paramdef> <paramdef>mixed <parameter> <optional>$attributes = &null;</optional></parameter></paramdef> <paramdef>bool <parameter> <optional>$trackSubmit = &false;</optional></parameter></paramdef> </funcprototype> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform/toarray.xml?r1=1.1&r2=1.2&diff_format=u Index: peardoc/en/package/html/html-quickform/html-quickform/toarray.xml diff -u peardoc/en/package/html/html-quickform/html-quickform/toarray.xml:1.1 peardoc/en/package/html/html-quickform/html-quickform/toarray.xml:1.2 --- peardoc/en/package/html/html-quickform/html-quickform/toarray.xml:1.1 Thu May 29 19:26:55 2003 +++ peardoc/en/package/html/html-quickform/html-quickform/toarray.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.html.html-quickform.html-quickform.toarray"> <refnamediv> <refname>HTML_QuickForm::toArray()</refname> @@ -11,7 +11,7 @@ </funcsynopsisinfo> <funcprototype> <funcdef>array <function>HTML_QuickForm::toArray</function></funcdef> -<void /> + <paramdef>boolean <parameter><optional>$collectHidden = &false;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -20,6 +20,26 @@ &title.desc; <para>Returns the form's contents in an array, uses <link linkend="package.html.html-quickform.html-quickform-renderer-array">Array renderer</link> for this.</para> </refsect1> + + <refsect1 id="package.html.html-quickform.html-quickform.toarray.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.bool; + <parameter>$collectHidden</parameter> + </term> + <listitem> + <para> + Whether to collect hidden elements (passed to the <link linkend="package.html.html-quickform.html-quickform-renderer-array.html-quickform-renderer-array">Renderer's constructor</link>) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="package.html.html-quickform.html-quickform.toarray.return"> &title.returns; <para> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml?r1=1.4&r2=1.5&diff_format=u Index: peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml diff -u peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml:1.4 peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml:1.5 --- peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml:1.4 Tue Mar 16 18:10:25 2004 +++ peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="package.html.html-quickform.html-quickform-date.html-quickform-date"> <refnamediv> <refname>constructor HTML_QuickForm_date()</refname> @@ -28,7 +28,7 @@ <varlistentry> <term><literal>'language'</literal></term> <listitem><simpara> - Language (two-letter code) to use for display. Default is <literal>'en'</literal>. + Language code to use for display. Default is <literal>'en'</literal>. </simpara><simpara> date element supports many languages. If your one is not supported, send us the translation, we'll gladly include it. </simpara></listitem> @@ -54,6 +54,8 @@ s => Seconds a => am/pm A => AM/PM +g => 12 hour format w/o leading zeroes +W => week of the year ]]> </programlisting> Default is <literal>'dMY'</literal>. @@ -83,6 +85,8 @@ <term><literal>'addEmptyOption'</literal></term> <listitem><para> Should an empty option be added to the top of each select box? Default is &false;. + This may be set for individual fields also, if one passes an array of the form + array('format char' => &true;, ..., 'another format char' => &false;) </para></listitem> </varlistentry> @@ -97,6 +101,8 @@ <term><literal>'emptyOptionText'</literal></term> <listitem><para> The text displayed for the empty option. Default is <literal>'&nbsp;'</literal>. + This may be set for individual fields also, if one passes an array of the form + array('format char' => 'some text', ..., 'another format char' => 'some other text') </para></listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-xbutton.xml?view=markup&rev=1.1 Index: peardoc/en/package/html/html-quickform/html-quickform-xbutton.xml +++ peardoc/en/package/html/html-quickform/html-quickform-xbutton.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-xbutton"> <refnamediv> <refname>Class Summary <classname>HTML_QuickForm_xbutton</classname></refname> <refpurpose>Class for HTML 4.0 <button> element</refpurpose> </refnamediv> <refsect1> <title>Class for HTML 4.0 <button> element</title> <para> This class is named 'xbutton' since the name 'button' was already taken by class representing an <input type="button" /> HTML element. Available since HTML_QuickForm release 3.2.3 </para> </refsect1> <refsect1> <title>Class Trees for <classname>HTML_QuickForm_xbutton</classname></title> <para> <itemizedlist> <listitem><para> HTML_Common <itemizedlist> <listitem><para> <link linkend="package.html.html-quickform.html-quickform-element"><classname>HTML_QuickForm_element</classname></link> <itemizedlist> <listitem><para> HTML_QuickForm_xbutton </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para> <para> <classname>HTML_QuickForm_xbutton</classname> Inherited Methods </para> <para> <table> <title>Inherited from <link linkend="package.html.html-quickform.html-quickform-element"><classname>HTML_QuickForm_element</classname></link></title> <tgroup cols="2"> <thead> <row> <entry>Method Name</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry> Constructor <link linkend="package.html.html-quickform.html-quickform-element.html-quickform-element"><function>HTML_QuickForm_element::HTML_QuickForm_element</function></link></entry> <entry>Class constructor</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.accept"><function>HTML_QuickForm_element::accept</function></link></entry> <entry>Accepts a renderer</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.apiversion"><function>HTML_QuickForm_element::apiVersion</function></link></entry> <entry>Returns the current API version</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.exportvalue"><function>HTML_QuickForm_element::exportValue</function></link></entry> <entry>Returns a 'safe' element's value</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.freeze"><function>HTML_QuickForm_element::freeze</function></link></entry> <entry>Freeze the element so that only its value is returned</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getfrozenhtml"><function>HTML_QuickForm_element::getFrozenHtml</function></link></entry> <entry>Returns the value of field without HTML tags</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getlabel"><function>HTML_QuickForm_element::getLabel</function></link></entry> <entry>Returns display text for the element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getname"><function>HTML_QuickForm_element::getName</function></link></entry> <entry>Returns the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.gettype"><function>HTML_QuickForm_element::getType</function></link></entry> <entry>Returns element type</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getvalue"><function>HTML_QuickForm_element::getValue</function></link></entry> <entry>Returns the value of the form element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.isfrozen"><function>HTML_QuickForm_element::isFrozen</function></link></entry> <entry>Returns whether or not the element is frozen</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.onquickformevent"><function>HTML_QuickForm_element::onQuickFormEvent</function></link></entry> <entry>Called by HTML_QuickForm whenever form event is made on this element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setlabel"><function>HTML_QuickForm_element::setLabel</function></link></entry> <entry>Sets display text for the element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setname"><function>HTML_QuickForm_element::setName</function></link></entry> <entry>Sets the input field name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setpersistantfreeze"><function>HTML_QuickForm_element::setPersistantFreeze</function></link></entry> <entry>Sets wether an element value should be kept in an hidden field when the element is frozen or not</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setvalue"><function>HTML_QuickForm_element::setValue</function></link></entry> <entry>Sets the value of the form element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.unfreeze"><function>HTML_QuickForm_element::unfreeze</function></link></entry> <entry>Unfreezes the form element</entry> </row> </tbody> </tgroup> </table> </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-executeMultiple-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 --> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform/issubmitted.xml?view=markup&rev=1.1 Index: peardoc/en/package/html/html-quickform/html-quickform/issubmitted.xml +++ peardoc/en/package/html/html-quickform/html-quickform/issubmitted.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform.issubmitted"> <refnamediv> <refname>HTML_QuickForm::isSubmitted()</refname> <refpurpose>Tells whether the form was already submitted</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>HTML_QuickForm::isSubmitted</function></funcdef> <void /> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform.issubmitted.desc"> &title.desc; <para> Tells whether the form was already submitted. Using this method when <varname>$trackSubmit</varname> parameter of QuickForm's <link linkend="package.html.html-quickform.html-quickform.html-quickform">constructor</link> is used is more reliable than checking whether form's submit values are empty. </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform.issubmitted.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform.issubmitted.note"> &title.note; ¬e.notstatic; <para> <emphasis>since</emphasis> 3.2.5 </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 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 --> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-xbutton/html-quickform-xbutton.xml?view=markup&rev=1.1 Index: peardoc/en/package/html/html-quickform/html-quickform-xbutton/html-quickform-xbutton.xml +++ peardoc/en/package/html/html-quickform/html-quickform-xbutton/html-quickform-xbutton.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton"> <refnamediv> <refname>constructor HTML_QuickForm_xbutton()</refname> <refpurpose>Class constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/xbutton.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTML_QuickForm_xbutton::HTML_QuickForm_xbutton</function></funcdef> <paramdef>string <parameter> <optional>$elementName = &null;</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$elementContent = &null;</optional></parameter></paramdef> <paramdef>mixed <parameter> <optional>$attributes = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementName</parameter> </term> <listitem> <para> (optional) Button name </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementContent</parameter> </term> <listitem> <para> (optional) Button content (HTML to add between <button></button> tags) </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$attributes</parameter> </term> <listitem> <para> (optional) Either a typical HTML attribute string or an associative array </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton.note"> &title.note; ¬e.notstatic; <para> <emphasis>since</emphasis> 3.2.3 </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 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 --> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-xbutton/setcontent.xml?view=markup&rev=1.1 Index: peardoc/en/package/html/html-quickform/html-quickform-xbutton/setcontent.xml +++ peardoc/en/package/html/html-quickform/html-quickform-xbutton/setcontent.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-xbutton.setcontent"> <refnamediv> <refname>HTML_QuickForm_xbutton::setContent()</refname> <refpurpose>Sets the contents of the element</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/xbutton.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTML_QuickForm_xbutton::setContent</function></funcdef> <paramdef>string <parameter>$content</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.setcontent.desc"> &title.desc; <para>Sets the contents of the button element: HTML to add between <button></button> tags.</para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.setcontent.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$content</parameter> </term> <listitem> <para> HTML to add between <button></button> tags </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.setcontent.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.setcontent.note"> &title.note; ¬e.notstatic; <para> <emphasis>since</emphasis> 3.2.3 </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 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 -->
http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform.xml?r1=1.22&r2=1.23&diff_format=u Index: peardoc/en/package/html/html-quickform.xml diff -u peardoc/en/package/html/html-quickform.xml:1.22 peardoc/en/package/html/html-quickform.xml:1.23 --- peardoc/en/package/html/html-quickform.xml:1.22 Sun Jun 18 11:16:26 2006 +++ peardoc/en/package/html/html-quickform.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <sect1 id="package.html.html-quickform"> <title>HTML_QuickForm</title> <para> @@ -151,6 +151,10 @@ &package.html.html-quickform.html-quickform-textarea.setcols; &package.html.html-quickform.html-quickform-textarea.setrows; &package.html.html-quickform.html-quickform-textarea.setwrap; + +&package.html.html-quickform.html-quickform-xbutton; +&package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton; +&package.html.html-quickform.html-quickform-xbutton.setcontent; </sect3> <sect3 id="package.html.html-quickform.elements.custom"> <title>Custom elements</title> @@ -219,6 +223,7 @@ <title>Getting, setting and processing element values</title> &package.html.html-quickform.html-quickform.setconstants; &package.html.html-quickform.html-quickform.setdefaults; +&package.html.html-quickform.html-quickform.issubmitted; &package.html.html-quickform.html-quickform.exportvalue; &package.html.html-quickform.html-quickform.exportvalues; &package.html.html-quickform.html-quickform.getelementvalue; http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/intro-elements.xml?r1=1.8&r2=1.9&diff_format=u Index: peardoc/en/package/html/html-quickform/intro-elements.xml diff -u peardoc/en/package/html/html-quickform/intro-elements.xml:1.8 peardoc/en/package/html/html-quickform/intro-elements.xml:1.9 --- peardoc/en/package/html/html-quickform/intro-elements.xml:1.8 Mon Sep 12 14:29:10 2005 +++ peardoc/en/package/html/html-quickform/intro-elements.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="package.html.html-quickform.intro-elements"> <refnamediv> <refname>QuickForm element types</refname> @@ -7,7 +7,7 @@ <refsect1 id="package.html.html-quickform.intro-elements.overview"> <title>Elements overview</title> <para> -As of release 3.2, <classname>HTML_QuickForm</classname> knows 22 element types that can be created via <link linkend="package.html.html-quickform.html-quickform.createelement"><function>createElement</function></link> and added to the form via <link linkend="package.html.html-quickform.html-quickform.addelement"><function>addElement</function></link>. These can be divided into two big groups: standard HTML elements and custom elements. +As of release 3.2.5, <classname>HTML_QuickForm</classname> knows 23 element types that can be created via <link linkend="package.html.html-quickform.html-quickform.createelement"><function>createElement</function></link> and added to the form via <link linkend="package.html.html-quickform.html-quickform.addelement"><function>addElement</function></link>. These can be divided into two big groups: standard HTML elements and custom elements. </para> <variablelist> @@ -96,6 +96,13 @@ Class for <textarea> elements, <link linkend="package.html.html-quickform.html-quickform-textarea"><classname>HTML_QuickForm_textarea</classname></link> </para></listitem> </varlistentry> + + <varlistentry> + <term><literal>'xbutton'</literal></term> + <listitem><para> + Class for <button> elements, <link linkend="package.html.html-quickform.html-quickform-xbutton"><classname>HTML_QuickForm_xbutton</classname></link> + </para></listitem> + </varlistentry> </variablelist> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml?r1=1.5&r2=1.6&diff_format=u Index: peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml diff -u peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml:1.5 peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml:1.6 --- peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml:1.5 Tue Mar 16 18:10:21 2004 +++ peardoc/en/package/html/html-quickform/html-quickform/html-quickform.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="package.html.html-quickform.html-quickform.html-quickform"> <refnamediv> <refname>constructor HTML_QuickForm::HTML_QuickForm()</refname> @@ -14,7 +14,7 @@ <paramdef>string <parameter> <optional>$formName = ''</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$method = 'post'</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$action = ''</optional></parameter></paramdef> - <paramdef>string <parameter> <optional>$target = '_self'</optional></parameter></paramdef> + <paramdef>string <parameter> <optional>$target = ''</optional></parameter></paramdef> <paramdef>mixed <parameter> <optional>$attributes = &null;</optional></parameter></paramdef> <paramdef>bool <parameter> <optional>$trackSubmit = &false;</optional></parameter></paramdef> </funcprototype> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform/toarray.xml?r1=1.1&r2=1.2&diff_format=u Index: peardoc/en/package/html/html-quickform/html-quickform/toarray.xml diff -u peardoc/en/package/html/html-quickform/html-quickform/toarray.xml:1.1 peardoc/en/package/html/html-quickform/html-quickform/toarray.xml:1.2 --- peardoc/en/package/html/html-quickform/html-quickform/toarray.xml:1.1 Thu May 29 19:26:55 2003 +++ peardoc/en/package/html/html-quickform/html-quickform/toarray.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.html.html-quickform.html-quickform.toarray"> <refnamediv> <refname>HTML_QuickForm::toArray()</refname> @@ -11,7 +11,7 @@ </funcsynopsisinfo> <funcprototype> <funcdef>array <function>HTML_QuickForm::toArray</function></funcdef> -<void /> + <paramdef>boolean <parameter><optional>$collectHidden = &false;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -20,6 +20,26 @@ &title.desc; <para>Returns the form's contents in an array, uses <link linkend="package.html.html-quickform.html-quickform-renderer-array">Array renderer</link> for this.</para> </refsect1> + + <refsect1 id="package.html.html-quickform.html-quickform.toarray.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.bool; + <parameter>$collectHidden</parameter> + </term> + <listitem> + <para> + Whether to collect hidden elements (passed to the <link linkend="package.html.html-quickform.html-quickform-renderer-array.html-quickform-renderer-array">Renderer's constructor</link>) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="package.html.html-quickform.html-quickform.toarray.return"> &title.returns; <para> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml?r1=1.4&r2=1.5&diff_format=u Index: peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml diff -u peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml:1.4 peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml:1.5 --- peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml:1.4 Tue Mar 16 18:10:25 2004 +++ peardoc/en/package/html/html-quickform/html-quickform-date/html-quickform-date.xml Sun Jun 18 15:39:15 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="package.html.html-quickform.html-quickform-date.html-quickform-date"> <refnamediv> <refname>constructor HTML_QuickForm_date()</refname> @@ -28,7 +28,7 @@ <varlistentry> <term><literal>'language'</literal></term> <listitem><simpara> - Language (two-letter code) to use for display. Default is <literal>'en'</literal>. + Language code to use for display. Default is <literal>'en'</literal>. </simpara><simpara> date element supports many languages. If your one is not supported, send us the translation, we'll gladly include it. </simpara></listitem> @@ -54,6 +54,8 @@ s => Seconds a => am/pm A => AM/PM +g => 12 hour format w/o leading zeroes +W => week of the year ]]> </programlisting> Default is <literal>'dMY'</literal>. @@ -83,6 +85,8 @@ <term><literal>'addEmptyOption'</literal></term> <listitem><para> Should an empty option be added to the top of each select box? Default is &false;. + This may be set for individual fields also, if one passes an array of the form + array('format char' => &true;, ..., 'another format char' => &false;) </para></listitem> </varlistentry> @@ -97,6 +101,8 @@ <term><literal>'emptyOptionText'</literal></term> <listitem><para> The text displayed for the empty option. Default is <literal>'&nbsp;'</literal>. + This may be set for individual fields also, if one passes an array of the form + array('format char' => 'some text', ..., 'another format char' => 'some other text') </para></listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-xbutton.xml?view=markup&rev=1.1 Index: peardoc/en/package/html/html-quickform/html-quickform-xbutton.xml +++ peardoc/en/package/html/html-quickform/html-quickform-xbutton.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-xbutton"> <refnamediv> <refname>Class Summary <classname>HTML_QuickForm_xbutton</classname></refname> <refpurpose>Class for HTML 4.0 <button> element</refpurpose> </refnamediv> <refsect1> <title>Class for HTML 4.0 <button> element</title> <para> This class is named 'xbutton' since the name 'button' was already taken by class representing an <input type="button" /> HTML element. Available since HTML_QuickForm release 3.2.3 </para> </refsect1> <refsect1> <title>Class Trees for <classname>HTML_QuickForm_xbutton</classname></title> <para> <itemizedlist> <listitem><para> HTML_Common <itemizedlist> <listitem><para> <link linkend="package.html.html-quickform.html-quickform-element"><classname>HTML_QuickForm_element</classname></link> <itemizedlist> <listitem><para> HTML_QuickForm_xbutton </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para> <para> <classname>HTML_QuickForm_xbutton</classname> Inherited Methods </para> <para> <table> <title>Inherited from <link linkend="package.html.html-quickform.html-quickform-element"><classname>HTML_QuickForm_element</classname></link></title> <tgroup cols="2"> <thead> <row> <entry>Method Name</entry> <entry>Summary</entry> </row> </thead> <tbody> <row> <entry> Constructor <link linkend="package.html.html-quickform.html-quickform-element.html-quickform-element"><function>HTML_QuickForm_element::HTML_QuickForm_element</function></link></entry> <entry>Class constructor</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.accept"><function>HTML_QuickForm_element::accept</function></link></entry> <entry>Accepts a renderer</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.apiversion"><function>HTML_QuickForm_element::apiVersion</function></link></entry> <entry>Returns the current API version</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.exportvalue"><function>HTML_QuickForm_element::exportValue</function></link></entry> <entry>Returns a 'safe' element's value</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.freeze"><function>HTML_QuickForm_element::freeze</function></link></entry> <entry>Freeze the element so that only its value is returned</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getfrozenhtml"><function>HTML_QuickForm_element::getFrozenHtml</function></link></entry> <entry>Returns the value of field without HTML tags</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getlabel"><function>HTML_QuickForm_element::getLabel</function></link></entry> <entry>Returns display text for the element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getname"><function>HTML_QuickForm_element::getName</function></link></entry> <entry>Returns the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.gettype"><function>HTML_QuickForm_element::getType</function></link></entry> <entry>Returns element type</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getvalue"><function>HTML_QuickForm_element::getValue</function></link></entry> <entry>Returns the value of the form element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.isfrozen"><function>HTML_QuickForm_element::isFrozen</function></link></entry> <entry>Returns whether or not the element is frozen</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.onquickformevent"><function>HTML_QuickForm_element::onQuickFormEvent</function></link></entry> <entry>Called by HTML_QuickForm whenever form event is made on this element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setlabel"><function>HTML_QuickForm_element::setLabel</function></link></entry> <entry>Sets display text for the element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setname"><function>HTML_QuickForm_element::setName</function></link></entry> <entry>Sets the input field name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setpersistantfreeze"><function>HTML_QuickForm_element::setPersistantFreeze</function></link></entry> <entry>Sets wether an element value should be kept in an hidden field when the element is frozen or not</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setvalue"><function>HTML_QuickForm_element::setValue</function></link></entry> <entry>Sets the value of the form element</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.unfreeze"><function>HTML_QuickForm_element::unfreeze</function></link></entry> <entry>Unfreezes the form element</entry> </row> </tbody> </tgroup> </table> </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-executeMultiple-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 --> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform/issubmitted.xml?view=markup&rev=1.1 Index: peardoc/en/package/html/html-quickform/html-quickform/issubmitted.xml +++ peardoc/en/package/html/html-quickform/html-quickform/issubmitted.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform.issubmitted"> <refnamediv> <refname>HTML_QuickForm::isSubmitted()</refname> <refpurpose>Tells whether the form was already submitted</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>HTML_QuickForm::isSubmitted</function></funcdef> <void /> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform.issubmitted.desc"> &title.desc; <para> Tells whether the form was already submitted. Using this method when <varname>$trackSubmit</varname> parameter of QuickForm's <link linkend="package.html.html-quickform.html-quickform.html-quickform">constructor</link> is used is more reliable than checking whether form's submit values are empty. </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform.issubmitted.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform.issubmitted.note"> &title.note; ¬e.notstatic; <para> <emphasis>since</emphasis> 3.2.5 </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 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 --> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-xbutton/html-quickform-xbutton.xml?view=markup&rev=1.1 Index: peardoc/en/package/html/html-quickform/html-quickform-xbutton/html-quickform-xbutton.xml +++ peardoc/en/package/html/html-quickform/html-quickform-xbutton/html-quickform-xbutton.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton"> <refnamediv> <refname>constructor HTML_QuickForm_xbutton()</refname> <refpurpose>Class constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/xbutton.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTML_QuickForm_xbutton::HTML_QuickForm_xbutton</function></funcdef> <paramdef>string <parameter> <optional>$elementName = &null;</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$elementContent = &null;</optional></parameter></paramdef> <paramdef>mixed <parameter> <optional>$attributes = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementName</parameter> </term> <listitem> <para> (optional) Button name </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementContent</parameter> </term> <listitem> <para> (optional) Button content (HTML to add between <button></button> tags) </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$attributes</parameter> </term> <listitem> <para> (optional) Either a typical HTML attribute string or an associative array </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.html-quickform-xbutton.note"> &title.note; ¬e.notstatic; <para> <emphasis>since</emphasis> 3.2.3 </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 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 --> http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/html-quickform/html-quickform-xbutton/setcontent.xml?view=markup&rev=1.1 Index: peardoc/en/package/html/html-quickform/html-quickform-xbutton/setcontent.xml +++ peardoc/en/package/html/html-quickform/html-quickform-xbutton/setcontent.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-xbutton.setcontent"> <refnamediv> <refname>HTML_QuickForm_xbutton::setContent()</refname> <refpurpose>Sets the contents of the element</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/xbutton.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTML_QuickForm_xbutton::setContent</function></funcdef> <paramdef>string <parameter>$content</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.setcontent.desc"> &title.desc; <para>Sets the contents of the button element: HTML to add between <button></button> tags.</para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.setcontent.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$content</parameter> </term> <listitem> <para> HTML to add between <button></button> tags </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.setcontent.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-xbutton.setcontent.note"> &title.note; ¬e.notstatic; <para> <emphasis>since</emphasis> 3.2.3 </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 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 -->