openuri.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="xmlwriter.openuri" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>XMLWriter::openUri</refname>
  <refname>xmlwriter_open_uri</refname>
  <refpurpose>Create new xmlwriter using source uri for output</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <methodsynopsis role="XMLWriter">
   <modifier>public</modifier> <type>bool</type><methodname>XMLWriter::openUri</methodname>
   <methodparam><type>string</type><parameter>uri</parameter></methodparam>
  </methodsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type class="union"><type>XMLWriter</type><type>false</type></type><methodname>xmlwriter_open_uri</methodname>
   <methodparam><type>string</type><parameter>uri</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates a new <classname>XMLWriter</classname> using 
   <parameter>uri</parameter> for the output.  
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>uri</parameter></term>
     <listitem>
      <para>
       The URI of the resource for the output.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &style.oop;: &return.success;
  </para>
  <para>
   &style.procedural;: Returns a new <classname>XMLWriter</classname> instance for later use with the
   xmlwriter functions on success, &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       This function returns now an <classname>XMLWriter</classname> instance on success.
       Previouly, a &resource; has been returned in this case.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="xmlwriter-open-uri.example.basic">
   <title>Direct output of XML</title>
   <para>
     It is possible to directly output XML by using the
     <link linkend="wrappers.php.output">php://output stream wrapper</link>.
   </para>
   <programlisting role="php">
<![CDATA[
<?php
$out =new XMLWriter();
$out->openURI('php://output');
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    On Windows, files opened with this function are locked until the writer is
    released.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>XMLWriter::openMemory</methodname></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
-->