# Zend_Service_Twitter

## Einführung

`Zend_Service_Twitter` bietet einen Client für die REST API von Twitter. `Zend_Service_Twitter` erlaubt es eine öffentliche Zeitachse abzufragen. Wenn man einen Benutzernamen und ein Passwort für Twitter angibt, ist es auch erlaubt den eigenen Status zu erhalten und zu aktualisieren, Freunden zu antworten, Nachrichten an Freunde schicken, Tweets als Favoriten markieren und vieles mehr.

`Zend_Service_Twitter` implementiert einen REST Service und alle Methoden geben eine Instanz von `Zend_Rest_Client_Result` zurück.

`Zend_Service_Twitter` ist in Untersektionen geteilt damit man einfachst erkennen kann welcher Typ von Aufrufen angefragt wird.

- `account` stellt sicher das die eigenen Zugangsdaten gültig sind, prüft das API Limit und beendet die aktuelle Session für den authentifizierten Benutzer.

- `status` empfängt die öffentlichen und die Zeitlinien von Benutzern, und zeigt den authentifizierten Benutzer an, aktualsiert Ihn, zerstört Ihn und empfängt Antworten.

- `user` empfängt Freunde und Verfolger des authentifizierten Benutzers und gibt erweiterte Informationen über den angegebenen Benutzer zurück.

- `directMessage` empfängt die direkten Nachrichten des authentifizierten Benutzers, löscht direkte Nachrichten und sendet neue direkte Nachrichten.

- `friendship` erstellt und entfernt Freundschaften für den authentifizierten Benutzer.

- `favorite` zeigt, erstellt und entfernt favorisierte Tweets.

- `block` blockiert und entfernt die Blockierung von Benutzern welche einem folgen.

## Authentifizierung

Mit der Ausnahme des Holens der öffentlichen Zeitlinie benötigt `Zend_Service_Twitter` eine Authentifizierung um zu funktionieren. Twitter verwendet aktuell eine HTTP Basis Authentifizierung. Man kann den eigenen Benutzernamen oder eine registrierte Email mit dem Passwort, für das Login bei Twitter, übergeben.

### Erstellung der Twitter Klasse

Das folgende Codebeispiel zeigt wie man den Twitter Service erstellt, den Benutzernamen und das Passwort übergibt, und überprüft ob Sie korrekt sind.

    $twitter = new Zend_Service_Twitter('myusername', 'mysecretpassword');
    // Prüft die Angaben mit Twitter
    $response = $twitter->account->verifyCredentials();

Man kann auch ein Array das den Benutzernamen und das Passwort enthält, als ersten Parameter übergeben.

                            $userInfo = array('username' => 'foo', 'password' => 'bar');
    $twitter = new Zend_Service_Twitter($userInfo);
    // Überprüft die Zugangsdaten bei Twitter
    $response = $twitter->account->verifyCredentials();

## Account Methoden

- `verifyCredentials()` testet ob die angegebenen Benutzerdaten gültig sind, und das mit einem minimalen Overhead.

  ### Die Angaben prüfen

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->account->verifyCredentials();

- `endSession()` meldet Benutzer aus der Clientanwendung ab.

  ### Beenden von Sessions

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->account->endSession();

- `rateLimitStatus()` gibt die restliche Anzahl von API Anfragen zurück die der authentifizierte Benutzer noch hat, bevor das API Limit für die aktuelle Stunde erreicht ist.

  ### Status des Rating Limits

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->account->rateLimitStatus();

## Status Methoden

- `publicTimeline()` gibt die 20 letzten Statusmeldungen von nicht geschützten Benutzern mit einem eigenen Benutzericon zurück. Die öffentliche Zeitlinie wird von Twitter alle 60 Sekunden gecacht.

  ### Empfangen der öffentlichen Zeitlinie

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->status->publicTimeline();

- `friendsTimeline()` gibt die 20 letzten Statusmeldungen zurück die von authentifizierten Benutzer und deren Freunde gesendet wurden.

  ### Empfangen der Zeitlinie von Freunden

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->status->friendsTimeline();

  Die `friendsTimeline()` Methode akzeptiert ein Array von optionalen Parameters um die Abfrage zu verändern.

  - `since` grenzt die zurückgegeben Ergebnisse auf jene Statusmeldungen ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden alt) erstellt wurden.

  - `page` spezifiziert die Seite die man zurückbekommen will.

