File: SCA-LocalProxy-createDataObject.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (170 lines) | stat: -rw-r--r-- 4,155 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.sca-localproxy-createdataobject" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SCA_LocalProxy::createDataObject</refname>
  <refpurpose> create an SDO </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>SDO_DataObject</type>
   <methodname>SCA_LocalProxy::createDataObject</methodname>
   <methodparam>
    <type>string</type>
    <parameter>type_namespace_uri</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>type_name</parameter>
   </methodparam>
  </methodsynopsis>
  
  &warn.experimental.func;
  
  <para> This method is used inside either an ordinary PHP script or an SCA
   component that needs to create an SDO to pass to a local service. The
   parameters are the desired SDO's namespace URI and type name. The
   namespace and type must be defined in the interface of the component
   that is to be called, so the namespace and type must be defined in one of
   the schema files which are specified on the @types annotation within
   the component for which the SCA_LocalProxy object is a proxy. </para>
  
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>type_namespace_uri</parameter>
     </term>
     <listitem>
      <para> The namespace of the type. </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>type_name</parameter>
     </term>
     <listitem>
      <para> The name of the type. </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para> Returns the newly created SDO_DataObject. </para>
 </refsect1>
 
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>SDO_TypeNotFoundException</parameter>
     </term>
     <listitem>
      <para> Thrown if the namespaceURI and typeName do not correspond
       to a type in any of the schema files specified in the @types
       annotations within the component for which the SCA_LocalProxy
       object is a proxy.. </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>xxx::xxx</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
-->