File: Zend_Service_Flickr.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (521 lines) | stat: -rw-r--r-- 20,451 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
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
514
515
516
517
518
519
520
521
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.service.flickr">
    <title>Zend_Service_Flickr</title>

    <sect2 id="zend.service.flickr.introduction">
        <title>Einführung</title>

        <para>
            <classname>Zend_Service_Flickr</classname> ist eine einfache <acronym>API</acronym> um
            den Flickr REST Web Service zu nutzen. Für die Benutzung des Flickr Web Service,
            benötigt man einen <acronym>API</acronym> Schlüssel. Um diesen Schlüssel zu bekommen und
            für weitergehende Informationen über den Flickr REST Web Service besuchen Sie bitte die
            <ulink url="http://www.flickr.com/services/api/">Flickr <acronym>API</acronym>
                Dokumentation</ulink>.
        </para>

        <para>
            Im folgenden Bespiel benutzen wir die <methodname>tagSearch()</methodname> Methode um
            Photos zu suchen welche "php" im Tag haben.
        </para>

        <example id="zend.service.flickr.introduction.example-1">
            <title>Simple Flickr Photo Suche</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>Optionale Parameter</title>

            <para>
                <methodname>tagSearch()</methodname> aktepziert als optionalen zweiten Parameter ein
                Array mit Optionen.
            </para>
        </note>
    </sect2>

    <sect2 id="zend.service.flickr.finding-users">
        <title>Bilder und Informationen von Flickr Benutzern finden</title>

        <para>
            <classname>Zend_Service_Flickr</classname> stellt verschiedene unterschiedliche Wege zur
            Verfügung um Informationen von Flickr Benutzern zu bekommen:
        </para>

        <itemizedlist>
            <listitem>
                <para>
                    <methodname>userSearch()</methodname>: Akzeptiert ein String Abfrage von mit
                    Leerzeichen getrennten Tags und als optionalen zweiten Parameter ein Array mit
                    Such Optionen. Zurückgegeben wird ein Set von Photos als
                    <classname>Zend_Service_Flickr_ResultSet</classname> Objekt.
                </para>
            </listitem>

            <listitem>
                <para>
                    <methodname>getIdByUsername()</methodname>: Gibt die Benutzer ID als String
                    zurück, welcher mit dem übergebenen String des Benutzernamens verknüpft ist.
                </para>
            </listitem>

            <listitem>
                <para>
                    <methodname>getIdByEmail()</methodname>: Gibt die Benutzer ID als String zurück,
                    welcher mit dem übergebenen String der Email Adresse verknüpft ist.
                </para>
            </listitem>
        </itemizedlist>

        <example id="zend.service.flickr.finding-users.example-1">
            <title>
                Finden von öffentlichen Photos eines Flickr Benutzers durch seine E-Mail Adresse
            </title>

            <para>
                In diesem Beispiel haben wir die E-Mail adresse eines Flickr Benutzers und wir holen
                uns die öffentlichen Photos eines Benutzer durch Verwendung der
                <methodname>userSearch()</methodname> Methode:
            </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>Photos in einem Gruppenpool finden</title>

        <para>
            <classname>Zend_Service_Flickr</classname> erlaubt es Photos eines Gruppenpools
            basierend auf der ID zu empfangen. Hierfür kann die
            <methodname>groupPoolGetPhotos()</methodname> Methode verwendet werden:
        </para>

        <example id="zend.service.flickr.grouppoolgetphotos.example-1">
            <title>Empfangen von Photos aus einem Gruppenpool durch die Gruppen 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>Optionale Parameter</title>

            <para>
                <methodname>groupPoolGetPhotos()</methodname> akzeptiert einen optionalen zweiten
                Parameter als ein Array von Optionen.
            </para>
        </note>
    </sect2>

    <sect2 id="zend.service.flickr.getimagedetails">
        <title>Empfangen von Details zu Bildern durch Flickr</title>

        <para>
            <classname>Zend_Service_Flickr</classname> erlaubt es schnell und einfach an Details zu
            Bilders zu kommen, basieren auf einer übergebenen ID des Bildes. Einfach durch benutzen
            der <methodname>getImageDetails()</methodname> Methode, wie im folgenden Beispiel:
        </para>

        <example id="zend.service.flickr.getimagedetails.example-1">
            <title>Empfangen von Details zu Bildern durch Flickr</title>

            <para>
                Sobald man eine Flickr Bild ID hat, ist es eine einfache Angelegenheit,
                Informationen über ein Bild zu bekommen:
            </para>

            <programlisting language="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');
