| blob | db730a188408c189ef2270873a67a0b900877236 |
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- Reviewed: no -->
3 <!-- EN-Revision: 20843 -->
4 <sect1 id="zend.service.flickr">
5 <title>Zend_Service_Flickr</title>
6 <sect2 id="zend.service.flickr.introduction">
7 <title>導入</title>
8 <para>
9 <classname>Zend_Service_Flickr</classname> は、Flickr の REST Web Service
10 を使用するためのシンプルな <acronym>API</acronym> です。
11 Flickr ウェブサービスを使用するには <acronym>API</acronym> キーが必要です。
12 キーを取得したり Flickr REST Web Service の詳細情報を取得したりするには
13 <ulink url="http://www.flickr.com/services/api/">Flickr <acronym>API</acronym> Documentation</ulink>
14 を参照ください。
15 </para>
16 <para>
17 以下の例では、"php" というタグがつけられた写真を
18 <methodname>tagSearch()</methodname> メソッドを使用して検索します。
19 </para>
20 <example id="zend.service.flickr.introduction.example-1">
21 <title>単純な Flickr 検索</title>
22 <programlisting language="php"><![CDATA[
23 $flickr = new Zend_Service_Flickr('MY_API_KEY');
25 $results = $flickr->tagSearch("php");
27 foreach ($results as $result) {
28 echo $result->title . '<br />';
29 }
30 ]]></programlisting>
31 </example>
32 <note>
33 <title>オプションのパラメータ</title>
34 <para>
35 <methodname>tagSearch()</methodname> は、オプションの
36 二番目の引数に検索オプションを指定できます。
37 </para>
38 </note>
39 </sect2>
40 <sect2 id="zend.service.flickr.finding-users">
41 <title>Flickr ユーザの写真や情報の検索</title>
42 <para>
43 <classname>Zend_Service_Flickr</classname> では、いくつかの方法で
44 Flickr ユーザについての情報を取得できます。
45 </para>
46 <itemizedlist>
47 <listitem>
48 <para>
49 <methodname>userSearch()</methodname>:
50 タグをスペースで区切ったクエリ文字列、
51 そしてオプションの二番目のパラメータで検索オプションの配列を指定して検索し、
52 結果の写真を <classname>Zend_Service_Flickr_ResultSet</classname> オブジェクトで返します。
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 <methodname>getIdByUsername()</methodname>:
58 指定したユーザ名に対応するユーザ ID を文字列で返します。
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 <methodname>getIdByEmail()</methodname>:
64 指定したメールアドレスに対応するユーザ ID を文字列で返します。
65 </para>
66 </listitem>
67 </itemizedlist>
68 <example id="zend.service.flickr.finding-users.example-1">
69 <title>メールアドレスからの Flickr ユーザの公開している写真の検索</title>
70 <para>
71 この例では、メールアドレスがわかっている Flickr ユーザが公開している写真を
72 <methodname>userSearch()</methodname> メソッドを用いて探します。
73 </para>
74 <programlisting language="php"><![CDATA[
75 $flickr = new Zend_Service_Flickr('MY_API_KEY');
77 $results = $flickr->userSearch($userEmail);
79 foreach ($results as $result) {
80 echo $result->title . '<br />';
81 }
82 ]]></programlisting>
83 </example>
84 </sect2>
85 <sect2 id="zend.service.flickr.grouppoolgetphotos">
86 <title>グループプールからの写真の検索</title>
87 <para>
88 <classname>Zend_Service_Flickr</classname> は、
89 グループにプールされている写真をグループ ID を指定して取得できます。
90 <methodname>groupPoolGetPhotos()</methodname> メソッドを使用します。
91 </para>
92 <example id="zend.service.flickr.grouppoolgetphotos.example-1">
93 <title>グループ ID を指定し、グループにプールされている写真を取得する</title>
94 <programlisting language="php"><![CDATA[
95 $flickr = new Zend_Service_Flickr('MY_API_KEY');
97 $results = $flickr->groupPoolGetPhotos($groupId);
99 foreach ($results as $result) {
100 echo $result->title . '<br />';
101 }
102 ]]></programlisting>
103 </example>
104 <note>
105 <title>オプションのパラメータ</title>
106 <para>
107 <methodname>groupPoolGetPhotos()</methodname> は、オプションの
108 二番目の引数に設定の配列を指定できます。
109 </para>
110 </note>
111 </sect2>
112 <sect2 id="zend.service.flickr.getimagedetails">
113 <title>Flickr 画像の詳細の取得</title>
114 <para>
115 <classname>Zend_Service_Flickr</classname> を使用すると、指定した画像 ID
116 の画像についての詳細情報をすばやく簡単に取得できます。
117 そのためには、以下の例のように単純に
118 <methodname>getImageDetails()</methodname> メソッドを使用します。
119 </para>
120 <example id="zend.service.flickr.getimagedetails.example-1">
121 <title>Flickr 画像の詳細の取得</title>
122 <para>
123 Flickr 画像 ID を使用すると、簡単に画像の情報が取得できます。
124 </para>
125 <programlisting language="php"><![CDATA[
126 $flickr = new Zend_Service_Flickr('MY_API_KEY');
128 $image = $flickr->getImageDetails($imageId);
130 echo "画像 ID $imageId は $image->width x $image->height ピクセルです。<br />\n";
131 echo "<a href=\"$image->clickUri\">クリックすると画像を表示します</a>\n";
132 ]]></programlisting>
133 </example>
134 </sect2>
135 <sect2 id="zend.service.flickr.classes">
136 <title>Zend_Service_Flickr 結果クラス群</title>
137 <para>
138 <methodname>tagSearch()</methodname> あるいは <methodname>userSearch()</methodname>
139 から返されるのは、以下のクラスのいずれかです。
140 <itemizedlist>
141 <listitem><para><link linkend="zend.service.flickr.classes.resultset"><classname>Zend_Service_Flickr_ResultSet</classname></link></para></listitem>
142 <listitem><para><link linkend="zend.service.flickr.classes.result"><classname>Zend_Service_Flickr_Result</classname></link></para></listitem>
143 <listitem><para><link linkend="zend.service.flickr.classes.image"><classname>Zend_Service_Flickr_Image</classname></link></para></listitem>
144 </itemizedlist>
145 </para>
146 <sect3 id="zend.service.flickr.classes.resultset">
147 <title>Zend_Service_Flickr_ResultSet</title>
148 <para>Flickr 検索からの結果セットを表します。</para>
149 <note>
150 <para>
151 操作性を高めるため、<classname>SeekableIterator</classname> インターフェイスを実装しています。
152 これにより、一般的な順次処理 (例えば <methodname>foreach()</methodname> など)
153 だけでなく <methodname>seek()</methodname> を使用した特定の結果への直接アクセスも可能です。
154 </para>
155 </note>
156 <sect4 id="zend.service.flickr.classes.resultset.properties">
157 <title>プロパティ</title>
158 <table id="zend.service.flickr.classes.resultset.properties.table-1">
159 <title>Zend_Service_Flickr_ResultSet のプロパティ</title>
160 <tgroup cols="3">
161 <thead>
162 <row>
163 <entry>名前</entry>
164 <entry>型</entry>
165 <entry>説明</entry>
166 </row>
167 </thead>
168 <tbody>
169 <row>
170 <entry>totalResultsAvailable</entry>
171 <entry>int</entry>
172 <entry>使用可能な結果の総数</entry>
173 </row>
174 <row>
175 <entry>totalResultsReturned</entry>
176 <entry>int</entry>
177 <entry>返された結果の総数</entry>
178 </row>
179 <row>
180 <entry>firstResultPosition</entry>
181 <entry>int</entry>
182 <entry>すべての結果セットの中でのこの結果セットの位置</entry>
183 </row>
184 </tbody>
185 </tgroup>
186 </table>
187 </sect4>
188 <sect4 id="zend.service.flickr.classes.resultset.totalResults">
189 <title>Zend_Service_Flickr_ResultSet::totalResults()</title>
190 <para>
191 <methodsynopsis>
192 <type>int</type>
193 <methodname>totalResults</methodname>
194 <void />
195 </methodsynopsis>
196 </para>
197 <para>
198 この結果セット内の結果の数を返します。
199 </para>
200 <para>
201 <link linkend="zend.service.flickr.classes">クラス一覧に戻る</link>
202 </para>
203 </sect4>
204 </sect3>
205 <sect3 id="zend.service.flickr.classes.result">
206 <title>Zend_Service_Flickr_Result</title>
207 <para>
208 Flickr クエリから返される結果の画像情報を表します。
209 </para>
210 <sect4 id="zend.service.flickr.classes.result.properties">
211 <title>プロパティ</title>
212 <table id="zend.service.flickr.classes.result.properties.table-1">
213 <title>Zend_Service_Flickr_Result のプロパティ</title>
214 <tgroup cols="3">
215 <thead>
216 <row>
217 <entry>名前</entry>
218 <entry>型</entry>
219 <entry>説明</entry>
220 </row>
221 </thead>
222 <tbody>
223 <row>
224 <entry>id</entry>
225 <entry>string</entry>
226 <entry>画像 ID</entry>
227 </row>
228 <row>
229 <entry>owner</entry>
230 <entry>string</entry>
231 <entry>画像の所有者の <acronym>NSID</acronym></entry>
232 </row>
233 <row>
234 <entry>secret</entry>
235 <entry>string</entry>
236 <entry><acronym>URL</acronym> の作成に使用されるキー</entry>
237 </row>
238 <row>
239 <entry>server</entry>
240 <entry>string</entry>
241 <entry><acronym>URL</acronym> の作成に使用されるサーバ名</entry>
242 </row>
243 <row>
244 <entry>title</entry>
245 <entry>string</entry>
246 <entry>写真のタイトル</entry>
247 </row>
248 <row>
249 <entry>ispublic</entry>
250 <entry>string</entry>
251 <entry>写真が公開されているかどうか</entry>
252 </row>
253 <row>
254 <entry>isfriend</entry>
255 <entry>string</entry>
256 <entry>画像の所有者の友達であるかどうか</entry>
257 </row>
258 <row>
259 <entry>isfamily</entry>
260 <entry>string</entry>
261 <entry>画像の所有者の家族であるかどうか</entry>
262 </row>
263 <row>
264 <entry>license</entry>
265 <entry>string</entry>
266 <entry>写真についてのライセンス情報</entry>
267 </row>
268 <row>
269 <entry>dateupload</entry>
270 <entry>string</entry>
271 <entry>写真がアップロードされた日付</entry>
272 </row>
273 <row>
274 <entry>datetaken</entry>
275 <entry>string</entry>
276 <entry>写真が撮影された日付</entry>
277 </row>
278 <row>
279 <entry>ownername</entry>
280 <entry>string</entry>
281 <entry>所有者のスクリーンネーム</entry>
282 </row>
283 <row>
284 <entry>iconserver</entry>
285 <entry>string</entry>
286 <entry>アイコンの <acronym>URL</acronym> を組み立てるために使用するサーバ</entry>
287 </row>
288 <row>
289 <entry>Square</entry>
290 <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
291 <entry>75x75 の、画像のサムネイル</entry>
292 </row>
293 <row>
294 <entry>Thumbnail</entry>
295 <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
296 <entry>100 ピクセルの、画像のサムネイル</entry>
297 </row>
298 <row>
299 <entry>Small</entry>
300 <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
301 <entry>240 ピクセル版の画像</entry>
302 </row>
303 <row>
304 <entry>Medium</entry>
305 <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
306 <entry>500 ピクセル版の画像</entry>
307 </row>
308 <row>
309 <entry>Large</entry>
310 <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
311 <entry>640 ピクセル版の画像</entry>
312 </row>
313 <row>
314 <entry>Original</entry>
315 <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
316 <entry>元の画像</entry>
317 </row>
318 </tbody>
319 </tgroup>
320 </table>
321 <para>
322 <link linkend="zend.service.flickr.classes">クラス一覧に戻る</link>
323 </para>
324 </sect4>
325 </sect3>
326 <sect3 id="zend.service.flickr.classes.image">
327 <title>Zend_Service_Flickr_Image</title>
328 <para>Flickr 検索が返す画像を表します。</para>
329 <sect4 id="zend.service.flickr.classes.image.properties">
330 <title>プロパティ</title>
331 <table id="zend.service.flickr.classes.image.properties.table-1">
332 <title>Zend_Service_Flickr_Image のプロパティ</title>
333 <tgroup cols="3">
334 <thead>
335 <row>
336 <entry>名前</entry>
337 <entry>型</entry>
338 <entry>説明</entry>
339 </row>
340 </thead>
341 <tbody>
342 <row>
343 <entry>uri</entry>
344 <entry>string</entry>
345 <entry>元の画像の <acronym>URI</acronym></entry>
346 </row>
347 <row>
348 <entry>clickUri</entry>
349 <entry>string</entry>
350 <entry>もとの画像 (Flickr のページ) へのリンク用 <acronym>URI</acronym>ac</entry>
351 </row>
352 <row>
353 <entry>width</entry>
354 <entry>int</entry>
355 <entry>画像の幅</entry>
356 </row>
357 <row>
358 <entry>height</entry>
359 <entry>int</entry>
360 <entry>画像の高さ</entry>
361 </row>
362 </tbody>
363 </tgroup>
364 </table>
365 <para>
366 <link linkend="zend.service.flickr.classes">クラス一覧に戻る</link>
367 </para>
368 </sect4>
369 </sect3>
370 </sect2>
371 </sect1>
372 <!--
373 vim:se ts=4 sw=4 et:
374 -->