- `userTimeline()` gibt die 20 letzten Statusmeldungen zurück die von authentifizierten Benutzern geschrieben wurden.

  ### Empfangen der Zeitlinie von Benutzern

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->status->userTimeline();

  Die `userTimeline()` Methode akzeptiert ein Array von optionalen Parametern um die Abfrage zu verändern.

  - `id` spezifiziert die ID oder den Bildschirmnamen des Benutzers für den die friends_timeline zurückzugeben ist.

  - `since` grenzt die zurückzugebenden Ergebnisse auf jene Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als) erstellt wurden.

  - `page` spezifiziert welche Seite zurückgegeben werden soll.

  - `count` spezifiziert die Anzahl der Stati die man erhalten will. Kann nicht größer als 200 sein.

- `show()` gibt einen einzelnen Status zurück, der durch den ID Parameter, wie anbei, spezifiziert wird. Der Author des Status wird auch zurückgegeben.

  ### Den Status eines Benutzers sehen

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->status->show(1234);

- `update()` aktualisiert den Status des authentifizierten Benutzers. Diese Methode erwartet das der aktualisierte Status übergeben wird den man an Twitter übermitteln will.

  ### Aktualisieren des Benutzerstatus

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->status->update('Mein größter Tweet');

  Die `update()` Methode akzeptiert einen zweiten optionalen Parameter.

  - `in_reply_to_status_id` spezifiziert die ID eines bestehenden Status auf den dieser Status als Antwort gesendet werden soll.

- `replies()` gibt die 20 letzten Antworten/@replies (Statusaktualisierungen die mit @username anfangen) für den authentifizierten Benutzer zurück.

  ### Zeigt Benutzerantworten

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->status->replies();

  Die `replies()` Methode akzeptiert ein Array von optionalen Parametern um die Anfrage zu verändern.

  - `since` grenzt die Ergebnisse die man erhält auf jene ein, deren Stati nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden alt) erstellt wurden.

  - `page` spezifiziert welche Seite soll zurückgegeben werden.

  - `since_id` gibt nur Stati zurück die eine größere ID (das ist die aktuellere) als die spezifizierte ID haben.

- `destroy()` entfernt den Status der durch den benötigten `id` Parameter spezifiziert ist.

  ### Löschen eines Benutzerstatus

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->status->destroy(12345);

## Benutzermethoden

- `friends()` gibt bis zu 100 Freunde des authentifizierten Benutzers zurück, die zuletzt aktualisiert haben, und jeden von Ihnen mit dem aktuellen Status.

  ### Empfangen von Benutzerfreunden

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->user->friends();

  Die `friends()` Methode akzeptiert ein Array von optionalen Parameter um die Abfrage zu verändern.

  - `id` spezifiziert die ID oder den Bildschirmnamen des Benutzers von dem die Liste an Freunden zurückgegeben werden soll.

  - `since` grenzt die zurückzugebenden Ergebnisse auf jene Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als) erstellt wurden.

  - `page` spezifiziert welche Seite soll zurückgegeben werden.

- `followers()` gibt die Verfolger des authentifizierten Benutzers zurück, und jeden von Ihnen mit seinem aktuellen Status.

  ### Empfangen der Verfolger eines Benutzers

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->user->followers();

  Die `followers()` Methode akzeptiert ein Array von optionalen Parametern welche die Anfrage verändern.

  - `id` spezifiziert die ID oder den Bildschirmnamen des Benutzers von dem die Liste an Verfolgern zurückgegeben werden soll.

  - `page` spezifiziert welche Seite soll zurückgegeben werden.

- `show()` gibt erweiterte Informationen über einen angegebenen Benutzer zurück, der durch eine ID oder einen Bildschirmnamen spezifiziert wird wie durch den anbei benötigten `id` Parameter.

  ### Zeigt Benutzerinformationen

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->user->show('myfriend');

## Methoden zur direkten Benachrichtigung

- `messages()` gibt eine Liste der 20 letzten direkten Nachrichten für den authentifizierten Benutzer zurück.

  ### Empfangen der letzten empfangenen direkten Nachrichten

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->directMessage->messages();

  Die `message()` Methode akzeptiert ein Array von optionalen Parametern um die Anfrage zu verändern.

  - `since_id` gibt nur direkte Nachrichten mit einer ID zurück, die größer als (das ist aktueller als) die spezifizierte ID sind.

  - `since` grenzt die zurückzugebenden Ergebnisse auf jene Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als) erstellt wurden.

  - `page` spezifiziert welche Seite soll zurückgegeben werden.

- `sent()` gibt eine Liste der 20 letzten direkten Nachrichten zurück die vom authentifizierten Benutzer gesendet wurden.

  ### Empfangen der letzten gesendeten direkten Nachrichten

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->directMessage->sent();

  Die `sent()` Methode akzeptiert ein Array von optionalen Parametern um die Abfrage zu verändern.

  - `since_id` gibt nur direkte Nachrichten mit einer ID zurück, die größer als (das ist aktueller als) die spezifizierte ID sind.

  - `since` grenzt die zurückzugebenden Ergebnisse auf jene Stati ein die nach dem spezifizierten Datum/Zeit (bis zu 24 Stunden als) erstellt wurden.

  - `page` spezifiziert welche Seite soll zurückgegeben werden.

