File: SoapClient.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (113 lines) | stat: -rw-r--r-- 6,534 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SoapClient" namespace="" name="SoapClient">
  <method name="__call" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Calls a SOAP function (deprecated)"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="function_name" optional="false" byreference="false" type="string"/>
    <parameter name="arguments" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="SoapClient constructor"/>
      <return type="void"/>
    </docblock>
    <parameter name="wsdl" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </constructor>
  <method name="__doRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Performs a SOAP request">Performs SOAP request over HTTP.</description>
      <return type="string"/>
    </docblock>
    <parameter name="request" optional="false" byreference="false" type="string"/>
    <parameter name="location" optional="false" byreference="false" type="string"/>
    <parameter name="action" optional="false" byreference="false" type="string"/>
    <parameter name="version" optional="false" byreference="false" type="int"/>
    <parameter name="one_way" optional="true" byreference="false" type="int"/>
  </method>
  <method name="__getCookies" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get list of cookies"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="__getFunctions" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns list of available SOAP functions">Returns an array of functions described in the WSDL for the Web service.</description>
      <return type="array"/>
    </docblock>
  </method>
  <method name="__getLastRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns last SOAP request">Returns the XML sent in the last SOAP request.</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="__getLastRequestHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the SOAP headers from the last request">Returns the SOAP headers from the last request.</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="__getLastResponse" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns last SOAP response">Returns the XML received in the last SOAP response.</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="__getLastResponseHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the SOAP headers from the last response">Returns the SOAP headers from the last response.</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="__getTypes" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns a list of SOAP types">Returns an array of types described in the WSDL for the Web service.</description>
      <return type="array"/>
    </docblock>
  </method>
  <method name="__setCookie" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The __setCookie purpose">Defines a cookie to be sent along with the SOAP requests.</description>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="true" byreference="false" type="string"/>
  </method>
  <method name="__setLocation" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the location of the Web service to use">Sets the endpoint URL that will be touched by following SOAP requests. This is equivalent to specifying the location option when constructing the SoapClient.</description>
      <return type="string"/>
    </docblock>
    <parameter name="new_location" optional="true" byreference="false" type="string"/>
  </method>
  <method name="__setSoapHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets SOAP headers for subsequent calls">Defines headers to be sent along with the SOAP requests.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="soapheaders" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="__soapCall" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Calls a SOAP function">This is a low level API function that is used to make a SOAP call. Usually, in WSDL mode, SOAP functions can be called as methods of the SoapClient object. This method is useful in non-WSDL mode when soapaction is unknown, uri differs from the default or when sending and/or receiving SOAP Headers.</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="function_name" optional="false" byreference="false" type="string"/>
    <parameter name="arguments" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
    <parameter name="input_headers" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="output_headers" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="SoapClient" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="SoapClient constructor"/>
      <return type="void"/>
    </docblock>
    <parameter name="wsdl" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
</class>