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
|
<?xml version='1.0' encoding="utf-8"?>
<!-- $Revision: 297078 $ -->
<reference xml:id="ref.sca" xmlns="http://docbook.org/ns/docbook">
<title>SCA &Functions;</title>
<partintro>
<!-- FIXME: This needs to be upgraded to the new oo-markup -->
<!-- Class definition section -->
<section xml:id='sca.classes'><!-- {{{ -->
&reftitle.classes;
<para>
Most of the interface to SCA is through the annotations within
SCA components so there are few public classes and methods. The only
SCA classes that scripts or components can call are the <classname>SCA</classname>
class itself, and the proxy classes <classname>SCA_LocalProxy</classname>
and <classname>SCA_SoapProxy</classname>.
</para>
<section xml:id='sca.class'><!-- {{{ -->
<title><classname>SCA</classname></title>
<para>
Much of the work of the SCA class is performed when the file
<filename>SCA.php</filename> is included within an SCA component.
However, a PHP script may include
<filename>SCA.php</filename> and call the
<function>getService</function> method on the SCA class in order
to obtain a proxy for a service. A component will not need to do this as
proxies are obtained instead by defining an instance variable with
the @reference annotation.
</para>
<para>
Components that need to create an SDO to return to a caller will
need a data factory to call. For this purpose the SCA class supports
the
<function>createDataObject</function> method, which will
create an SDO according to the model defined by the component's
@types annotations. The arguments to
<function>createDataObject</function> are the same as those to
SDO's XML Data Access Service.
</para>
<section xml:id='sca.class.SCA.methods'><!-- {{{ -->
&reftitle.methods;
<itemizedlist>
<listitem>
<para>
<link linkend='function.sca-getservice'>
getService</link> - obtain a proxy for a service
</para>
</listitem>
<listitem>
<para>
<link linkend='function.sca-createdataobject'>
createDataObject</link> - create an SDO
</para>
</listitem>
</itemizedlist>
</section> <!-- }}} -->
</section><!-- }}} -->
<section xml:id='sca-local-proxy.class'><!-- {{{ -->
<title>
<classname>SCA_LocalProxy</classname>
</title>
<para>
When
<function>getService</function> is called with the target of a
local PHP component, a local proxy is returned. A local proxy is also
injected into the instance variables of a component that are
defined with an @reference and an @binding.php anotation. When the
script or component makes calls on the local proxy, they are passed
on to the target component itself.
</para>
<para>
Components that need to create an SDO to pass to a component
will need a data factory to call. For this purpose the
SCA_LocalProxy class supports the <function>createDataObject</function> method,
which will create an SDO according to the model defined by the
components' @types annotations. The arguments to the
<function>createDataObject</function> are the same as those to SDO's XML Data Access
Service.
</para>
<section xml:id='sca.class.SCA-LocalProxy.methods'><!-- {{{ -->
&reftitle.methods;
<itemizedlist>
<listitem>
<para>
<link
linkend='function.sca-localproxy-createdataobject'>
createDataObject</link> - create an SDO
</para>
</listitem>
</itemizedlist>
</section><!-- }}} -->
</section><!-- }}} -->
<section xml:id='sca-soap-proxy.class'><!-- {{{ -->
<title>
<classname>SCA_SoapProxy</classname>
</title>
<para>
When
<function>getService</function> is called with the target of a
WSDL file, a SOAP proxy is returned. A SOAP proxy is also injected
into the instance variables of a component that are defined with an
@reference and an @binding.soap anotations. When the script or
component makes calls on the SOAP proxy, they are formed into Web
service SOAP requests and passed on to the target component, with
the help of the PHP Soap extension.
</para>
<para>
Components that need to create an SDO to pass to a component
will need a data factory to call. For this purpose the
<classname>SCA_SoapProxy</classname> class supports the
<function>createDataObject</function> method, which will create an
SDO according to the model defined within the target WSDL. The
arguments to the <function>createDataObject</function> are the same
as those to SDO's XML Data Access Service.
</para>
<section xml:id='sca.class.SCA-SoapProxy.methods'><!-- {{{ -->
&reftitle.methods;
<itemizedlist>
<listitem>
<para>
<link
linkend='function.sca-soapproxy-createdataobject'>
createDataObject</link> - create an SDO
</para>
</listitem>
</itemizedlist>
</section><!-- }}} -->
</section><!-- }}} -->
</section>
<!-- }}} -->
</partintro>
&reference.sca.entities.functions;
</reference>
<!-- 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
-->
|