- `new()` sendet eine neue direkte Nachricht vom authentifizierten Benutzer zum spezifizierten Benutzer. Benötigt sowohl den Benutzer also auch den Text Parameter wie unten gezeigt.

  ### Senden einer direkten Nachricht

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->directMessage->new('myfriend', 'mymessage');

- `destroy()` entfernt eine direkte Nachricht die im benötigten `id` Parameter spezifiziert wird. Der authentifizierte Benutzer muß der Empfänger der spezifizierten direkten Nachricht sein.

  ### Löschen einer direkten Nachricht

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->directMessage->destroy(123548);

## Methoden für die Freundschaft

- `create()` befreundet den im `id` Parameter spezifizierten Benutzer mit dem authentifizierten Benutzer.

  ### Erstellung eines Freundes

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->friendship->create('mynewfriend');

- `destroy()` beendet die Freundschaft des im `id` Parameter spezifizierten Benutzers, mit dem authentifizierten Benutzer.

  ### Löschen eines Freundes

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->friendship->destroy('myoldfriend');

- `exists()` testet ob eine Freundschaft zwischen dem authentifizierten Benutzer und dem im `id` Parameter übergebenen Benutzer existiert.

  ### Prüfen ob eine Freundschaft existiert

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->friendship->exists('myfriend');

## Methoden für Favoriten

- `favorites()` gibt die 20 letzten Stati von Favoriten für den authentifizierten oder durch den `id` Parameter spezifizierten Benutzer zurück.

  ### Favoriten empfangen

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->favorite->favorites();

  Die `favorites()` Methode akzeptiert ein Array von optionalen Parametern um die Abfrage zu modifizieren.

  - `id` spezifiziert die ID oder der Bildschirmname des Benutzers von dem die Liste der bevorzugten Stati zurückgegeben werden soll.

  - `page` spezifiziert welche Seite soll zurückgegeben werden.

- `create()` favorisiert den mit dem `id` Parameter spezifizierten Status für den authentifizierten Benutzer

  ### Favoriten erstellen

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->favorite->create(12351);

- `destroy()` entfernt die Favorisierung des des mit dem `id` Parameter spezifizierten Status für den authentifizierten Benutzer.

  ### Entfernt Favoriten

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->favorite->destroy(12351);

## Blockierende Methoden

- `exists()` retourniert ob der authentifizierende Benutzer einen Zielbenutzer blockiert und kann optional das Objekt des blockierten Benutzers zurückgeben wenn ein Block existiert.

  ### Prüfen ob ein Block existiert

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');

      // gibt true oder false zurück
      $response = $twitter->block->exists('blockeduser');

      // gibt die Info des blockierten Benutzers zurück wenn dieser blockiert ist
      $response2 = $twitter->block->exists('blockeduser', true);

  Die `favorites()` Methode akzeptiert einen optionalen zweiten Parameter.

  - `returnResult` spezifiziert ob das Objekt des Benutzers zurückgegeben werden soll, oder einfach nur `TRUE` oder `FALSE`.

- `create()` blockiert den Benutzer der im `id` Parameter als authentifizierter Benutzer spezifiziert wurde und löscht eine Freundschaft zum blockierten Benutzer wenn eine existiert. Gibt den blockierten Benutzer im angeforderten Format zurück wenn es erfolgreich war

  ### Einen Benutzer blockieren

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->block->create('usertoblock);

- `destroy()` entfernt die Blockierung des Benutzers der im `id` Parameter für den authentifizierten Benutzer spezifiziert wurde. Gibt den un-blockierten Benutzer im angeforderten Format zurück wenn diese erfolgreich war.

  ### Entfernung einer Blockierung

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');
      $response = $twitter->block->destroy('blockeduser');

- `blocking()` gibt ein Array von Benutzerobjekten zurück die der authentifizierte Benutzer blockiert.

  ### Wen blockiert man

      $twitter  = new Zend_Service_Twitter('myusername', 'mysecretpassword');

      // gibt die komplette Benutzerliste zurück
      $response = $twitter->block->blocking(1);

      // gibt ein Array von nummerischen Benutzer IDs zurück
      $response2 = $twitter->block->blocking(1, true);

  Die `favorites()` Methode akzeptiert zwei optionale Parameter.

  - `page` spezifiziert die man zurück erhalten will. Eine einzelne Seite enthält 20 Id's.

  - `returnUserIds` spezifiziert ob ein Array von nummerischen Benutzer Id's zurückzugeben ist welche der authenzifizierte Benutzer blockiert, oder ein Array von Benutzerobjekten.