$image = $flickr->getImageDetails($imageId);

echo "Bild ID $imageId ist $image->width x $image->height Pixel groß.<br />\n";
echo "<a href=\"$image->clickUri\">Klicken für das Bild</a>\n";
]]></programlisting>
        </example>
    </sect2>

    <sect2 id="zend.service.flickr.classes">
        <title>Zend_Service_Flickr Ergebnis Klassen</title>

        <para>
            Die folgenden Klassen werden durch <methodname>tagSearch()</methodname> und
            <methodname>userSearch()</methodname> zurückgegeben:

            <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>Repräsentiert ein Set von Ergebnissen von einer Flickr Suche.</para>

            <note>
                <para>
                    Implementiert das <classname>SeekableIterator</classname> Interface für einfache
                    Iteration (z.B. benutzen von <methodname>foreach()</methodname>), sowie einen
                    direkten Zugriff auf ein spezielles Ergebnis durch Benutzen von
                    <methodname>seek()</methodname>.
                </para>
            </note>

            <sect4 id="zend.service.flickr.classes.resultset.properties">
                <title>Eigenschaften</title>

                <table id="zend.service.flickr.classes.resultset.properties.table-1">
                    <title>Zend_Service_Flickr_ResultSet Eigenschaften</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Typ</entry>
                                <entry>Beschreibung</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>totalResultsAvailable</entry>
                                <entry>int</entry>
                                <entry>Gesamt Anzahl aller gefundenen Ergebnisse</entry>
                            </row>

                            <row>
                                <entry>totalResultsReturned</entry>
                                <entry>int</entry>
                                <entry>Gesamt Anzahl der zurückgegebenen Ergebnisse</entry>
                            </row>

                            <row>
                                <entry>firstResultPosition</entry>
                                <entry>int</entry>
                                <entry>Das Offset im Gesamtergebnis für dieses Ergebnis 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>
                    Gibt die Gesamt Anzahl der Ergebnisse für dieses Ergebnis Set zurück.
                </para>

                <para>
                    <link linkend="zend.service.flickr.classes">Zurück zur Liste der Klassen</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.flickr.classes.result">
            <title>Zend_Service_Flickr_Result</title>

            <para>
                Ein einzelnes Bild Ergebnis von einer Flickr Suche
            </para>

            <sect4 id="zend.service.flickr.classes.result.properties">
                <title>Eigenschaften</title>

                <table id="zend.service.flickr.classes.result.properties.table-1">
                    <title>Zend_Service_Flickr_Result Eigenschaften</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Typ</entry>
                                <entry>Beschreibung</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>id</entry>
                                <entry>string</entry>
                                <entry>Image ID</entry>
                            </row>

                            <row>
                                <entry>owner</entry>
                                <entry>string</entry>

                                <entry>
                                    Die <acronym>NSID</acronym> des Eigentümers des Photos.
                                </entry>
                            </row>

                            <row>
                                <entry>secret</entry>
                                <entry>string</entry>

                                <entry>
                                    Ein Schlüssel welcher beim <acronym>URL</acronym> Aufbau benutzt
                                    wird.
                                </entry>
                            </row>

                            <row>
                                <entry>server</entry>
                                <entry>string</entry>

                                <entry>
                                    Der Servername welcher beim <acronym>URL</acronym> Aufbau
                                    benutzt wird.
                                </entry>
                            </row>

                            <row>
                                <entry>title</entry>
                                <entry>string</entry>
                                <entry>Die Überschrift des Bildes.</entry>
                            </row>

                            <row>
                                <entry>ispublic</entry>
                                <entry>string</entry>
                                <entry>Ist das Bild öffentlich ?</entry>
                            </row>

                            <row>
                                <entry>isfriend</entry>
                                <entry>string</entry>

                                <entry>
                                    Das Bild ist sichtbar, weil man ein Freund des Eigentümers ist.
                                </entry>
                            </row>

                            <row>
                                <entry>isfamily</entry>
                                <entry>string</entry>

                                <entry>
                                    Das Bild ist sichtbar, weil man Familienmitglied des Eigentümers
                                    ist.
                                </entry>
                            </row>

                            <row>
                                <entry>license</entry>
                                <entry>string</entry>
                                <entry>Die Lizenz des Bildes ist erreichbar unter.</entry>
                            </row>

                            <row>
                                <entry>dateupload</entry>
                                <entry>string</entry>
                                <entry>Das Datum an dem das Bild hochgeladen wurde.</entry>
                            </row>

                            <row>
                                <entry>datetaken</entry>
                                <entry>string</entry>
                                <entry>Das Datum an dem das Bild gemacht wurde.</entry>
                            </row>

                            <row>
                                <entry>ownername</entry>
                                <entry>string</entry>
                                <entry>Der Bildschirmname des Eigentümers.</entry>
                            </row>

                            <row>
                                <entry>iconserver</entry>
                                <entry>string</entry>

                                <entry>
                                    Der Server welcher benutzt wurde um die Icon
                                    <acronym>URL</acronym> zu erstellen.
                                </entry>
                            </row>

                            <row>
                                <entry>Square</entry>

                                <entry>
                                    <link
                                        linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
                                </entry>

                                <entry>Ein 75x75 Thumbnail des Bildes.</entry>
                            </row>

                            <row>
                                <entry>Thumbnail</entry>

                                <entry>
                                    <link
                                        linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
                                </entry>

                                <entry>Ein 100 Pixel Thumbnail des Bildes.</entry>
                            </row>

                            <row>
                                <entry>Small</entry>

                                <entry>
                                    <link
                                        linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
                                </entry>

                                <entry>Eine 240 Pixel Version des Bildes.</entry>
                            </row>

                            <row>
                                <entry>Medium</entry>

                                <entry>
                                    <link
                                        linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
                                </entry>

                                <entry>Eine 500 Pixel Version des Bildes.</entry>
                            </row>

                            <row>
                                <entry>Large</entry>

                                <entry>
                                    <link
                                        linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
                                </entry>

                                <entry>Eine 640 Pixel Version des Bildes.</entry>
                            </row>

                            <row>
                                <entry>Original</entry>

                                <entry>
                                    <link
                                        linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
                                </entry>

                                <entry>Das Original Bild.</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.flickr.classes">Zurück zur Liste der Klassen</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.flickr.classes.image">
            <title>Zend_Service_Flickr_Image</title>
            <para>Repräsentiert ein Bild welches durch eine Flickr Suche zurückgegeben wird.</para>

            <sect4 id="zend.service.flickr.classes.image.properties">
                <title>Eigenschaften</title>

                <table id="zend.service.flickr.classes.image.properties.table-1">
                    <title>Zend_Service_Flickr_Image Eigenschaften</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Typ</entry>
                                <entry>Beschreibung</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>uri</entry>
                                <entry>string</entry>
                                <entry>URI des Original Bildes</entry>
                            </row>

                            <row>
                                <entry>clickUri</entry>
                                <entry>string</entry>

                                <entry>
                                    Klickbare <acronym>URI</acronym> (z.B. die Flickr Seite) für das
                                    Bild
                                </entry>
                            </row>

                            <row>
                                <entry>width</entry>
                                <entry>int</entry>
                                <entry>Breite des Bildes</entry>
                            </row>

                            <row>
                                <entry>height</entry>
                                <entry>int</entry>
                                <entry>Höhe des Bildes</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.flickr.classes">Zurück zur Liste der Klassen</link>
                </para>
            </sect4>
        </sect3>
    </sect2>
</sect1>