[ZF-10089] Zend_Log
[zend.git] / documentation / manual / nl / module_specs / Zend_Service_Flickr.xml
blob27b1518c0d16f5647e61eaf9c5cb4d849c3b79fb
1 <sect1 id="zend.service.flickr">
2     <title>Zend_Service_Flickr</title>
3     <sect2 id="zend.service.flickr.introduction">
4         <title>Inleiding voor het zoeken in Flickr</title>
5         <para>
6             <code>Zend_Service_Flickr</code> is een eenvoudige API om de Flickr REST web service te gebruiken. Om de Flickr
7             web services te gebruiken moet je een API key hebben. Om deze te verkrijgen en voor meer informatie over de
8             Flickr REST Web Service, kan je terecht bij de
9             <ulink url="http://www.flickr.com/services/api/">Flickr API documentatie</ulink>.
10         </para>
11         <para>
12             In het volgende voorbeeld gebruiken we de <code>tagSearch()</code> methode om foto's te zoeken die &quot;php&quot; in
13             de tags hebben.
14         </para>
15         <example>
16             <title>Eenvoudige Flickr Photo zoekopdracht</title>
17             <programlisting role="php"><![CDATA[<?php
18 require_once 'Zend/Service/Flickr.php';
20 $flickr = new Zend_Service_Flickr('MY_API_KEY');
22 $results = $flickr->tagSearch("php");
24 foreach ($results as $result) {
25     echo $result->title . '<br />';
27 ?>]]>       </programlisting>
28         </example>
29         <note>
30           <para>
31             <code>tagSearch()</code> aanvaardt een optionele tweede parameter met een array van opties.
32           </para>
33         </note>
34     </sect2>
35     <sect2 id="zend.service.flickr.finding-users">
36         <title>Flickr gebruikers vinden</title>
37         <para>
38             <code>Zend_Service_Flickr</code> biedt drie verschillende mogelijkheden om Flickr gebruikersinformatie
39             te verkrijgen:
40         </para>
41         <itemizedlist>
42             <listitem>
43               <para>
44                 <code>userSearch()</code>: Aanvaardt een string query van spatiegescheiden vermeldingen en een optionele
45                 tweede parameter als een array van zoekopties, en geeft een <code>Zend_Service_Flickr_ResultSet</code>
46                 object terug.
47               </para>
48             </listitem>
49             <listitem>
50               <para>
51                 <code>getIdByUsername()</code>: Geeft een string user ID terug, verbonden met de opgegeven gebruikersnaam string.
52               </para>
53             </listitem>
54             <listitem>
55               <para>
56                 <code>getIdByEmail()</code>: Geeft een string user ID terug, verbonden met de opgegeven gebruikerse-mail string.
57               </para>
58             </listitem>
59         </itemizedlist>
60         <example>
61             <title>Een Flickr gebruiker vinden door middel van zijn e-mailadres</title>
62             <para>
63                 In dit voorbeeld hebben we het e-mailadres van de Flickr gebruiker, en we verkrijgen de gebruikersinformatie
64                 door de <code>userSearch()</code> methode te gebruiken:
65             </para>
66             <programlisting role="php"><![CDATA[<?php
67 require_once 'Zend/Service/Flickr.php';
69 $flickr = new Zend_Service_Flickr('MY_API_KEY');
71 $results = $flickr->userSearch($userEmail);
73 foreach ($results as $result) {
74     echo $result->title . '<br />';
76 ?>]]>       </programlisting>
77         </example>
78     </sect2>
79     <sect2 id="zend.service.flickr.getimagedetails">
80         <title>Flickr beelddetails opvragen</title>
81         <para>
82             <code>Zend_Service_Flickr</code> maakt het snel en eenvoudig om details van een beeld te verkrijgen via zijn ID.
83             Gebruik gewoon de <code>getImageDetails()</code> methode zoals in het volgende voorbeeld:
84         </para>
85         <example>
86             <title>Flickr beelddetails verkrijgen</title>
87             <para>
88                 Wanneer je een Flickr beeld ID hebt is het eenvoudig informatie over dat beeld te verkrijgen:
89             </para>
90             <programlisting role="php"><![CDATA[<?php
91 require_once 'Zend/Service/Flickr.php';
93 $flickr = new Zend_Service_Flickr('MY_API_KEY');
95 $image = $flickr->getImageDetails($imageId);
97 echo "Beeld ID $imageId is $image->width x $image->height pixels.<br />\n";
98 echo "<a href=\"$image->clickUri\">Klik hier voor het beeld</a>\n";
99 ?>]]>       </programlisting>
100         </example>
101     </sect2>
102 <sect2 id="zend.service.flickr.classes">
103     <title>Zend_Service_Flickr Klassen</title>
104     <para>
105         De volgende klassen worden alleen teruggegeven door <code>tagSearch()</code> en <code>userSearch()</code>:
106         <itemizedlist>
107             <listitem><para><link linkend="zend.service.flickr.classes.resultset"><code>Zend_Service_Flickr_ResultSet</code></link></para></listitem>
108             <listitem><para><link linkend="zend.service.flickr.classes.result"><code>Zend_Service_Flickr_Result</code></link></para></listitem>
109             <listitem><para><link linkend="zend.service.flickr.classes.image"><code>Zend_Service_Flickr_Image</code></link></para></listitem>
110         </itemizedlist>
111     </para>
112     <sect3 id="zend.service.flickr.classes.resultset">
113         <title>Zend_Service_Flickr_ResultSet</title>
114         <para>Vertegenwoordigt een set resultaten van een Flickr zoekopdracht.</para>
115         <note>
116             <para>
117                 Implementeert de
118                 <code>SeekableIterator</code>
119                 voor gemakkelijke iteratie (bv., door
120                 <code>foreach</code>
121                 te gebruiken), evenals onmiddellijke toegang tot een specifiek resultaat door
122                 <code>seek()</code> te gebruiken.
123             </para>
124         </note>
125         <sect4 id="zend.service.flickr.classes.resultset.properties">
126             <title>Eigenschappen</title>
127             <table>
128                 <title>Zend_Service_Flickr_ResultSet Eigenschappen</title>
129                 <tgroup cols="3">
130                     <thead>
131                         <row>
132                             <entry>Naam</entry>
133                             <entry>Type</entry>
134                             <entry>Beschrijving</entry>
135                         </row>
136                     </thead>
137                     <tbody>
138                         <row>
139                             <entry>totalResultsAvailable</entry>
140                             <entry>int</entry>
141                             <entry>Totaal aantal beschikbare resultaten</entry>
142                         </row>
143                         <row>
144                             <entry>totalResultsReturned</entry>
145                             <entry>int</entry>
146                             <entry>Totaal aantal teruggestuurde resultaten</entry>
147                         </row>
148                         <row>
149                             <entry>firstResultPosition</entry>
150                             <entry>int</entry>
151                             <entry>De offset in de totale set resultaten van deze set resultaten</entry>
152                         </row>
153                     </tbody>
154                 </tgroup>
155             </table>
156         </sect4>
157         <sect4 id="zend.service.flickr.classes.resultset.totalResults">
158             <title>Zend_Service_Flickr_ResultSet::totalResults()</title>
159             <para>
160                 <methodsynopsis>
161                     <type>int</type>
162                     <methodname>totalResults</methodname>
163                     <void />
164                 </methodsynopsis>
165             </para>
166             <para>
167                 Geeft het totaal aantal resultaten in deze set resultaten terug.
168             </para>
169             <para>
170                 <link linkend="zend.service.flickr.classes">Terug naar de klasselijst</link>
171             </para>
172         </sect4>
173     </sect3>
174     <sect3 id="zend.service.flickr.classes.result">
175         <title>Zend_Service_Flickr_Result</title>
176         <para>
177             Een enkel beeldresultaat van een Flickr zoekopdracht
178         </para>
179         <sect4 id="zend.service.flickr.classes.result.properties">
180             <title>Eigenschappen</title>
181             <table>
182                 <title>Zend_Service_Flickr_Result Eigenschappen</title>
183                 <tgroup cols="3">
184                     <thead>
185                         <row>
186                             <entry>Naam</entry>
187                             <entry>Type</entry>
188                             <entry>Beschrijving</entry>
189                         </row>
190                     </thead>
191                     <tbody>
192                         <row>
193                             <entry>id</entry>
194                             <entry>int</entry>
195                             <entry>Beeld ID</entry>
196                         </row>
197                         <row>
198                             <entry>owner</entry>
199                             <entry>int</entry>
200                             <entry>Het NSID van de eigenaar van de foto.</entry>
201                         </row>
202                         <row>
203                             <entry>secret</entry>
204                             <entry>string</entry>
205                             <entry>Een key gebruikt in het bouwen van een URL.</entry>
206                         </row>
207                         <row>
208                             <entry>server</entry>
209                             <entry>string</entry>
210                             <entry>De servernaam om in het bouwen van een URL te gebruiken.</entry>
211                         </row>
212                         <row>
213                             <entry>title</entry>
214                             <entry>string</entry>
215                             <entry>De titel van de foto.</entry>
216                         </row>
217                         <row>
218                             <entry>ispublic</entry>
219                             <entry>boolean</entry>
220                             <entry>de foto is publiek.</entry>
221                         </row>
222                         <row>
223                             <entry>isfriend</entry>
224                             <entry>boolean</entry>
225                             <entry>Je kan de foto zien omdat je een vriend bent van de eigenaar.</entry>
226                         </row>
227                         <row>
228                             <entry>isfamily</entry>
229                             <entry>boolean</entry>
230                             <entry>Je kan de foto zien omdat je familie bent van de eigenaar.</entry>
231                         </row>
232                         <row>
233                             <entry>license</entry>
234                             <entry>string</entry>
235                             <entry>De licentie waaronder de foto beschikbaar is.</entry>
236                         </row>
237                         <row>
238                             <entry>date_upload</entry>
239                             <entry>string</entry>
240                             <entry>De datum waarop de foto werd geupload.</entry>
241                         </row>
242                         <row>
243                             <entry>date_taken</entry>
244                             <entry>string</entry>
245                             <entry>De datum waarop de foto werd genomen.</entry>
246                         </row>
247                         <row>
248                             <entry>owner_name</entry>
249                             <entry>string</entry>
250                             <entry>De schermnaam van de eigenaar.</entry>
251                         </row>
252                         <row>
253                             <entry>icon_server</entry>
254                             <entry>string</entry>
255                             <entry>De server die gebruikt werd om icon URLs te assembleren.</entry>
256                         </row>
257                         <row>
258                             <entry>Square</entry>
259                             <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
260                             <entry>Een 75x75 thumbnailbeeld.</entry>
261                         </row>
262                         <row>
263                             <entry>Thumbnail</entry>
264                             <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
265                             <entry>Een 100 pixel thumbnailbeeld.</entry>
266                         </row>
267                         <row>
268                             <entry>Small</entry>
269                             <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
270                             <entry>Een 240 pixel thumbnailbeeld.</entry>
271                         </row>
272                         <row>
273                             <entry>Medium</entry>
274                             <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
275                             <entry>Een 500 pixel thumbnailbeeld.</entry>
276                         </row>
277                         <row>
278                             <entry>Large</entry>
279                             <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
280                             <entry>Een 640 pixel thumbnailbeeld.</entry>
281                         </row>
282                         <row>
283                             <entry>Original</entry>
284                             <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
285                             <entry>Het oorspronkelijk beeld.</entry>
286                         </row>
287                     </tbody>
288                 </tgroup>
289             </table>
290             <para>
291                 <link linkend="zend.service.flickr.classes">Terug naar de klasselijst</link>
292             </para>
293         </sect4>
294     </sect3>
295     <sect3 id="zend.service.flickr.classes.image">
296         <title>Zend_Service_Flickr_Image</title>
297         <para>Representeert een beeld teruggegeven door een Flickr zoekopdracht.</para>
298         <sect4 id="zend.service.flickr.classes.image.properties">
299             <title>Eigenschappen</title>
300             <table>
301                 <title>Zend_Service_Flickr_Image Eigenschappen</title>
302                 <tgroup cols="3">
303                     <thead>
304                         <row>
305                             <entry>Naam</entry>
306                             <entry>Type</entry>
307                             <entry>Beschrijving</entry>
308                         </row>
309                     </thead>
310                     <tbody>
311                         <row>
312                             <entry>uri</entry>
313                             <entry>string</entry>
314                             <entry>URI voor het oorspronkelijk beeld</entry>
315                         </row>
316                         <row>
317                             <entry>clickUri</entry>
318                             <entry>string</entry>
319                             <entry>Een klikbaar URI (bv. de Flickr pagina) voor het beeld</entry>
320                         </row>
321                         <row>
322                             <entry>width</entry>
323                             <entry>int</entry>
324                             <entry>Breedte van het beeld</entry>
325                         </row>
326                         <row>
327                             <entry>height</entry>
328                             <entry>int</entry>
329                             <entry>Hoogte van het beeld</entry>
330                         </row>
331                     </tbody>
332                 </tgroup>
333             </table>
334             <para>
335                 <link linkend="zend.service.flickr.classes">Terug naar de klasselijst</link>
336             </para>
337         </sect4>
338     </sect3>
339 </sect2>
340 </sect1>
341 <!--
342 vim:se ts=4 sw=4 et: