Zend_Service_Flickr.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  1. <sect1 id="zend.service.flickr">
  2. <title>Zend_Service_Flickr</title>
  3. <sect2 id="zend.service.flickr.introduction">
  4. <title>Wprowadzenie do przeszukiwania Flickr</title>
  5. <para>
  6. <code>Zend_Service_Flickr</code> jest prostym API do użycia z serwisem
  7. Flickr REST Web Service. W celu użycia web serwisów Flickr, musisz
  8. posiadać klucz API. Aby zdoby klucz i uzyskać więcej informacji o
  9. Flickr REST Web Service, odwiedź
  10. <ulink url="http://www.flickr.com/services/api/">dokumentację Flickr API</ulink>.
  11. </para>
  12. <para>
  13. W poniższym przykladzie, używamy metody <code>tagSearch()</code> do
  14. wyszukiwania zdjęć zawierających etykietę "php".
  15. </para>
  16. <example id="zend.service.flickr.introduction.example-1">
  17. <title>Proste wyszukiwanie zdjęć Flickr</title>
  18. <programlisting role="php"><![CDATA[
  19. $flickr = new Zend_Service_Flickr('MY_API_KEY');
  20. $results = $flickr->tagSearch("php");
  21. foreach ($results as $result) {
  22. echo $result->title . '<br />';
  23. }
  24. ]]>
  25. </programlisting>
  26. </example>
  27. <note>
  28. <title>Opcjonalny parametr</title>
  29. <para>
  30. Metoda <code>tagSearch()</code> akceptuje tablicę opcji jako
  31. opcjonalny drugi parametr.
  32. </para>
  33. </note>
  34. </sect2>
  35. <sect2 id="zend.service.flickr.finding-users">
  36. <title>Wyszukiwanie zdjęć użytkowników Flickr i informacji o nich</title>
  37. <para>
  38. Klasa <code>Zend_Service_Flickr</code> zapewnia kilka możliwości
  39. pobierania informacji o użytkownikach serwisu Flickr:
  40. </para>
  41. <itemizedlist>
  42. <listitem>
  43. <para>
  44. <code>userSearch()</code>: akceptuje w parametrze treść
  45. zapytania w postaci etykiet oddzielonych spacją oraz tablicę
  46. opcji wyszukiwania jako opcjonalny drugi parametr, a zwraca
  47. zestaw zdjęć jako obiekt
  48. <code>Zend_Service_Flickr_ResultSet</code>.
  49. </para>
  50. </listitem>
  51. <listitem>
  52. <para>
  53. <code>getIdByUsername()</code>: Zwraca ID użytkownika powiązane
  54. z podaną nazwą użytkownika.
  55. </para>
  56. </listitem>
  57. <listitem>
  58. <para>
  59. <code>getIdByEmail()</code>:Zwraca ID użytkownika powiązane z
  60. podanym adresem email.
  61. </para>
  62. </listitem>
  63. </itemizedlist>
  64. <example id="zend.service.flickr.finding-users.example-1">
  65. <title>Wyszukiwanie publicznych zdjęć użytkownika serwisu Flickr na podstawie adresu e-mail</title>
  66. <para>
  67. W tym przykładzie, posiadamy adres e-mail użytkownika serwisu
  68. Flickr i szukamy publicznych zdjęć użytkownika używając metody
  69. <code>userSearch()</code>:
  70. </para>
  71. <programlisting role="php"><![CDATA[
  72. $flickr = new Zend_Service_Flickr('MY_API_KEY');
  73. $results = $flickr->userSearch($userEmail);
  74. foreach ($results as $result) {
  75. echo $result->title . '<br />';
  76. }
  77. ]]>
  78. </programlisting>
  79. </example>
  80. </sect2>
  81. <sect2 id="zend.service.flickr.grouppoolgetphotos">
  82. <title>Wyszukiwanie zdjęć w Group Pool</title>
  83. <para>
  84. Klasa <code>Zend_Service_Flickr</code> pozwala na pobieranie
  85. zdjęć grupy w oparciu o jej ID. Użyj metody
  86. <code>groupPoolGetPhotos()</code>:
  87. </para>
  88. <example id="zend.service.flickr.grouppoolgetphotos.example-1">
  89. <title>Pobieranie zdjęć z Group Pool na podstawie ID grupy:</title>
  90. <programlisting role="php"><![CDATA[
  91. $flickr = new Zend_Service_Flickr('MY_API_KEY');
  92. $results = $flickr->groupPoolGetPhotos($groupId);
  93. foreach ($results as $result) {
  94. echo $result->title . '<br />';
  95. }
  96. ]]>
  97. </programlisting>
  98. </example>
  99. <note>
  100. <title>Opcjonalny parametr</title>
  101. <para>
  102. Metoda <code>groupPoolGetPhotos()</code> akceptuje opcjonalny
  103. drugi parametr będący tablicą opcji.
  104. </para>
  105. </note>
  106. </sect2>
  107. <sect2 id="zend.service.flickr.getimagedetails">
  108. <title>Pobieranie szczegółów zdjęcia Flickr</title>
  109. <para>
  110. <code>Zend_Service_Flickr</code> ułatwia pobieranie informacji o
  111. zdjęciu na podstawie podanego ID zdjęcia. Po prostu użyj metody
  112. <code>getImageDetails()</code>, tak jak w poniższym przykładzie:
  113. </para>
  114. <example id="zend.service.flickr.getimagedetails.example-1">
  115. <title>Pobieranie szczegółów zdjęcia Flickr</title>
  116. <para>
  117. Jeśli posiadasz ID zdjęcia Flickr, pobranie informacji o zdjęciu
  118. jest bardzo proste:
  119. </para>
  120. <programlisting role="php"><![CDATA[
  121. $flickr = new Zend_Service_Flickr('MY_API_KEY');
  122. $image = $flickr->getImageDetails($imageId);
  123. echo "Obrazek o ID $imageId ma rozmiar $image->width x $image->height pikseli.<br />\n";
  124. echo "<a href=\"$image->clickUri\">Click for Image</a>\n";
  125. ]]>
  126. </programlisting>
  127. </example>
  128. </sect2>
  129. <sect2 id="zend.service.flickr.classes">
  130. <title>Klasy wyników Zend_Service_Flickr</title>
  131. <para>
  132. Poniższe klasy są zwracane przez metody <code>tagSearch()</code> oraz <code>userSearch()</code>:
  133. <itemizedlist>
  134. <listitem><para><link linkend="zend.service.flickr.classes.resultset"><code>Zend_Service_Flickr_ResultSet</code></link></para></listitem>
  135. <listitem><para><link linkend="zend.service.flickr.classes.result"><code>Zend_Service_Flickr_Result</code></link></para></listitem>
  136. <listitem><para><link linkend="zend.service.flickr.classes.image"><code>Zend_Service_Flickr_Image</code></link></para></listitem>
  137. </itemizedlist>
  138. </para>
  139. <sect3 id="zend.service.flickr.classes.resultset">
  140. <title>Zend_Service_Flickr_ResultSet</title>
  141. <para>Reprezentuje zestaw wyników wysuzkiwania Flickr.</para>
  142. <note>
  143. <para>
  144. Implementuje interfejs <code>SeekableIterator</code>
  145. dla łatwej iteracji (np., używając <code>foreach</code>),
  146. tak samo jak i dla bezpośredniego dostępu do specyficznego
  147. wyniku używając metody <code>seek()</code>.
  148. </para>
  149. </note>
  150. <sect4 id="zend.service.flickr.classes.resultset.properties">
  151. <title>Właściwości</title>
  152. <table id="zend.service.flickr.classes.resultset.properties.table-1">
  153. <title>Właściwości Zend_Service_Flickr_ResultSet</title>
  154. <tgroup cols="3">
  155. <thead>
  156. <row>
  157. <entry>Nazwa</entry>
  158. <entry>Typ</entry>
  159. <entry>Opis</entry>
  160. </row>
  161. </thead>
  162. <tbody>
  163. <row>
  164. <entry>totalResultsAvailable</entry>
  165. <entry>int</entry>
  166. <entry>Całkowita ilość dostępnych wyników wyszukiwania</entry>
  167. </row>
  168. <row>
  169. <entry>totalResultsReturned</entry>
  170. <entry>int</entry>
  171. <entry>Całkowita ilość zwróconych wyników wyszukiwania</entry>
  172. </row>
  173. <row>
  174. <entry>firstResultPosition</entry>
  175. <entry>int</entry>
  176. <entry>Pozycja obecnego zestawu wyników we wszystkich wynikach</entry>
  177. </row>
  178. </tbody>
  179. </tgroup>
  180. </table>
  181. </sect4>
  182. <sect4 id="zend.service.flickr.classes.resultset.totalResults">
  183. <title>Zend_Service_Flickr_ResultSet::totalResults()</title>
  184. <para>
  185. <methodsynopsis>
  186. <type>int</type>
  187. <methodname>totalResults</methodname>
  188. <void />
  189. </methodsynopsis>
  190. </para>
  191. <para>
  192. Zwraca całkowitą ilość wyników w tym zestawie wyników wyszukiwania.
  193. </para>
  194. <para>
  195. <link linkend="zend.service.flickr.classes">Powrót do listy klas</link>
  196. </para>
  197. </sect4>
  198. </sect3>
  199. <sect3 id="zend.service.flickr.classes.result">
  200. <title>Zend_Service_Flickr_Result</title>
  201. <para>
  202. Pojedynczy wynik wyszukiwania zdjęcia w serwisie Flickr
  203. </para>
  204. <sect4 id="zend.service.flickr.classes.result.properties">
  205. <title>Właściwości</title>
  206. <table id="zend.service.flickr.classes.result.properties.table-1">
  207. <title>Właściwości Zend_Service_Flickr_Result</title>
  208. <tgroup cols="3">
  209. <thead>
  210. <row>
  211. <entry>Nazwa</entry>
  212. <entry>Typ</entry>
  213. <entry>Opis</entry>
  214. </row>
  215. </thead>
  216. <tbody>
  217. <row>
  218. <entry>id</entry>
  219. <entry>string</entry>
  220. <entry>ID zdjęcia</entry>
  221. </row>
  222. <row>
  223. <entry>owner</entry>
  224. <entry>string</entry>
  225. <entry>Identyfikator NSID właściciela zdjęcia.</entry>
  226. </row>
  227. <row>
  228. <entry>secret</entry>
  229. <entry>string</entry>
  230. <entry>Klucz używany w konstrukcji URL.</entry>
  231. </row>
  232. <row>
  233. <entry>server</entry>
  234. <entry>string</entry>
  235. <entry>Nazwa serwera używana w konstrukcji URL.</entry>
  236. </row>
  237. <row>
  238. <entry>title</entry>
  239. <entry>string</entry>
  240. <entry>Tytuł zdjęcia.</entry>
  241. </row>
  242. <row>
  243. <entry>ispublic</entry>
  244. <entry>string</entry>
  245. <entry>Czy zdjęcie jest publiczne.</entry>
  246. </row>
  247. <row>
  248. <entry>isfriend</entry>
  249. <entry>string</entry>
  250. <entry>Czy zdjęcie jest dla Ciebie widoczne ponieważ jesteś przyjacielem właściciela.</entry>
  251. </row>
  252. <row>
  253. <entry>isfamily</entry>
  254. <entry>string</entry>
  255. <entry>Czy zdjęcie jest dla Ciebie widoczne ponieważ jesteś rodziną właściciela.</entry>
  256. </row>
  257. <row>
  258. <entry>license</entry>
  259. <entry>string</entry>
  260. <entry>Licencja pod jaką dostępne jest zdjęcie.</entry>
  261. </row>
  262. <row>
  263. <entry>dateupload</entry>
  264. <entry>string</entry>
  265. <entry>Data wgrania zdjęcia.</entry>
  266. </row>
  267. <row>
  268. <entry>datetaken</entry>
  269. <entry>string</entry>
  270. <entry>Data zrobienia zdjęcia.</entry>
  271. </row>
  272. <row>
  273. <entry>ownername</entry>
  274. <entry>string</entry>
  275. <entry>Wyświetlana nazwa użytkownika.</entry>
  276. </row>
  277. <row>
  278. <entry>iconserver</entry>
  279. <entry>string</entry>
  280. <entry>Serwer używany przy dołączaniu adresów URL ikon.</entry>
  281. </row>
  282. <row>
  283. <entry>Square</entry>
  284. <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
  285. <entry>Miniaturka zdjęcia o wielkości 75x75.</entry>
  286. </row>
  287. <row>
  288. <entry>Thumbnail</entry>
  289. <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
  290. <entry>Miniaturka zdjęcia o wielkości 100 pikseli.</entry>
  291. </row>
  292. <row>
  293. <entry>Small</entry>
  294. <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
  295. <entry>Wersja zdjęcia o wielkości 240 pikseli.</entry>
  296. </row>
  297. <row>
  298. <entry>Medium</entry>
  299. <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
  300. <entry>Wersja zdjęcia o wielkości 500 pikseli.</entry>
  301. </row>
  302. <row>
  303. <entry>Large</entry>
  304. <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
  305. <entry>Wersja zdjęcia o wielkości 640 pikseli.</entry>
  306. </row>
  307. <row>
  308. <entry>Original</entry>
  309. <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
  310. <entry>Oryginalne zdjęcie.</entry>
  311. </row>
  312. </tbody>
  313. </tgroup>
  314. </table>
  315. <para>
  316. <link linkend="zend.service.flickr.classes">Powrót do listy klas</link>
  317. </para>
  318. </sect4>
  319. </sect3>
  320. <sect3 id="zend.service.flickr.classes.image">
  321. <title>Zend_Service_Flickr_Image</title>
  322. <para>Reprezentuje zdjęcie zwrócone przez wyszukiwanie Flickr.</para>
  323. <sect4 id="zend.service.flickr.classes.image.properties">
  324. <title>Właściwości</title>
  325. <table id="zend.service.flickr.classes.image.properties.table-1">
  326. <title>Właściwości Zend_Service_Flickr_Image</title>
  327. <tgroup cols="3">
  328. <thead>
  329. <row>
  330. <entry>Nazwa</entry>
  331. <entry>Typ</entry>
  332. <entry>Opis</entry>
  333. </row>
  334. </thead>
  335. <tbody>
  336. <row>
  337. <entry>uri</entry>
  338. <entry>string</entry>
  339. <entry>Adres URI oryginalnego zdjęcia</entry>
  340. </row>
  341. <row>
  342. <entry>clickUri</entry>
  343. <entry>string</entry>
  344. <entry>Klikalny adres URI (np. strony Flickr) dla zdjęcia</entry>
  345. </row>
  346. <row>
  347. <entry>width</entry>
  348. <entry>int</entry>
  349. <entry>Szerokość zdjęcia</entry>
  350. </row>
  351. <row>
  352. <entry>height</entry>
  353. <entry>int</entry>
  354. <entry>Wysokość zdjęcia</entry>
  355. </row>
  356. </tbody>
  357. </tgroup>
  358. </table>
  359. <para>
  360. <link linkend="zend.service.flickr.classes">Powrót do listy klas</link>
  361. </para>
  362. </sect4>
  363. </sect3>
  364. </sect2>
  365. </sect1>