Zend_Service_Twitter.xml 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20115 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.service.twitter" xmlns:xi="http://www.w3.org/2001/XInclude">
  5. <title>Zend_Service_Twitter</title>
  6. <sect2 id="zend.service.twitter.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. <classname>Zend_Service_Twitter</classname> bietet einen Client für die <ulink
  10. url="http://apiwiki.twitter.com/Twitter-API-Documentation"><acronym>REST</acronym>
  11. <acronym>API</acronym> von Twitter</ulink>.
  12. <classname>Zend_Service_Twitter</classname> erlaubt es eine öffentliche Zeitachse
  13. abzufragen. Wenn man einen Benutzernamen und ein Passwort für Twitter angibt, ist es
  14. auch erlaubt den eigenen Status zu erhalten und zu aktualisieren, Freunden zu antworten,
  15. Nachrichten an Freunde schicken, Tweets als Favoriten markieren und vieles mehr.
  16. </para>
  17. <para>
  18. <classname>Zend_Service_Twitter</classname> implementiert einen <acronym>REST</acronym>
  19. Service und alle Methoden geben eine Instanz von
  20. <classname>Zend_Rest_Client_Result</classname> zurück.
  21. </para>
  22. <para>
  23. <classname>Zend_Service_Twitter</classname> ist in Untersektionen geteilt damit man
  24. einfachst erkennen kann welcher Typ von Aufrufen angefragt wird.
  25. </para>
  26. <itemizedlist>
  27. <listitem>
  28. <para>
  29. <code>account</code> stellt sicher das die eigenen Zugangsdaten gültig sind,
  30. prüft das <acronym>API</acronym> Limit und beendet die aktuelle Session für den
  31. authentifizierten Benutzer.
  32. </para>
  33. </listitem>
  34. <listitem>
  35. <para>
  36. <code>status</code> empfängt die öffentlichen und die Zeitlinien von Benutzern,
  37. und zeigt den authentifizierten Benutzer an, aktualsiert Ihn, zerstört Ihn und
  38. empfängt Antworten.
  39. </para>
  40. </listitem>
  41. <listitem>
  42. <para>
  43. <code>user</code> empfängt Freunde und Verfolger des authentifizierten
  44. Benutzers und gibt erweiterte Informationen über den angegebenen Benutzer
  45. zurück.
  46. </para>
  47. </listitem>
  48. <listitem>
  49. <para>
  50. <code>directMessage</code> empfängt die direkten Nachrichten des
  51. authentifizierten Benutzers, löscht direkte Nachrichten und sendet neue direkte
  52. Nachrichten.
  53. </para>
  54. </listitem>
  55. <listitem>
  56. <para>
  57. <code>friendship</code> erstellt und entfernt Freundschaften für den
  58. authentifizierten Benutzer.
  59. </para>
  60. </listitem>
  61. <listitem>
  62. <para>
  63. <code>favorite</code> zeigt, erstellt und entfernt favorisierte Tweets.
  64. </para>
  65. </listitem>
  66. <listitem>
  67. <para>
  68. <code>block</code> blockiert und entfernt die Blockierung von Benutzern welche
  69. einem folgen.
  70. </para>
  71. </listitem>
  72. </itemizedlist>
  73. </sect2>
  74. <sect2 id="zend.service.twitter.authentication">
  75. <title>Authentifizierung</title>
  76. <para>
  77. Mit der Ausnahme des Holens der öffentlichen Zeitlinie benötigt
  78. <classname>Zend_Service_Twitter</classname> eine Authentifizierung um zu funktionieren.
  79. Twitter verwendet aktuell eine <ulink
  80. url="http://en.wikipedia.org/wiki/Basic_authentication_scheme">HTTP Basis
  81. Authentifizierung</ulink>. Man kann den eigenen Benutzernamen oder eine registrierte
  82. Email mit dem Passwort, für das Login bei Twitter, übergeben.
  83. </para>
  84. <example id="zend.service.twitter.authentication.example">
  85. <title>Erstellung der Twitter Klasse</title>
  86. <para>
  87. Das folgende Codebeispiel zeigt wie man den Twitter Service erstellt, den
  88. Benutzernamen und das Passwort übergibt, und überprüft ob Sie korrekt sind.
  89. </para>
  90. <programlisting language="php"><![CDATA[
  91. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  92. // Prüft die Angaben mit Twitter
  93. $response = $twitter->account->verifyCredentials();
  94. ]]></programlisting>
  95. <para>
  96. Man kann auch ein Array das den Benutzernamen und das Passwort enthält, als ersten
  97. Parameter übergeben.
  98. </para>
  99. <programlisting language="php"><![CDATA[
  100. $userInfo = array('username' => 'foo', 'password' => 'bar');
  101. $twitter = new Zend_Service_Twitter($userInfo);
  102. // Überprüft die Zugangsdaten bei Twitter
  103. $response = $twitter->account->verifyCredentials();
  104. ]]></programlisting>
  105. </example>
  106. </sect2>
  107. <sect2 id="zend.service.twitter.account">
  108. <title>Account Methoden</title>
  109. <itemizedlist>
  110. <listitem>
  111. <para>
  112. <methodname>verifyCredentials()</methodname> testet ob die
  113. angegebenen Benutzerdaten gültig sind, und das mit einem minimalen Overhead.
  114. </para>
  115. <example id="zend.service.twitter.account.verifycredentails">
  116. <title>Die Angaben prüfen</title>
  117. <programlisting language="php"><![CDATA[
  118. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  119. $response = $twitter->account->verifyCredentials();
  120. ]]></programlisting>
  121. </example>
  122. </listitem>
  123. <listitem>
  124. <para>
  125. <methodname>endSession()</methodname> meldet Benutzer aus der
  126. Clientanwendung ab.
  127. </para>
  128. <example id="zend.service.twitter.account.endsession">
  129. <title>Beenden von Sessions</title>
  130. <programlisting language="php"><![CDATA[
  131. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  132. $response = $twitter->account->endSession();
  133. ]]></programlisting>
  134. </example>
  135. </listitem>
  136. <listitem>
  137. <para>
  138. <methodname>rateLimitStatus()</methodname> gibt die restliche Anzahl von
  139. <acronym>API</acronym> Anfragen zurück die der authentifizierte Benutzer noch
  140. hat, bevor das <acronym>API</acronym> Limit für die aktuelle Stunde erreicht
  141. ist.
  142. </para>
  143. <example id="zend.service.twitter.account.ratelimitstatus">
  144. <title>Status des Rating Limits</title>
  145. <programlisting language="php"><![CDATA[
  146. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  147. $response = $twitter->account->rateLimitStatus();
  148. ]]></programlisting>
  149. </example>
  150. </listitem>
  151. </itemizedlist>
  152. </sect2>
  153. <sect2 id="zend.service.twitter.status">
  154. <title>Status Methoden</title>
  155. <itemizedlist>
  156. <listitem>
  157. <para>
  158. <methodname>publicTimeline()</methodname> gibt die 20 letzten Statusmeldungen
  159. von nicht geschützten Benutzern mit einem eigenen Benutzericon zurück. Die
  160. öffentliche Zeitlinie wird von Twitter alle 60 Sekunden gecacht.
  161. </para>
  162. <example id="zend.service.twitter.status.publictimeline">
  163. <title>Empfangen der öffentlichen Zeitlinie</title>
  164. <programlisting language="php"><![CDATA[
  165. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  166. $response = $twitter->status->publicTimeline();
  167. ]]></programlisting>
  168. </example>
  169. </listitem>
  170. <listitem>
  171. <para>
  172. <methodname>friendsTimeline()</methodname> gibt die 20 letzten Statusmeldungen
  173. zurück die von authentifizierten Benutzer und deren Freunde gesendet wurden.
  174. </para>
  175. <example id="zend.service.twitter.status.friendstimeline">
  176. <title>Empfangen der Zeitlinie von Freunden</title>
  177. <programlisting language="php"><![CDATA[
  178. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  179. $response = $twitter->status->friendsTimeline();
  180. ]]></programlisting>
  181. </example>
  182. <para>
  183. Die <methodname>friendsTimeline()</methodname> Methode akzeptiert ein Array
  184. von optionalen Parameters um die Abfrage zu verändern.
  185. </para>
  186. <itemizedlist>
  187. <listitem>
  188. <para>
  189. <code>since</code> grenzt die zurückgegeben Ergebnisse auf jene
  190. Statusmeldungen ein die nach dem spezifizierten Datum/Zeit (bis zu 24
  191. Stunden alt) erstellt wurden.
  192. </para>
  193. </listitem>
  194. <listitem>
  195. <para>
  196. <code>page</code> spezifiziert die Seite die man zurückbekommen will.
  197. </para>
  198. </listitem>
  199. </itemizedlist>
  200. </listitem>
  201. <listitem>
  202. <para>
  203. <methodname>userTimeline()</methodname> gibt die 20 letzten Statusmeldungen
  204. zurück die von authentifizierten Benutzern geschrieben wurden.
  205. </para>
  206. <example id="zend.service.twitter.status.usertimeline">
  207. <title>Empfangen der Zeitlinie von Benutzern</title>
  208. <programlisting language="php"><![CDATA[
  209. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  210. $response = $twitter->status->userTimeline();
  211. ]]></programlisting>
  212. </example>
  213. <para>
  214. Die <methodname>userTimeline()</methodname> Methode akzeptiert ein Array von
  215. optionalen Parametern um die Abfrage zu verändern.
  216. </para>
  217. <itemizedlist>
  218. <listitem>
  219. <para>
  220. <code>id</code> spezifiziert die ID oder den Bildschirmnamen des
  221. Benutzers für den die friends_timeline zurückzugeben ist.
  222. </para>
  223. </listitem>
  224. <listitem>
  225. <para>
  226. <code>since</code> grenzt die zurückzugebenden Ergebnisse auf jene
  227. Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als)
  228. erstellt wurden.
  229. </para>
  230. </listitem>
  231. <listitem>
  232. <para>
  233. <code>page</code> spezifiziert welche Seite zurückgegeben werden soll.
  234. </para>
  235. </listitem>
  236. <listitem>
  237. <para>
  238. <code>count</code> spezifiziert die Anzahl der Stati die man erhalten
  239. will. Kann nicht größer als 200 sein.
  240. </para>
  241. </listitem>
  242. </itemizedlist>
  243. </listitem>
  244. <listitem>
  245. <para>
  246. <methodname>show()</methodname> gibt einen einzelnen Status zurück, der durch
  247. den ID Parameter, wie anbei, spezifiziert wird. Der Author des Status wird auch
  248. zurückgegeben.
  249. </para>
  250. <example id="zend.service.twitter.status.show">
  251. <title>Den Status eines Benutzers sehen</title>
  252. <programlisting language="php"><![CDATA[
  253. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  254. $response = $twitter->status->show(1234);
  255. ]]></programlisting>
  256. </example>
  257. </listitem>
  258. <listitem>
  259. <para>
  260. <methodname>update()</methodname> aktualisiert den Status des authentifizierten
  261. Benutzers. Diese Methode erwartet das der aktualisierte Status übergeben wird
  262. den man an Twitter übermitteln will.
  263. </para>
  264. <example id="zend.service.twitter.status.update">
  265. <title>Aktualisieren des Benutzerstatus</title>
  266. <programlisting language="php"><![CDATA[
  267. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  268. $response = $twitter->status->update('Mein größter Tweet');
  269. ]]></programlisting>
  270. </example>
  271. <para>
  272. Die <methodname>update()</methodname> Methode akzeptiert einen zweiten
  273. optionalen Parameter.
  274. </para>
  275. <itemizedlist>
  276. <listitem>
  277. <para>
  278. <code>in_reply_to_status_id</code> spezifiziert die ID eines bestehenden
  279. Status auf den dieser Status als Antwort gesendet werden soll.
  280. </para>
  281. </listitem>
  282. </itemizedlist>
  283. </listitem>
  284. <listitem>
  285. <para>
  286. <methodname>replies()</methodname> gibt die 20 letzten Antworten/@replies
  287. (Statusaktualisierungen die mit @username anfangen) für den authentifizierten
  288. Benutzer zurück.
  289. </para>
  290. <example id="zend.service.twitter.status.replies">
  291. <title>Zeigt Benutzerantworten</title>
  292. <programlisting language="php"><![CDATA[
  293. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  294. $response = $twitter->status->replies();
  295. ]]></programlisting>
  296. </example>
  297. <para>
  298. Die <methodname>replies()</methodname> Methode akzeptiert ein Array von
  299. optionalen Parametern um die Anfrage zu verändern.
  300. </para>
  301. <itemizedlist>
  302. <listitem>
  303. <para>
  304. <code>since</code> grenzt die Ergebnisse die man erhält auf jene ein,
  305. deren Stati nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden alt)
  306. erstellt wurden.
  307. </para>
  308. </listitem>
  309. <listitem>
  310. <para>
  311. <code>page</code> spezifiziert welche Seite soll zurückgegeben werden.
  312. </para>
  313. </listitem>
  314. <listitem>
  315. <para>
  316. <code>since_id</code> gibt nur Stati zurück die eine größere ID (das
  317. ist die aktuellere) als die spezifizierte ID haben.
  318. </para>
  319. </listitem>
  320. </itemizedlist>
  321. </listitem>
  322. <listitem>
  323. <para>
  324. <methodname>destroy()</methodname> entfernt den Status der durch den benötigten
  325. <code>id</code> Parameter spezifiziert ist.
  326. </para>
  327. <example id="zend.service.twitter.status.destroy">
  328. <title>Löschen eines Benutzerstatus</title>
  329. <programlisting language="php"><![CDATA[
  330. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  331. $response = $twitter->status->destroy(12345);
  332. ]]></programlisting>
  333. </example>
  334. </listitem>
  335. </itemizedlist>
  336. </sect2>
  337. <sect2 id="zend.service.twitter.user">
  338. <title>Benutzermethoden</title>
  339. <itemizedlist>
  340. <listitem>
  341. <para>
  342. <methodname>friends()</methodname> gibt bis zu 100 Freunde des authentifizierten
  343. Benutzers zurück, die zuletzt aktualisiert haben, und jeden von Ihnen mit dem
  344. aktuellen Status.
  345. </para>
  346. <example id="zend.service.twitter.user.friends">
  347. <title>Empfangen von Benutzerfreunden</title>
  348. <programlisting language="php"><![CDATA[
  349. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  350. $response = $twitter->user->friends();
  351. ]]></programlisting>
  352. </example>
  353. <para>
  354. Die <methodname>friends()</methodname> Methode akzeptiert ein Array von
  355. optionalen Parameter um die Abfrage zu verändern.
  356. </para>
  357. <itemizedlist>
  358. <listitem>
  359. <para>
  360. <code>id</code> spezifiziert die ID oder den Bildschirmnamen des
  361. Benutzers von dem die Liste an Freunden zurückgegeben werden soll.
  362. </para>
  363. </listitem>
  364. <listitem>
  365. <para>
  366. <code>since</code> grenzt die zurückzugebenden Ergebnisse auf jene
  367. Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als)
  368. erstellt wurden.
  369. </para>
  370. </listitem>
  371. <listitem>
  372. <para>
  373. <code>page</code> spezifiziert welche Seite soll zurückgegeben werden.
  374. </para>
  375. </listitem>
  376. </itemizedlist>
  377. </listitem>
  378. <listitem>
  379. <para>
  380. <methodname>followers()</methodname> gibt die Verfolger des authentifizierten
  381. Benutzers zurück, und jeden von Ihnen mit seinem aktuellen Status.
  382. </para>
  383. <example id="zend.service.twitter.user.followers">
  384. <title>Empfangen der Verfolger eines Benutzers</title>
  385. <programlisting language="php"><![CDATA[
  386. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  387. $response = $twitter->user->followers();
  388. ]]></programlisting>
  389. </example>
  390. <para>
  391. Die <methodname>followers()</methodname> Methode akzeptiert ein Array von
  392. optionalen Parametern welche die Anfrage verändern.
  393. </para>
  394. <itemizedlist>
  395. <listitem>
  396. <para>
  397. <code>id</code> spezifiziert die ID oder den Bildschirmnamen des
  398. Benutzers von dem die Liste an Verfolgern zurückgegeben werden soll.
  399. </para>
  400. </listitem>
  401. <listitem>
  402. <para>
  403. <code>page</code> spezifiziert welche Seite soll zurückgegeben werden.
  404. </para>
  405. </listitem>
  406. </itemizedlist>
  407. </listitem>
  408. <listitem>
  409. <para>
  410. <methodname>show()</methodname> gibt erweiterte Informationen über einen
  411. angegebenen Benutzer zurück, der durch eine ID oder einen Bildschirmnamen
  412. spezifiziert wird wie durch den anbei benötigten <code>id</code> Parameter.
  413. </para>
  414. <example id="zend.service.twitter.user.show">
  415. <title>Zeigt Benutzerinformationen</title>
  416. <programlisting language="php"><![CDATA[
  417. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  418. $response = $twitter->user->show('myfriend');
  419. ]]></programlisting>
  420. </example>
  421. </listitem>
  422. </itemizedlist>
  423. </sect2>
  424. <sect2 id="zend.service.twitter.directmessage">
  425. <title>Methoden zur direkten Benachrichtigung</title>
  426. <itemizedlist>
  427. <listitem>
  428. <para>
  429. <methodname>messages()</methodname> gibt eine Liste der 20 letzten direkten
  430. Nachrichten für den authentifizierten Benutzer zurück.
  431. </para>
  432. <example id="zend.service.twitter.directmessage.messages">
  433. <title>Empfangen der letzten empfangenen direkten Nachrichten</title>
  434. <programlisting language="php"><![CDATA[
  435. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  436. $response = $twitter->directMessage->messages();
  437. ]]></programlisting>
  438. </example>
  439. <para>
  440. Die <methodname>message()</methodname> Methode akzeptiert ein Array von
  441. optionalen Parametern um die Anfrage zu verändern.
  442. </para>
  443. <itemizedlist>
  444. <listitem>
  445. <para>
  446. <code>since_id</code> gibt nur direkte Nachrichten mit einer ID zurück,
  447. die größer als (das ist aktueller als) die spezifizierte ID sind.
  448. </para>
  449. </listitem>
  450. <listitem>
  451. <para>
  452. <code>since</code> grenzt die zurückzugebenden Ergebnisse auf jene
  453. Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als)
  454. erstellt wurden.
  455. </para>
  456. </listitem>
  457. <listitem>
  458. <para>
  459. <code>page</code> spezifiziert welche Seite soll zurückgegeben werden.
  460. </para>
  461. </listitem>
  462. </itemizedlist>
  463. </listitem>
  464. <listitem>
  465. <para>
  466. <methodname>sent()</methodname> gibt eine Liste der 20 letzten direkten
  467. Nachrichten zurück die vom authentifizierten Benutzer gesendet wurden.
  468. </para>
  469. <example id="zend.service.twitter.directmessage.sent">
  470. <title>Empfangen der letzten gesendeten direkten Nachrichten</title>
  471. <programlisting language="php"><![CDATA[
  472. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  473. $response = $twitter->directMessage->sent();
  474. ]]></programlisting>
  475. </example>
  476. <para>
  477. Die <methodname>sent()</methodname> Methode akzeptiert ein Array von
  478. optionalen Parametern um die Abfrage zu verändern.
  479. </para>
  480. <itemizedlist>
  481. <listitem>
  482. <para>
  483. <code>since_id</code> gibt nur direkte Nachrichten mit einer ID zurück,
  484. die größer als (das ist aktueller als) die spezifizierte ID sind.
  485. </para>
  486. </listitem>
  487. <listitem>
  488. <para>
  489. <code>since</code> grenzt die zurückzugebenden Ergebnisse auf jene
  490. Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als)
  491. erstellt wurden.
  492. </para>
  493. </listitem>
  494. <listitem>
  495. <para>
  496. <code>page</code> spezifiziert welche Seite soll zurückgegeben werden.
  497. </para>
  498. </listitem>
  499. </itemizedlist>
  500. </listitem>
  501. <listitem>
  502. <para>
  503. <methodname>new()</methodname> sendet eine neue direkte Nachricht vom
  504. authentifizierten Benutzer zum spezifizierten Benutzer. Benötigt sowohl den
  505. Benutzer also auch den Text Parameter wie unten gezeigt.
  506. </para>
  507. <example id="zend.service.twitter.directmessage.new">
  508. <title>Senden einer direkten Nachricht</title>
  509. <programlisting language="php"><![CDATA[
  510. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  511. $response = $twitter->directMessage->new('myfriend', 'mymessage');
  512. ]]></programlisting>
  513. </example>
  514. </listitem>
  515. <listitem>
  516. <para>
  517. <methodname>destroy()</methodname> entfernt eine direkte Nachricht die im
  518. benötigten <code>id</code> Parameter spezifiziert wird. Der authentifizierte
  519. Benutzer muß der Empfänger der spezifizierten direkten Nachricht sein.
  520. </para>
  521. <example id="zend.service.twitter.directmessage.destroy">
  522. <title>Löschen einer direkten Nachricht</title>
  523. <programlisting language="php"><![CDATA[
  524. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  525. $response = $twitter->directMessage->destroy(123548);
  526. ]]></programlisting>
  527. </example>
  528. </listitem>
  529. </itemizedlist>
  530. </sect2>
  531. <sect2 id="zend.service.twitter.friendship">
  532. <title>Methoden für die Freundschaft</title>
  533. <itemizedlist>
  534. <listitem>
  535. <para>
  536. <methodname>create()</methodname> befreundet den im <code>id</code> Parameter
  537. spezifizierten Benutzer mit dem authentifizierten Benutzer.
  538. </para>
  539. <example id="zend.service.twitter.friendship.create">
  540. <title>Erstellung eines Freundes</title>
  541. <programlisting language="php"><![CDATA[
  542. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  543. $response = $twitter->friendship->create('mynewfriend');
  544. ]]></programlisting>
  545. </example>
  546. </listitem>
  547. <listitem>
  548. <para>
  549. <methodname>destroy()</methodname> beendet die Freundschaft des im
  550. <code>id</code> Parameter spezifizierten Benutzers, mit dem authentifizierten
  551. Benutzer.
  552. </para>
  553. <example id="zend.service.twitter.friendship.destroy">
  554. <title>Löschen eines Freundes</title>
  555. <programlisting language="php"><![CDATA[
  556. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  557. $response = $twitter->friendship->destroy('myoldfriend');
  558. ]]></programlisting>
  559. </example>
  560. </listitem>
  561. <listitem>
  562. <para>
  563. <methodname>exists()</methodname> testet ob eine Freundschaft zwischen dem
  564. authentifizierten Benutzer und dem im <code>id</code> Parameter übergebenen
  565. Benutzer existiert.
  566. </para>
  567. <example id="zend.service.twitter.friendship.exists">
  568. <title>Prüfen ob eine Freundschaft existiert</title>
  569. <programlisting language="php"><![CDATA[
  570. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  571. $response = $twitter->friendship->exists('myfriend');
  572. ]]></programlisting>
  573. </example>
  574. </listitem>
  575. </itemizedlist>
  576. </sect2>
  577. <sect2 id="zend.service.twitter.favorite">
  578. <title>Methoden für Favoriten</title>
  579. <itemizedlist>
  580. <listitem>
  581. <para>
  582. <methodname>favorites()</methodname> gibt die 20 letzten Stati von Favoriten für
  583. den authentifizierten oder durch den <code>id</code> Parameter spezifizierten
  584. Benutzer zurück.
  585. </para>
  586. <example id="zend.service.twitter.favorite.favorites">
  587. <title>Favoriten empfangen</title>
  588. <programlisting language="php"><![CDATA[
  589. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  590. $response = $twitter->favorite->favorites();
  591. ]]></programlisting>
  592. </example>
  593. <para>
  594. Die <methodname>favorites()</methodname> Methode akzeptiert ein Array von
  595. optionalen Parametern um die Abfrage zu modifizieren.
  596. </para>
  597. <itemizedlist>
  598. <listitem>
  599. <para>
  600. <code>id</code> spezifiziert die ID oder der Bildschirmname des
  601. Benutzers von dem die Liste der bevorzugten Stati zurückgegeben
  602. werden soll.
  603. </para>
  604. </listitem>
  605. <listitem>
  606. <para>
  607. <code>page</code> spezifiziert welche Seite soll zurückgegeben werden.
  608. </para>
  609. </listitem>
  610. </itemizedlist>
  611. </listitem>
  612. <listitem>
  613. <para>
  614. <methodname>create()</methodname> favorisiert den mit dem <code>id</code>
  615. Parameter spezifizierten Status für den authentifizierten Benutzer
  616. </para>
  617. <example id="zend.service.twitter.favorite.create">
  618. <title>Favoriten erstellen</title>
  619. <programlisting language="php"><![CDATA[
  620. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  621. $response = $twitter->favorite->create(12351);
  622. ]]></programlisting>
  623. </example>
  624. </listitem>
  625. <listitem>
  626. <para>
  627. <methodname>destroy()</methodname> entfernt die Favorisierung des des mit dem
  628. <code>id</code> Parameter spezifizierten Status für den authentifizierten
  629. Benutzer.
  630. </para>
  631. <example id="zend.service.twitter.favorite.destroy">
  632. <title>Entfernt Favoriten</title>
  633. <programlisting language="php"><![CDATA[
  634. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  635. $response = $twitter->favorite->destroy(12351);
  636. ]]></programlisting>
  637. </example>
  638. </listitem>
  639. </itemizedlist>
  640. </sect2>
  641. <sect2 id="zend.service.twitter.block">
  642. <title>Blockierende Methoden</title>
  643. <itemizedlist>
  644. <listitem>
  645. <para>
  646. <methodname>exists()</methodname> retourniert ob der authentifizierende Benutzer
  647. einen Zielbenutzer blockiert und kann optional das Objekt des blockierten
  648. Benutzers zurückgeben wenn ein Block existiert.
  649. </para>
  650. <example id="zend.service.twitter.block.exists">
  651. <title>Prüfen ob ein Block existiert</title>
  652. <programlisting language="php"><![CDATA[
  653. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  654. // gibt true oder false zurück
  655. $response = $twitter->block->exists('blockeduser');
  656. // gibt die Info des blockierten Benutzers zurück wenn dieser blockiert ist
  657. $response2 = $twitter->block->exists('blockeduser', true);
  658. ]]></programlisting>
  659. </example>
  660. <para>
  661. Die <methodname>favorites()</methodname> Methode akzeptiert einen optionalen
  662. zweiten Parameter.
  663. </para>
  664. <itemizedlist>
  665. <listitem>
  666. <para>
  667. <code>returnResult</code> spezifiziert ob das Objekt des
  668. Benutzers zurückgegeben werden soll, oder einfach nur
  669. <constant>TRUE</constant> oder <constant>FALSE</constant>.
  670. </para>
  671. </listitem>
  672. </itemizedlist>
  673. </listitem>
  674. <listitem>
  675. <para>
  676. <methodname>create()</methodname> blockiert den Benutzer der im <code>id</code>
  677. Parameter als authentifizierter Benutzer spezifiziert wurde und löscht eine
  678. Freundschaft zum blockierten Benutzer wenn eine existiert. Gibt den blockierten
  679. Benutzer im angeforderten Format zurück wenn es erfolgreich war
  680. </para>
  681. <example id="zend.service.twitter.block.create">
  682. <title>Einen Benutzer blockieren</title>
  683. <programlisting language="php"><![CDATA[
  684. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  685. $response = $twitter->block->create('usertoblock);
  686. ]]></programlisting>
  687. </example>
  688. </listitem>
  689. <listitem>
  690. <para>
  691. <methodname>destroy()</methodname> entfernt die Blockierung des Benutzers der
  692. im <code>id</code> Parameter für den authentifizierten Benutzer spezifiziert
  693. wurde. Gibt den un-blockierten Benutzer im angeforderten Format zurück wenn
  694. diese erfolgreich war.
  695. </para>
  696. <example id="zend.service.twitter.block.destroy">
  697. <title>Entfernung einer Blockierung</title>
  698. <programlisting language="php"><![CDATA[
  699. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  700. $response = $twitter->block->destroy('blockeduser');
  701. ]]></programlisting>
  702. </example>
  703. </listitem>
  704. <listitem>
  705. <para>
  706. <methodname>blocking()</methodname> gibt ein Array von Benutzerobjekten zurück
  707. die der authentifizierte Benutzer blockiert.
  708. </para>
  709. <example id="zend.service.twitter.block.blocking">
  710. <title>Wen blockiert man</title>
  711. <programlisting language="php"><![CDATA[
  712. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  713. // gibt die komplette Benutzerliste zurück
  714. $response = $twitter->block->blocking(1);
  715. // gibt ein Array von nummerischen Benutzer IDs zurück
  716. $response2 = $twitter->block->blocking(1, true);
  717. ]]></programlisting>
  718. </example>
  719. <para>
  720. Die <methodname>favorites()</methodname> Methode akzeptiert zwei optionale
  721. Parameter.
  722. </para>
  723. <itemizedlist>
  724. <listitem>
  725. <para>
  726. <code>page</code> spezifiziert die man zurück erhalten will. Eine
  727. einzelne Seite enthält 20 Id's.
  728. </para>
  729. </listitem>
  730. <listitem>
  731. <para>
  732. <code>returnUserIds</code> spezifiziert ob ein Array von nummerischen
  733. Benutzer Id's zurückzugeben ist welche der authenzifizierte Benutzer
  734. blockiert, oder ein Array von Benutzerobjekten.
  735. </para>
  736. </listitem>
  737. </itemizedlist>
  738. </listitem>
  739. </itemizedlist>
  740. </sect2>
  741. <xi:include href="Zend_Service_Twitter_Search.xml" />
  742. </sect1>
  743. <!--
  744. vim:se ts=4 sw=4 et:
  745. -->