File: OAuth.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 (209 lines) | stat: -rw-r--r-- 9,343 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
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="OAuth" namespace="" name="OAuth">
  <member name="debug" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="sslChecks" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="debugInfo" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a new OAuth object"/>
      <return type="void"/>
    </docblock>
    <parameter name="consumer_key" optional="false" byreference="false" type="string"/>
    <parameter name="consumer_secret" optional="false" byreference="false" type="string"/>
    <parameter name="signature_method" optional="true" byreference="false" type="string"/>
    <parameter name="auth_type" optional="true" byreference="false" type="int"/>
  </constructor>
  <destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The destructor"/>
      <return type="void"/>
    </docblock>
  </destructor>
  <method name="disableDebug" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Turn off verbose debugging"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="disableRedirects" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Turn off redirects"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="disableSSLChecks" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Turn off SSL checks"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="enableDebug" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Turn on verbose debugging"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="enableRedirects" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Turn on redirects"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="enableSSLChecks" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Turn on SSL checks"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="fetch" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Fetch an OAuth protected resource"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="protected_resource_url" optional="false" byreference="false" type="string"/>
    <parameter name="extra_parameters" optional="true" byreference="false" type="object" class="array"/>
    <parameter name="http_method" optional="true" byreference="false" type="string"/>
    <parameter name="http_headers" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="generateSignature" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Generate a signature"/>
      <return type="string"/>
    </docblock>
    <parameter name="http_method" optional="false" byreference="false" type="string"/>
    <parameter name="url" optional="false" byreference="false" type="string"/>
    <parameter name="extra_parameters" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="getAccessToken" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Fetch an access token"/>
      <return type="array"/>
    </docblock>
    <parameter name="access_token_url" optional="false" byreference="false" type="string"/>
    <parameter name="auth_session_handle" optional="true" byreference="false" type="string"/>
    <parameter name="verifier_token" optional="true" byreference="false" type="string"/>
    <parameter name="http_method" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getCAPath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets CA information"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getLastResponse" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the last response"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getLastResponseHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get headers for last response"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getLastResponseInfo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get HTTP information about the last response"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getRequestHeader" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Generate OAuth header string signature"/>
      <return type="string"/>
    </docblock>
    <parameter name="http_method" optional="false" byreference="false" type="string"/>
    <parameter name="url" optional="false" byreference="false" type="string"/>
    <parameter name="extra_parameters" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="getRequestToken" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Fetch a request token"/>
      <return type="array"/>
    </docblock>
    <parameter name="request_token_url" optional="false" byreference="false" type="string"/>
    <parameter name="callback_url" optional="true" byreference="false" type="string"/>
    <parameter name="http_method" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setAuthType" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set authorization type"/>
      <return type="bool"/>
    </docblock>
    <parameter name="auth_type" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setCAPath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set CA path and info"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="ca_path" optional="true" byreference="false" type="string"/>
    <parameter name="ca_info" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setNonce" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the nonce for subsequent requests"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="nonce" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setRequestEngine" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The setRequestEngine purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="reqengine" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setRSACertificate" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the RSA certificate"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="cert" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setSSLChecks" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Tweak specific SSL checks for requests"/>
      <return type="bool"/>
    </docblock>
    <parameter name="sslcheck" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setTimestamp" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the timestamp"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="timestamp" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setToken" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the token and secret"/>
      <return type="bool"/>
    </docblock>
    <parameter name="token" optional="false" byreference="false" type="string"/>
    <parameter name="token_secret" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setVersion" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the OAuth version"/>
      <return type="bool"/>
    </docblock>
    <parameter name="version" optional="false" byreference="false" type="string"/>
  </method>
</class>