php-doc-en/reference/sdo_das_xml/functions/SDO-DAS-XML-create.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.sdo-das-xml-create" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SDO_DAS_XML::create</refname>
  <refpurpose>
   To create SDO_DAS_XML object for a given schema file
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>SDO_DAS_XML</type><methodname>SDO_DAS_XML::create</methodname>
   <methodparam choice="opt"><type>mixed</type><parameter>xsd_file</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>key</parameter></methodparam>
  </methodsynopsis>

  <para>
   This is the only static method of SDO_DAS_XML class. 
   Used to instantiate SDO_DAS_XML object.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>xsd_file</parameter>
     </term>
     <listitem>
      <para>
       Path to XSD Schema file. This is optional. If omitted a DAS will be created
       that only has the SDO base types defined. Schema files can then be loaded
       with the <function>addTypes</function> method.
       Can be string or array of values.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>key</parameter>
     </term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns SDO_DAS_XML object on success otherwise throws an exception as described below.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>SDO_TypeNotFoundException</parameter>
     </term>
     <listitem>
      <para>
       Thrown if a type is not defined in the underlying model.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>SDO_DAS_XML_ParserException</parameter>
     </term>
     <listitem>
      <para>
       Thrown for any problems while parsing the given XSD File.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>SDO_DAS_XML_FileException</parameter>
     </term>
     <listitem>
      <para>
       Thrown if the specified file cannot be found. 
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </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>Description of change
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 -->


 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>SDO_DAS_XML::create</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
-->