/
fetch.xml
177 lines (166 loc) · 4.87 KB
/
fetch.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: af5f2f87b3b0bb9ee0f83ccb787a4e7db1eb6bd4 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="oauth.fetch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>OAuth::fetch</refname>
<refpurpose>OAuth で保護されたリソースを取得する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>OAuth::fetch</methodname>
<methodparam><type>string</type><parameter>protected_resource_url</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>extra_parameters</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>http_method</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>http_headers</parameter></methodparam>
</methodsynopsis>
<para>
リソースを取得します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>protected_resource_url</parameter></term>
<listitem>
<para>
OAuth で保護されたリソースへの URL。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extra_parameters</parameter></term>
<listitem>
<para>
リソースへのリクエストとともに送信する追加パラメータ。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_method</parameter></term>
<listitem>
<para>
<constant>OAUTH_HTTP_METHOD_*</constant>
<link linkend="oauth.constants">OAUTH 定数</link> のいずれか。
GET、POST、PUT、HEAD そして DELETE があります。
</para>
<para>
HEAD (<constant>OAUTH_HTTP_METHOD_HEAD</constant>) は、
実際のリクエストの前に
(OAuth 認証情報が <literal>Authorization</literal> ヘッダにあるかどうかなどの)
情報を取得するときに有用です。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>http_headers</parameter></term>
<listitem>
<para>
HTTP クライアントヘッダ (User-Agent や Accept など)。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL oauth 1.0.0</entry>
<entry>
&oauth.changelog.error.null;
</entry>
</row>
<row>
<entry>PECL oauth 0.99.5</entry>
<entry>
<parameter>http_method</parameter> パラメータが追加されました。
</entry>
</row>
<row>
<entry>PECL oauth 0.99.8</entry>
<entry>
<parameter>http_headers</parameter> パラメータが追加されました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>OAuth::fetch</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
try {
$oauth = new OAuth("consumer_key","consumer_secret",OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_AUTHORIZATION);
$oauth->setToken("access_token","access_token_secret");
$oauth->fetch("http://photos.example.net/photo?file=vacation.jpg");
$response_info = $oauth->getLastResponseInfo();
header("Content-Type: {$response_info["content_type"]}");
echo $oauth->getLastResponse();
} catch(OAuthException $E) {
echo "Exception caught!\n";
echo "Response: ". $E->lastResponse . "\n";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>OAuth::getLastResponse</methodname></member>
<member><methodname>OAuth::getLastResponseInfo</methodname></member>
<member><methodname>OAuth::setToken</methodname></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
-->