File: OAuthProvider.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 (116 lines) | stat: -rw-r--r-- 5,500 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="OAuthProvider" namespace="" name="OAuthProvider">
  <method name="addRequiredParameter" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Add required parameters"/>
      <return type="bool"/>
    </docblock>
    <parameter name="req_params" optional="false" byreference="false" type="string"/>
  </method>
  <method name="callconsumerHandler" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Calls the consumerNonceHandler callback"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="callTimestampNonceHandler" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Calls the timestampNonceHandler callback"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="calltokenHandler" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Calls the tokenNonceHandler callback"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="checkOAuthRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check an oauth request"/>
      <return type="void"/>
    </docblock>
    <parameter name="uri" optional="true" byreference="false" type="string"/>
    <parameter name="method" optional="true" byreference="false" type="string"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a new OAuthProvider object"/>
      <return type="void"/>
    </docblock>
    <parameter name="params_array" optional="true" byreference="false" type="object" class="array"/>
  </constructor>
  <method name="consumerHandler" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the consumerHandler handler callback"/>
      <return type="void"/>
    </docblock>
    <parameter name="callback_function" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="generateToken" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Generate a random token"/>
      <return type="string"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="int"/>
    <parameter name="strong" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="is2LeggedEndpoint" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="is2LeggedEndpoint"/>
      <return type="void"/>
    </docblock>
    <parameter name="params_array" optional="false" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="isRequestTokenEndpoint" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets isRequestTokenEndpoint"/>
      <return type="void"/>
    </docblock>
    <parameter name="will_issue_request_token" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="removeRequiredParameter" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Remove a required parameter"/>
      <return type="bool"/>
    </docblock>
    <parameter name="req_params" optional="false" byreference="false" type="string"/>
  </method>
  <method name="reportProblem" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Report a problem"/>
      <return type="string"/>
    </docblock>
    <parameter name="oauthexception" optional="false" byreference="false" type="string"/>
    <parameter name="send_headers" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setParam" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Set a parameter"/>
      <return type="bool"/>
    </docblock>
    <parameter name="param_key" optional="false" byreference="false" type="string"/>
    <parameter name="param_val" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="setRequestTokenPath" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Set request token path"/>
      <return type="bool"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
  </method>
  <method name="timestampNonceHandler" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the timestampNonceHandler handler callback"/>
      <return type="void"/>
    </docblock>
    <parameter name="callback_function" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="tokenHandler" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the tokenHandler handler callback"/>
      <return type="void"/>
    </docblock>
    <parameter name="callback_function" optional="false" byreference="false" type="object" class="callable"/>
  </method>
</class>