Zend_Service_Twitter.xml 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 18505 -->
  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">REST
  11. <acronym>API</acronym> von Twitter</ulink>.
  12. <classname>Zend_Service_Twitter</classname> erlaubt es eine öffentliche Zeitachse
  13. abzufragen und 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 REST Service und alle
  19. Methoden geben eine Instanz von <classname>Zend_Rest_Client_Result</classname> zurück.
  20. </para>
  21. <para>
  22. <classname>Zend_Service_Twitter</classname> ist in Untersektionen geteilt damit man
  23. einfachst erkennen kann welcher Typ von Aufrufen angefragt wird.
  24. </para>
  25. <itemizedlist>
  26. <listitem>
  27. <para>
  28. <code>account</code>, stellt sicher das die eigenen Zugangsdaten gültig sind,
  29. prüft das API Limit und beendet die aktuelle Session für den authentifizierten
  30. Benutzer.
  31. </para>
  32. </listitem>
  33. <listitem>
  34. <para>
  35. <code>status</code>, empfängt die öffentlichen und die Zeitlinien von Benutzern,
  36. und erlaubt es Sie anzusehen, zu aktualsieren, zu zerstören und Antworten für
  37. den authentifizierten Benutzer zu empfangen.
  38. </para>
  39. </listitem>
  40. <listitem>
  41. <para>
  42. <code>user</code>, empfangen von Freunden, Verfolger des authentifizierten
  43. Benutzers. Mit der show Methode kann man erweiterte Informationen über den
  44. angegebenen Benutzer erhalten.
  45. </para>
  46. </listitem>
  47. <listitem>
  48. <para>
  49. <code>directMessage</code>, empfängt die direkten Nachrichten des
  50. authentifizierten Benutzers und erlaubt es neue direkte Nachrichten zu senden
  51. und zu löschen.
  52. </para>
  53. </listitem>
  54. <listitem>
  55. <para>
  56. <code>friendship</code>, erstellt oder entfernt eine Freundschaft für den
  57. authentifizierten Benutzer.
  58. </para>
  59. </listitem>
  60. <listitem>
  61. <para>
  62. <code>favorite</code>, auflisten, erstellen oder entfernen eines favorisierten
  63. 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 dann ü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 als erste Variable übergeben, die den Benutzernamen und das
  97. Passwort enthält.
  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. <code>verifyCredentials</code>, verwende diese Methode um zu Testen 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. <code>endSession</code>, verwende diese Methode um Benutzer aus der
  126. Clientanwendung abzumelden.
  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. <code>rateLimitStatus</code>, 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. <code>publicTimeline</code>, gibt die 20 letzten Statusmeldungen von nicht
  159. geschützten Benutzern mit einem eigenen Benutzericon zurück. Die öffentliche
  160. 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. <code>friendsTimeline</code>, gibt die 20 letzten Statusmeldungen zurück die von
  173. authentifizierten Benutzer gesendet wurden und den Freunden dieser Benutzer.
  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 <code>friendsTimeline</code> Methode akzeptiert ein Array von optionalen
  184. 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>, die Seite die man zurückbekommen will.
  197. </para>
  198. </listitem>
  199. </itemizedlist>
  200. </listitem>
  201. <listitem>
  202. <para>
  203. <code>userTimeline</code>, gibt die 20 letzten Statusmeldungen zurück die von
  204. 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 <code>userTimeline</code> Methode akzeptiert ein Array von optionalen
  215. Parametern um die Abfrage zu verändern.</para>
  216. <itemizedlist>
  217. <listitem>
  218. <para>
  219. <code>id</code>, spezifiziert die ID oder den Bildschirmnamen des
  220. Benutzers für den die friends_timeline zurückzugeben ist.
  221. </para>
  222. </listitem>
  223. <listitem>
  224. <para>
  225. <code>since</code>, grenzt die zurückzugebenden Ergebnisse auf jene
  226. Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als)
  227. erstellt wurden.
  228. </para>
  229. </listitem>
  230. <listitem>
  231. <para>
  232. <code>page</code>, welche Seite zurückgegeben werden soll.
  233. </para>
  234. </listitem>
  235. <listitem>
  236. <para>
  237. <code>count</code>, spezifiziert die Anzahl der Stati die man erhalten
  238. will. Kann nicht größer als 200 sein.
  239. </para>
  240. </listitem>
  241. </itemizedlist>
  242. </listitem>
  243. <listitem>
  244. <para>
  245. <code>show</code>, gibt einen einzelnen Status zurück, der durch den ID
  246. Parameter, wie anbei, spezifiziert wird. Der Author des Status wird auch
  247. zurückgegeben. Diese Methode benötigt eine Tweet ID die an Sie übergeben wird.
  248. </para>
  249. <example id="zend.service.twitter.status.show">
  250. <title>Den Status eines Benutzers sehen</title>
  251. <programlisting language="php"><![CDATA[
  252. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  253. $response = $twitter->status->show(1234);
  254. ]]></programlisting>
  255. </example>
  256. </listitem>
  257. <listitem>
  258. <para>
  259. <code>update</code>, aktualisiert den Status des authentifizierten Benutzers.
  260. Diese Methode erwartet das der aktualisierte Status übergeben wird den man an
  261. Twitter übermitteln will. Ein zweiter optionaler Parameter ist die ID des Tweets
  262. auf den man antwortet.
  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 <code>update</code> Methode akzeptiert einen zweiten optionalen Parameter.
  273. </para>
  274. <itemizedlist>
  275. <listitem>
  276. <para>
  277. <code>in_reply_to_status_id</code>, die ID eines bestehenden Status auf
  278. den dieser Status als Antwort gesendet werden soll.
  279. </para>
  280. </listitem>
  281. </itemizedlist>
  282. </listitem>
  283. <listitem>
  284. <para>
  285. <code>replies</code>, gibt die 20 letzten Antworten/@replies
  286. (Statusaktualisierungen die mit @username anfangen) für den authentifizierten
  287. Benutzer zurück.
  288. </para>
  289. <example id="zend.service.twitter.status.replies">
  290. <title>Zeigt Benutzerantworten</title>
  291. <programlisting language="php"><![CDATA[
  292. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  293. $response = $twitter->status->replies();
  294. ]]></programlisting>
  295. </example>
  296. <para>
  297. Die <code>replies</code> Methode akzeptiert ein Array von optionalen Parametern
  298. um die Anfrage zu verändern.
  299. </para>
  300. <itemizedlist>
  301. <listitem>
  302. <para>
  303. <code>since</code>, grenzt die Ergebnisse die man erhält auf jene ein,
  304. deren Stati nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden alt)
  305. erstellt wurden.
  306. </para>
  307. </listitem>
  308. <listitem>
  309. <para>
  310. <code>page</code>, welche Seite soll zurückgegeben werden.
  311. </para>
  312. </listitem>
  313. <listitem>
  314. <para>
  315. <code>since_id</code>, gibt nur Stati zurück die eine größere ID (das
  316. ist die aktuellere) als die spezifizierte ID haben.
  317. </para>
  318. </listitem>
  319. </itemizedlist>
  320. </listitem>
  321. <listitem>
  322. <para>
  323. <code>destroy</code>, entfernt den Status der durch den benötigten ID Parameter
  324. spezifiziert ist.
  325. </para>
  326. <example id="zend.service.twitter.status.destroy">
  327. <title>Löschen eines Benutzerstatus</title>
  328. <programlisting language="php"><![CDATA[
  329. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  330. $response = $twitter->status->destroy(12345);
  331. ]]></programlisting>
  332. </example>
  333. </listitem>
  334. </itemizedlist>
  335. </sect2>
  336. <sect2 id="zend.service.twitter.user">
  337. <title>Benutzermethoden</title>
  338. <itemizedlist>
  339. <listitem>
  340. <para>
  341. <code>friends</code>, gibt bis zu 100 Freunde des authentifizierten Benutzers
  342. zurück, die zuletzt aktualisiert haben, und jeden von Ihnen mit dem aktuellen
  343. Status.
  344. </para>
  345. <example id="zend.service.twitter.user.friends">
  346. <title>Empfangen von Benutzerfreunden</title>
  347. <programlisting language="php"><![CDATA[
  348. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  349. $response = $twitter->user->friends();
  350. ]]></programlisting>
  351. </example>
  352. <para>
  353. Die <code>friends</code> Methode akzeptiert ein Array von optionalen Parameter
  354. um die Abfrage zu verändern.
  355. </para>
  356. <itemizedlist>
  357. <listitem>
  358. <para>
  359. <code>id</code>, spezifiziert die ID oder den Bildschirmnamen des
  360. Benutzers von dem die Liste an Freunden zurückgegeben werden soll.
  361. </para>
  362. </listitem>
  363. <listitem>
  364. <para>
  365. <code>since</code>, grenzt die zurückzugebenden Ergebnisse auf jene
  366. Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als)
  367. erstellt wurden.
  368. </para>
  369. </listitem>
  370. <listitem>
  371. <para>
  372. <code>page</code>, welche Seite soll zurückgegeben werden.
  373. </para>
  374. </listitem>
  375. </itemizedlist>
  376. </listitem>
  377. <listitem>
  378. <para>
  379. <code>followers</code>, gibt die Verfolger des authentifizierten Benutzers
  380. zurück, und jeden von Ihnen mit seinem aktuellen Status.
  381. </para>
  382. <example id="zend.service.twitter.user.followers">
  383. <title>Empfangen der Verfolger eines Benutzers</title>
  384. <programlisting language="php"><![CDATA[
  385. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  386. $response = $twitter->user->followers();
  387. ]]></programlisting>
  388. </example>
  389. <para>
  390. Die <code>followers</code> Methode akzeptiert ein Array von optionalen
  391. Parametern die die Anfrage verändern.
  392. </para>
  393. <itemizedlist>
  394. <listitem>
  395. <para>
  396. <code>id</code>, spezifiziert die ID oder den Bildschirmnamen des
  397. Benutzers von dem die Liste an Verfolgern zurückgegeben werden soll.
  398. </para>
  399. </listitem>
  400. <listitem>
  401. <para>
  402. <code>page</code>, welche Seite soll zurückgegeben werden.
  403. </para>
  404. </listitem>
  405. </itemizedlist>
  406. </listitem>
  407. <listitem>
  408. <para>
  409. <code>show</code>, gibt erweiterte Informationen über einen angegebenen Benutzer
  410. zurück, der durch eine ID oder einen Bildschirmnamen spezifiziert wird wie durch
  411. den anbei benötigten ID Parameter.
  412. </para>
  413. <example id="zend.service.twitter.user.show">
  414. <title>Zeigt Benutzerinformationen</title>
  415. <programlisting language="php"><![CDATA[
  416. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  417. $response = $twitter->user->show('myfriend');
  418. ]]></programlisting>
  419. </example>
  420. </listitem>
  421. </itemizedlist>
  422. </sect2>
  423. <sect2 id="zend.service.twitter.directmessage">
  424. <title>Methoden zur direkten Benachrichtigung</title>
  425. <itemizedlist>
  426. <listitem>
  427. <para>
  428. <code>messages</code>, gibt eine Liste der 20 letzten direkten Nachrichten für
  429. den authentifizierten Benutzer zurück.
  430. </para>
  431. <example id="zend.service.twitter.directmessage.messages">
  432. <title>Empfangen der letzten empfangenen direkten Nachrichten</title>
  433. <programlisting language="php"><![CDATA[
  434. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  435. $response = $twitter->directMessage->messages();
  436. ]]></programlisting>
  437. </example>
  438. <para>
  439. Die <code>message</code> Methode akzeptiert ein Array von optionalen Parametern
  440. um die Anfrage zu verändern.
  441. </para>
  442. <itemizedlist>
  443. <listitem>
  444. <para>
  445. <code>since_id</code>, gibt nur direkte Nachrichten mit einer ID zurück,
  446. die größer als (das ist aktueller als) die spezifizierte ID sind.
  447. </para>
  448. </listitem>
  449. <listitem>
  450. <para>
  451. <code>since</code>, grenzt die zurückzugebenden Ergebnisse auf jene
  452. Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als)
  453. erstellt wurden.
  454. </para>
  455. </listitem>
  456. <listitem>
  457. <para>
  458. <code>page</code>, welche Seite soll zurückgegeben werden.
  459. </para>
  460. </listitem>
  461. </itemizedlist>
  462. </listitem>
  463. <listitem>
  464. <para>
  465. <code>sent</code>, gibt eine Liste der 20 letzten direkten Nachrichten zurück
  466. die vom authentifizierten Benutzer gesendet wurden.
  467. </para>
  468. <example id="zend.service.twitter.directmessage.sent">
  469. <title>Empfangen der letzten gesendeten direkten Nachrichten</title>
  470. <programlisting language="php"><![CDATA[
  471. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  472. $response = $twitter->directMessage->sent();
  473. ]]></programlisting>
  474. </example>
  475. <para>
  476. Die <code>sent</code> Methode akzeptiert ein Array von optionalen Parametern um
  477. die Abfrage zu verändern.
  478. </para>
  479. <itemizedlist>
  480. <listitem>
  481. <para>
  482. <code>since_id</code>, gibt nur direkte Nachrichten mit einer ID zurück,
  483. die größer als (das ist aktueller als) die spezifizierte ID sind.
  484. </para>
  485. </listitem>
  486. <listitem>
  487. <para>
  488. <code>since</code>, grenzt die zurückzugebenden Ergebnisse auf jene
  489. Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als)
  490. erstellt wurden.
  491. </para>
  492. </listitem>
  493. <listitem>
  494. <para>
  495. <code>page</code>, welche Seite soll zurückgegeben werden.
  496. </para>
  497. </listitem>
  498. </itemizedlist>
  499. </listitem>
  500. <listitem>
  501. <para>
  502. <code>new</code>, sendet eine neue direkte Nachricht vom authentifizierten
  503. Benutzer zum spezifizierten Benutzer. Benötigt sowohl den Benutzer also auch den
  504. Text Parameter wie unten gezeigt.
  505. </para>
  506. <example id="zend.service.twitter.directmessage.new">
  507. <title>Senden einer direkten Nachricht</title>
  508. <programlisting language="php"><![CDATA[
  509. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  510. $response = $twitter->directMessage->new('myfriend', 'mymessage');
  511. ]]></programlisting>
  512. </example>
  513. </listitem>
  514. <listitem>
  515. <para>
  516. <code>destroy</code>, entfernt eine direkte Nachricht die im benötigten ID
  517. Parameter spezifiziert wird. Der authentifizierte Benutzer muß der Empfänger der
  518. spezifizierten direkten Nachricht sein.
  519. </para>
  520. <example id="zend.service.twitter.directmessage.destroy">
  521. <title>Löschen einer direkten Nachricht</title>
  522. <programlisting language="php"><![CDATA[
  523. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  524. $response = $twitter->directMessage->destroy(123548);
  525. ]]></programlisting>
  526. </example>
  527. </listitem>
  528. </itemizedlist>
  529. </sect2>
  530. <sect2 id="zend.service.twitter.friendship">
  531. <title>Methoden für die Freundschaft</title>
  532. <itemizedlist>
  533. <listitem>
  534. <para>
  535. <code>create</code>, befreundet den im ID Parameter spezifizierten Benutzer mit
  536. dem authentifizierten Benutzer.
  537. </para>
  538. <example id="zend.service.twitter.friendship.create">
  539. <title>Erstellung eines Freundes</title>
  540. <programlisting language="php"><![CDATA[
  541. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  542. $response = $twitter->friendship->create('mynewfriend');
  543. ]]></programlisting>
  544. </example>
  545. </listitem>
  546. <listitem>
  547. <para>
  548. <code>destroy</code>, beendet die Freundschaft des im ID Parameter
  549. spezifizierten Benutzers, mit dem authentifizierten Benutzer.
  550. </para>
  551. <example id="zend.service.twitter.friendship.destroy">
  552. <title>Löschen eines Freundes</title>
  553. <programlisting language="php"><![CDATA[
  554. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  555. $response = $twitter->friendship->destroy('myoldfriend');
  556. ]]></programlisting>
  557. </example>
  558. </listitem>
  559. <listitem>
  560. <para>
  561. <code>exists</code>, tested ob eine Freundschaft zwischen dem authentifizierten
  562. Benutzer und dem übergebenen Benutzer existiert.
  563. </para>
  564. <example id="zend.service.twitter.friendship.exists">
  565. <title>Prüfen ob eine Freundschaft existiert</title>
  566. <programlisting language="php"><![CDATA[
  567. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  568. $response = $twitter->friendship->exists('myfriend');
  569. ]]></programlisting>
  570. </example>
  571. </listitem>
  572. </itemizedlist>
  573. </sect2>
  574. <sect2 id="zend.service.twitter.favorite">
  575. <title>Methoden für Favoriten</title>
  576. <itemizedlist>
  577. <listitem>
  578. <para>
  579. <code>favorites</code>, gibt die 20 letzten Stati von Favoriten für den
  580. authentifizierten oder durch den ID Parameter spezifizierten Benutzer zurück.
  581. </para>
  582. <example id="zend.service.twitter.favorite.favorites">
  583. <title>Favoriten empfangen</title>
  584. <programlisting language="php"><![CDATA[
  585. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  586. $response = $twitter->favorite->favorites();
  587. ]]></programlisting>
  588. </example>
  589. <itemizedlist>
  590. <listitem>
  591. <para>
  592. <code>id</code>, die ID oder der Bildschirmname des Benutzers von dem
  593. die Liste der bevorzugten Stati zurückgegeben werden soll.
  594. </para>
  595. </listitem>
  596. <listitem>
  597. <para>
  598. <code>page</code>, welche Seite soll zurückgegeben werden.
  599. </para>
  600. </listitem>
  601. </itemizedlist>
  602. </listitem>
  603. <listitem>
  604. <para>
  605. <code>create</code>, favorisiert den mit dem ID Parameter spezifizierten Status
  606. für den authentifizierten Benutzer
  607. </para>
  608. <example id="zend.service.twitter.favorite.create">
  609. <title>Favoriten erstellen</title>
  610. <programlisting language="php"><![CDATA[
  611. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  612. $response = $twitter->favorite->create(12351);
  613. ]]></programlisting>
  614. </example>
  615. </listitem>
  616. <listitem>
  617. <para>
  618. <code>destroy</code>, entfernt die Favorisierung des des mit dem ID Parameter
  619. spezifizierten Status für den authentifizierten Benutzer.
  620. </para>
  621. <example id="zend.service.twitter.favorite.destroy">
  622. <title>Entfernt Favoriten</title>
  623. <programlisting language="php"><![CDATA[
  624. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  625. $response = $twitter->favorite->destroy(12351);
  626. ]]></programlisting>
  627. </example>
  628. </listitem>
  629. </itemizedlist>
  630. </sect2>
  631. <sect2 id="zend.service.twitter.block">
  632. <title>Blockierende Methoden</title>
  633. <itemizedlist>
  634. <listitem>
  635. <para>
  636. <code>exists</code>, retourniert ob der authentifizierende Benutzer einen
  637. Zielbenutzer blockiert. Gibt das Objekt des blockierten Benutzers zurück wenn
  638. ein Block existiert.
  639. </para>
  640. <example id="zend.service.twitter.block.exists">
  641. <title>Prüfen ob ein Block existiert</title>
  642. <programlisting language="php"><![CDATA[
  643. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  644. $response = $twitter->block->exists('blockeduser');
  645. // gibt true oder false zurück
  646. $response2 = $twitter->block->exists('blockeduser', true);
  647. // gibt die Info des blockierten Benutzers zurück wenn dieser blockiert ist
  648. ]]></programlisting>
  649. </example>
  650. <itemizedlist>
  651. <listitem>
  652. <para>
  653. <code>id</code>, die ID oder der Screen Name des Benutzers für den
  654. eine Blockierung existiert.
  655. </para>
  656. </listitem>
  657. <listitem>
  658. <para>
  659. <code>returnResult</code>, Boolean welches angibt ob das Objekt des
  660. Benutzers zurückgegeben werden soll, statt einfach nur true oder false.
  661. </para>
  662. </listitem>
  663. </itemizedlist>
  664. </listitem>
  665. <listitem>
  666. <para>
  667. <code>create</code>, blockiert den Benutzer der im ID Parameter als
  668. authentifizierter Benutzer spezifiziert wurde. Löscht eine Freundschaft zum
  669. blockierten Benutzer wenn diese existiert. Gibt den blockierten Benutzer im
  670. angeforderten Format zurück wenn es erfolgreich war
  671. </para>
  672. <example id="zend.service.twitter.block.create">
  673. <title>Einen Benutzer blockieren</title>
  674. <programlisting language="php"><![CDATA[
  675. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  676. $response = $twitter->block->create('usertoblock);
  677. ]]></programlisting>
  678. </example>
  679. <itemizedlist>
  680. <listitem>
  681. <para>
  682. <code>id</code>, Die ID oder der Screen Name des Benutzers der blockiert
  683. werden soll.
  684. </para>
  685. </listitem>
  686. </itemizedlist>
  687. </listitem>
  688. <listitem>
  689. <para>
  690. <code>destroy</code>, Entfernt die Blockierung des Benutzers der im ID Parameter
  691. für den authentifizierten Benutzer spezifiziert wurde. Gibt den un-blockierten
  692. Benutzer im angeforderten Format zurück wenn diese erfolgreich war.
  693. </para>
  694. <example id="zend.service.twitter.block.destroy">
  695. <title>Entfernung einer Blockierung</title>
  696. <programlisting language="php"><![CDATA[
  697. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  698. $response = $twitter->block->destroy('blockeduser');
  699. ]]></programlisting>
  700. </example>
  701. <itemizedlist>
  702. <listitem>
  703. <para>
  704. <code>id</code>, Die ID oder der Screen Name des Benutzers für den eine
  705. Blockierung existieren kann.
  706. </para>
  707. </listitem>
  708. </itemizedlist>
  709. </listitem>
  710. <listitem>
  711. <para>
  712. <code>blocking</code>, gibt ein Array von Benutzerobjekten zurück die der
  713. authentifizierte Benutzer blockiert.
  714. </para>
  715. <example id="zend.service.twitter.block.blocking">
  716. <title>Wen blockiert man</title>
  717. <programlisting language="php"><![CDATA[
  718. $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
  719. $response = $twitter->block->blocking(1);
  720. // gibt die komplette Benutzerliste zurück
  721. $response2 = $twitter->block->blocking(1, true);
  722. // gibt ein Array von nummerischen Benutzer IDs zurück
  723. ]]></programlisting>
  724. </example>
  725. <itemizedlist>
  726. <listitem>
  727. <para>
  728. <code>page</code>, Optional. Spezifiziert die Seitenzahl der
  729. Ergebnisse beginnend mit 1. Eine einzelne Seite enthält 20 Id's.
  730. </para>
  731. </listitem>
  732. <listitem>
  733. <para>
  734. <code>returnUserIds</code>, wenn es true ist gibt eine Blockierung ein
  735. Array von nummerischen Benutzer Id's zurück die der authentifizierte
  736. Benutzer blockiert.
  737. </para>
  738. </listitem>
  739. </itemizedlist>
  740. </listitem>
  741. </itemizedlist>
  742. </sect2>
  743. <xi:include href="Zend_Service_Twitter_Search.xml" />
  744. </sect1>
  745. <!--
  746. vim:se ts=4 sw=4 et:
  747. -->