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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.service.flickr">
<title>Zend_Service_Flickr</title>
<sect2 id="zend.service.flickr.introduction">
<title>Introduction</title>
<para>
<classname>Zend_Service_Flickr</classname> is a simple <acronym>API</acronym> for using
the Flickr REST Web Service. In order to use the Flickr web services, you must have an
<acronym>API</acronym> key. To obtain a key and for more information about the Flickr
REST Web Service, please visit the <ulink
url="http://www.flickr.com/services/api/">Flickr <acronym>API</acronym>
Documentation</ulink>.
</para>
<para>
In the following example, we use the <methodname>tagSearch()</methodname> method to
search for photos having "php" in the tags.
</para>
<example id="zend.service.flickr.introduction.example-1">
<title>Simple Flickr Photo Search</title>
<programlisting language="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');
$results = $flickr->tagSearch("php");
foreach ($results as $result) {
echo $result->title . '<br />';
}
]]></programlisting>
</example>
<note>
<title>Optional parameter</title>
<para>
<methodname>tagSearch()</methodname> accepts an optional second parameter as an
array of options.
</para>
</note>
</sect2>
<sect2 id="zend.service.flickr.finding-users">
<title>Finding Flickr Users' Photos and Information</title>
<para>
<classname>Zend_Service_Flickr</classname> provides several ways to get information
about Flickr users:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>userSearch()</methodname>: Accepts a string query of space-delimited
tags and an optional second parameter as an array of search options, and returns
a set of photos as a <classname>Zend_Service_Flickr_ResultSet</classname>
object.
</para>
</listitem>
<listitem>
<para>
<methodname>getIdByUsername()</methodname>: Returns a string user ID associated
with the given username string.
</para>
</listitem>
<listitem>
<para>
<methodname>getIdByEmail()</methodname>: Returns a string user ID associated
with the given email address string.
</para>
</listitem>
</itemizedlist>
<example id="zend.service.flickr.finding-users.example-1">
<title>Finding a Flickr User's Public Photos by E-Mail Address</title>
<para>
In this example, we have a Flickr user's e-mail address, and we search for the
user's public photos by using the <methodname>userSearch()</methodname> method:
</para>
<programlisting language="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');
$results = $flickr->userSearch($userEmail);
foreach ($results as $result) {
echo $result->title . '<br />';
}
]]></programlisting>
</example>
</sect2>
<sect2 id="zend.service.flickr.grouppoolgetphotos">
<title>Finding photos From a Group Pool</title>
<para>
<classname>Zend_Service_Flickr</classname> allows to retrieve a group's pool photos
based on the group ID. Use the <methodname>groupPoolGetPhotos()</methodname> method:
</para>
<example id="zend.service.flickr.grouppoolgetphotos.example-1">
<title>Retrieving a Group's Pool Photos by Group ID</title>
<programlisting language="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');
$results = $flickr->groupPoolGetPhotos($groupId);
foreach ($results as $result) {
echo $result->title . '<br />';
}
]]></programlisting>
</example>
<note>
<title>Optional parameter</title>
<para>
<methodname>groupPoolGetPhotos()</methodname> accepts an optional second parameter
as an array of options.
</para>
</note>
</sect2>
<sect2 id="zend.service.flickr.getimagedetails">
<title>Retrieving Flickr Image Details</title>
<para>
<classname>Zend_Service_Flickr</classname> makes it quick and easy to get an image's
details based on a given image ID. Just use the
<methodname>getImageDetails()</methodname> method, as in the following example:
</para>
<example id="zend.service.flickr.getimagedetails.example-1">
<title>Retrieving Flickr Image Details</title>
<para>
Once you have a Flickr image ID, it is a simple matter to fetch information about
the image:
</para>
<programlisting language="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');
$image = $flickr->getImageDetails($imageId);
echo "Image ID $imageId is $image->width x $image->height pixels.<br />\n";
echo "<a href=\"$image->clickUri\">Click for Image</a>\n";
]]></programlisting>
</example>
</sect2>
<sect2 id="zend.service.flickr.classes">
<title>Zend_Service_Flickr Result Classes</title>
<para>
The following classes are all returned by <methodname>tagSearch()</methodname> and
<methodname>userSearch()</methodname>:
<itemizedlist>
<listitem>
<para>
<link
linkend="zend.service.flickr.classes.resultset"><classname>Zend_Service_Flickr_ResultSet</classname></link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="zend.service.flickr.classes.result"><classname>Zend_Service_Flickr_Result</classname></link>
</para>
</listitem>
<listitem>
<para>
<link
linkend="zend.service.flickr.classes.image"><classname>Zend_Service_Flickr_Image</classname></link>
</para>
</listitem>
</itemizedlist>
</para>
<sect3 id="zend.service.flickr.classes.resultset">
<title>Zend_Service_Flickr_ResultSet</title>
<para>Represents a set of Results from a Flickr search.</para>
<note>
<para>
Implements the <classname>SeekableIterator</classname> interface for easy
iteration (e.g., using <methodname>foreach()</methodname>), as well as direct
access to a specific result using <methodname>seek()</methodname>.
</para>
</note>
<sect4 id="zend.service.flickr.classes.resultset.properties">
<title>Properties</title>
<table id="zend.service.flickr.classes.resultset.properties.table-1">
<title>Zend_Service_Flickr_ResultSet Properties</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>totalResultsAvailable</entry>
<entry>int</entry>
<entry>Total Number of Results available</entry>
</row>
<row>
<entry>totalResultsReturned</entry>
<entry>int</entry>
<entry>Total Number of Results returned</entry>
</row>
<row>
<entry>firstResultPosition</entry>
<entry>int</entry>
<entry>The offset in the total result set of this result set</entry>
</row>
</tbody>
</tgroup>
</table>
</sect4>
<sect4 id="zend.service.flickr.classes.resultset.totalResults">
<title>Zend_Service_Flickr_ResultSet::totalResults()</title>
<para>
<methodsynopsis>
<type>int</type>
<methodname>totalResults</methodname>
<void />
</methodsynopsis>
</para>
<para>
Returns the total number of results in this result set.
</para>
<para>
<link linkend="zend.service.flickr.classes">Back to Class List</link>
</para>
</sect4>
</sect3>
<sect3 id="zend.service.flickr.classes.result">
<title>Zend_Service_Flickr_Result</title>
<para>
A single Image result from a Flickr query
</para>
<sect4 id="zend.service.flickr.classes.result.properties">
<title>Properties</title>
<table id="zend.service.flickr.classes.result.properties.table-1">
<title>Zend_Service_Flickr_Result Properties</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>id</entry>
<entry>string</entry>
<entry>Image ID</entry>
</row>
<row>
<entry>owner</entry>
<entry>string</entry>
<entry>The photo owner's <acronym>NSID</acronym>.</entry>
</row>
<row>
<entry>secret</entry>
<entry>string</entry>
<entry>A key used in url construction.</entry>
</row>
<row>
<entry>server</entry>
<entry>string</entry>
<entry>
The servername to use for <acronym>URL</acronym> construction.
</entry>
</row>
<row>
<entry>title</entry>
<entry>string</entry>
<entry>The photo's title.</entry>
</row>
<row>
<entry>ispublic</entry>
<entry>string</entry>
<entry>The photo is public.</entry>
</row>
<row>
<entry>isfriend</entry>
<entry>string</entry>
<entry>
The photo is visible to you because you are a friend of the
owner.
</entry>
</row>
<row>
<entry>isfamily</entry>
<entry>string</entry>
<entry>
The photo is visible to you because you are family of the owner.
</entry>
</row>
<row>
<entry>license</entry>
<entry>string</entry>
<entry>The license the photo is available under.</entry>
</row>
<row>
<entry>dateupload</entry>
<entry>string</entry>
<entry>The date the photo was uploaded.</entry>
</row>
<row>
<entry>datetaken</entry>
<entry>string</entry>
<entry>The date the photo was taken.</entry>
</row>
<row>
<entry>ownername</entry>
<entry>string</entry>
<entry>The screenname of the owner.</entry>
</row>
<row>
<entry>iconserver</entry>
<entry>string</entry>
<entry>
The server used in assembling icon <acronym>URL</acronym>s.
</entry>
</row>
<row>
<entry>Square</entry>
<entry>
<link
linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
</entry>
<entry>A 75x75 thumbnail of the image.</entry>
</row>
<row>
<entry>Thumbnail</entry>
<entry>
<link
linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
</entry>
<entry>A 100 pixel thumbnail of the image.</entry>
</row>
<row>
<entry>Small</entry>
<entry>
<link
linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
</entry>
<entry>A 240 pixel version of the image.</entry>
</row>
<row>
<entry>Medium</entry>
<entry>
<link
linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
</entry>
<entry>A 500 pixel version of the image.</entry>
</row>
<row>
<entry>Large</entry>
<entry>
<link
linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
</entry>
<entry>A 640 pixel version of the image.</entry>
</row>
<row>
<entry>Original</entry>
<entry>
<link
linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
</entry>
<entry>The original image.</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
<link linkend="zend.service.flickr.classes">Back to Class List</link>
</para>
</sect4>
</sect3>
<sect3 id="zend.service.flickr.classes.image">
<title>Zend_Service_Flickr_Image</title>
<para>Represents an Image returned by a Flickr search.</para>
<sect4 id="zend.service.flickr.classes.image.properties">
<title>Properties</title>
<table id="zend.service.flickr.classes.image.properties.table-1">
<title>Zend_Service_Flickr_Image Properties</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>uri</entry>
<entry>string</entry>
<entry>URI for the original image</entry>
</row>
<row>
<entry>clickUri</entry>
<entry>string</entry>
<entry>
Clickable <acronym>URI</acronym> (i.e. the Flickr page) for the
image
</entry>
</row>
<row>
<entry>width</entry>
<entry>int</entry>
<entry>Width of the Image</entry>
</row>
<row>
<entry>height</entry>
<entry>int</entry>
<entry>Height of the Image</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
<link linkend="zend.service.flickr.classes">Back to Class List</link>
</para>
</sect4>
</sect3>
</sect2>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->
|
