<?xml version="1.0" encoding="utf-8"?> <!-- $Revision$ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry xml:id="httprequest.addpostfile" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>HttpRequest::addPostFile</refname> <refpurpose>Add post file</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>bool</type><methodname>HttpRequest::addPostFile</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>file</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>content_type</parameter><initializer>"application/x-octetstream"</initializer></methodparam> </methodsynopsis> <para> Add a file to the POST request, leaving previously set files unchanged. </para> <para> Affects only POST and custom requests. Cannot be used with raw post data. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>name</parameter></term> <listitem> <para> the form element name </para> </listitem> </varlistentry> <varlistentry> <term><parameter>file</parameter></term> <listitem> <para> the path to the file </para> </listitem> </varlistentry> <varlistentry> <term><parameter>content_type</parameter></term> <listitem> <para> the content type of the file </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &true; on success, or &false; if the content type seems not to contain a primary and a secondary content type part. </para> </refsect1> <!-- Use when ERRORS exist <refsect1 role="errors"> &reftitle.errors; <para> When does this function throw E_* level errors, or exceptions? </para> </refsect1> --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> &reftitle.changelog; <para> <informaltable> <tgroup cols="2"> <thead> <row> <entry>&Version;</entry> <entry>&Description;</entry> </row> </thead> <tbody> <row> <entry>Enter the PHP version of change here</entry> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>HttpRequest::addPostFile</function> example</title> <para> Any text that describes the purpose of the example, or what goes on in the example should go here (inside the <example> tag, not out </para> <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { echo 'Use the PEAR Coding Standards'; } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Use the PEAR Coding Standards ]]> </screen> </example> </para> </refsect1> --> <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function></function></member> <member>Or <link linkend="somethingelse">something else</link></member> </simplelist> </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 indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"~/.phpdoc/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 -->