cvs: peardoc /en/package/html/html-quickform html-quickform-file.xml /en/package/html/html-quickform/html-quickform-file getsize.xml getvalue.xml
html_quickform_file.xml isuploadedfile.xml moveuploadedfile.xml setsize.xml
| From: | Alexey Borzov | Date: | Sun, 26 Oct 2003 15:57:39 +0000 |
| Subject: | cvs: peardoc /en/package/html/html-quickform html-quickform-file.xml /en/package/html/html-quickform/html-quickform-file getsize.xml getvalue.xml html_quickform_file.xml isuploadedfile.xml moveuploadedfile.xml setsize.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-1757@lists.php.net to get a copy of this message | ||
avb Sun Oct 26 10:57:39 2003 EDT
Added files:
/peardoc/en/package/html/html-quickform html-quickform-file.xml
/peardoc/en/package/html/html-quickform/html-quickform-file
getsize.xml
getvalue.xml
html_quickform_file.xml
isuploadedfile.xml
moveuploadedfile.xml
setsize.xml
Log:
Docs for QF file element
Index: peardoc/en/package/html/html-quickform/html-quickform-file.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file"> <refnamediv> <refname>Class Summary <classname>HTML_QuickForm_file</classname></refname> <refpurpose>HTML class for a file type element</refpurpose> </refnamediv> <refsect1> &title.desc; <para> Alongside the usual element's methods, the class has special methods for working with uploaded files. When the class is included it also registers rules for validating the uploaded files. </para> </refsect1> <refsect1> <title>Class Trees for <classname>HTML_QuickForm_file</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> <link linkend="package.html.html-quickform.html-quickform-input"><classname>HTML_QuickForm_input</classname></link> <itemizedlist> <listitem><para> HTML_QuickForm_file </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para> <para> <classname>HTML_QuickForm_file</classname> Inherited Methods </para> <para> <table> <title>Inherited from <link linkend="package.html.html-quickform.html-quickform-input"><classname>HTML_QuickForm_input</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-input.html-quickform-input"><function>HTML_QuickForm_input::HTML_QuickForm_input</function></link></entry> <entry>Class constructor</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.exportvalue"><function>HTML_QuickForm_input::exportValue</function></link></entry> <entry>We don't need values from button-type elements (except submit) and files</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getname"><function>HTML_QuickForm_input::getName</function></link></entry> <entry>Returns the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getvalue"><function>HTML_QuickForm_input::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.onquickformevent"><function>HTML_QuickForm_input::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.setname"><function>HTML_QuickForm_input::setName</function></link></entry> <entry>Sets the input field name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-input.settype"><function>HTML_QuickForm_input::setType</function></link></entry> <entry>Sets the element type</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setvalue"><function>HTML_QuickForm_input::setValue</function></link></entry> <entry>Sets the value of the form element</entry> </row> </tbody> </tgroup> </table> <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> </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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/getsize.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/getsize.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.getsize"> <refnamediv> <refname>HTML_QuickForm_file::getSize()</refname> <refpurpose>Returns size of file element</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>int <function>HTML_QuickForm_file::getSize</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.getsize.desc"> &title.desc; <para>This means 'size' attribute of the <input /> element, not size of the uploaded file.</para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getsize.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getsize.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.html.html-quickform.html-quickform-file.setsize"><function>setSize</function></link>. </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getsize.note"> &title.note; <para> <emphasis>since</emphasis> 1.0 </para> ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/getvalue.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/getvalue.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.getvalue"> <refnamediv> <refname>HTML_QuickForm_file::getValue()</refname> <refpurpose>Returns information about the uploaded file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array <function>HTML_QuickForm_file::getValue</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.getvalue.desc"> &title.desc; <para>Returns the information about the file upload, as in the <varname>$_FILES</varname> array. Note that while there exists a <function>setValue</function> method, the method does nothing at all. The file element does not have a value if the form was not submitted.</para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getvalue.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getvalue.note"> &title.note; <para> <emphasis>since</emphasis> 3.0 </para> ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/html_quickform_file.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/html_quickform_file.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.html-quickform-file"> <refnamediv> <refname>constructor HTML_QuickForm_file()</refname> <refpurpose>Class constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTML_QuickForm_file::HTML_QuickForm_file</function></funcdef> <paramdef>string <parameter> <optional>$elementName = &null;</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$elementLabel = &null;</optional></parameter></paramdef> <paramdef>mixed <parameter> <optional>$attributes = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.html-quickform-file.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.html-quickform-file.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementName</parameter> </term> <listitem> <para> Input field name attribute </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementLabel</parameter> </term> <listitem> <para> Input field label </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-file.html-quickform-file.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.html-quickform-file.note"> &title.note; <para> <emphasis>since</emphasis> 1.0 </para> ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/isuploadedfile.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/isuploadedfile.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.isuploadedfile"> <refnamediv> <refname>HTML_QuickForm_file::isUploadedFile()</refname> <refpurpose>Checks if the element contains an uploaded file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>bool <function>HTML_QuickForm_file::isUploadedFile</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.isuploadedfile.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.isuploadedfile.returns"> &title.returns; <para> <emphasis>returns</emphasis> true if file has been uploaded, false otherwise </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.isuploadedfile.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.isuploadedfile.note"> &title.note; ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.moveuploadedfile"> <refnamediv> <refname>HTML_QuickForm_file::moveUploadedFile()</refname> <refpurpose>Moves an uploaded file into the destination</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTML_QuickForm_file::moveUploadedFile</function></funcdef> <paramdef>string <parameter>$dest</parameter></paramdef> <paramdef>string <parameter> <optional>$fileName = ''</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.moveuploadedfile.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.moveuploadedfile.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$dest</parameter> </term> <listitem> <para> Destination directory path </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$fileName</parameter> </term> <listitem> <para> New file name </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.moveuploadedfile.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.moveuploadedfile.note"> &title.note; ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/setsize.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/setsize.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.setsize"> <refnamediv> <refname>HTML_QuickForm_file::setSize()</refname> <refpurpose>Sets size of file element</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTML_QuickForm_file::setSize</function></funcdef> <paramdef>int <parameter>$size</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$size</parameter> </term> <listitem> <para> Size of file element </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.html.html-quickform.html-quickform-file.getsize"><function>getSize</function></link>. </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.note"> &title.note; <para> <emphasis>since</emphasis> 1.0 </para> ¬e.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 -->
Index: peardoc/en/package/html/html-quickform/html-quickform-file.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file"> <refnamediv> <refname>Class Summary <classname>HTML_QuickForm_file</classname></refname> <refpurpose>HTML class for a file type element</refpurpose> </refnamediv> <refsect1> &title.desc; <para> Alongside the usual element's methods, the class has special methods for working with uploaded files. When the class is included it also registers rules for validating the uploaded files. </para> </refsect1> <refsect1> <title>Class Trees for <classname>HTML_QuickForm_file</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> <link linkend="package.html.html-quickform.html-quickform-input"><classname>HTML_QuickForm_input</classname></link> <itemizedlist> <listitem><para> HTML_QuickForm_file </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para></listitem> </itemizedlist> </para> <para> <classname>HTML_QuickForm_file</classname> Inherited Methods </para> <para> <table> <title>Inherited from <link linkend="package.html.html-quickform.html-quickform-input"><classname>HTML_QuickForm_input</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-input.html-quickform-input"><function>HTML_QuickForm_input::HTML_QuickForm_input</function></link></entry> <entry>Class constructor</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.exportvalue"><function>HTML_QuickForm_input::exportValue</function></link></entry> <entry>We don't need values from button-type elements (except submit) and files</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getname"><function>HTML_QuickForm_input::getName</function></link></entry> <entry>Returns the element name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.getvalue"><function>HTML_QuickForm_input::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.onquickformevent"><function>HTML_QuickForm_input::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.setname"><function>HTML_QuickForm_input::setName</function></link></entry> <entry>Sets the input field name</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-input.settype"><function>HTML_QuickForm_input::setType</function></link></entry> <entry>Sets the element type</entry> </row> <row> <entry> <link linkend="package.html.html-quickform.html-quickform-element.setvalue"><function>HTML_QuickForm_input::setValue</function></link></entry> <entry>Sets the value of the form element</entry> </row> </tbody> </tgroup> </table> <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> </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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/getsize.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/getsize.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.getsize"> <refnamediv> <refname>HTML_QuickForm_file::getSize()</refname> <refpurpose>Returns size of file element</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>int <function>HTML_QuickForm_file::getSize</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.getsize.desc"> &title.desc; <para>This means 'size' attribute of the <input /> element, not size of the uploaded file.</para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getsize.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getsize.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.html.html-quickform.html-quickform-file.setsize"><function>setSize</function></link>. </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getsize.note"> &title.note; <para> <emphasis>since</emphasis> 1.0 </para> ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/getvalue.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/getvalue.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.getvalue"> <refnamediv> <refname>HTML_QuickForm_file::getValue()</refname> <refpurpose>Returns information about the uploaded file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array <function>HTML_QuickForm_file::getValue</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.getvalue.desc"> &title.desc; <para>Returns the information about the file upload, as in the <varname>$_FILES</varname> array. Note that while there exists a <function>setValue</function> method, the method does nothing at all. The file element does not have a value if the form was not submitted.</para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getvalue.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.getvalue.note"> &title.note; <para> <emphasis>since</emphasis> 3.0 </para> ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/html_quickform_file.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/html_quickform_file.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.html-quickform-file"> <refnamediv> <refname>constructor HTML_QuickForm_file()</refname> <refpurpose>Class constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTML_QuickForm_file::HTML_QuickForm_file</function></funcdef> <paramdef>string <parameter> <optional>$elementName = &null;</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$elementLabel = &null;</optional></parameter></paramdef> <paramdef>mixed <parameter> <optional>$attributes = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.html-quickform-file.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.html-quickform-file.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementName</parameter> </term> <listitem> <para> Input field name attribute </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$elementLabel</parameter> </term> <listitem> <para> Input field label </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-file.html-quickform-file.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.html-quickform-file.note"> &title.note; <para> <emphasis>since</emphasis> 1.0 </para> ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/isuploadedfile.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/isuploadedfile.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.isuploadedfile"> <refnamediv> <refname>HTML_QuickForm_file::isUploadedFile()</refname> <refpurpose>Checks if the element contains an uploaded file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>bool <function>HTML_QuickForm_file::isUploadedFile</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.isuploadedfile.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.isuploadedfile.returns"> &title.returns; <para> <emphasis>returns</emphasis> true if file has been uploaded, false otherwise </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.isuploadedfile.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.isuploadedfile.note"> &title.note; ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/moveuploadedfile.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.moveuploadedfile"> <refnamediv> <refname>HTML_QuickForm_file::moveUploadedFile()</refname> <refpurpose>Moves an uploaded file into the destination</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTML_QuickForm_file::moveUploadedFile</function></funcdef> <paramdef>string <parameter>$dest</parameter></paramdef> <paramdef>string <parameter> <optional>$fileName = ''</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.moveuploadedfile.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.moveuploadedfile.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$dest</parameter> </term> <listitem> <para> Destination directory path </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$fileName</parameter> </term> <listitem> <para> New file name </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.moveuploadedfile.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.moveuploadedfile.note"> &title.note; ¬e.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 --> Index: peardoc/en/package/html/html-quickform/html-quickform-file/setsize.xml +++ peardoc/en/package/html/html-quickform/html-quickform-file/setsize.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-quickform.html-quickform-file.setsize"> <refnamediv> <refname>HTML_QuickForm_file::setSize()</refname> <refpurpose>Sets size of file element</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/QuickForm/file.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTML_QuickForm_file::setSize</function></funcdef> <paramdef>int <parameter>$size</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$size</parameter> </term> <listitem> <para> Size of file element </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.html.html-quickform.html-quickform-file.getsize"><function>getSize</function></link>. </para> </refsect1> <refsect1 id="package.html.html-quickform.html-quickform-file.setsize.note"> &title.note; <para> <emphasis>since</emphasis> 1.0 </para> ¬e.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 -->